Package org.bson
Class BSON
-
- org.bson.BSON
-
- Direct Known Subclasses:
Bytes
public class BSON extends
Deprecated.there is no replacement for this classContains byte representations of all the BSON types (see the ). Also supports the registration of encoding and decoding hooks to transform BSON types during encoding or decoding.- See Also:
Transformer
-
-
Field Summary
Fields Modifier and Type Field Description static byte
ARRAY
Deprecated.static byte
B_BINARY
Deprecated.static byte
B_FUNC
Deprecated.static byte
B_GENERAL
Deprecated.static byte
B_UUID
Deprecated.static byte
BINARY
Deprecated.static byte
BOOLEAN
Deprecated.static byte
CODE
Deprecated.static byte
CODE_W_SCOPE
Deprecated.static byte
DATE
Deprecated.static byte
EOO
Deprecated.static byte
MAXKEY
Deprecated.static byte
MINKEY
Deprecated.static byte
NULL
Deprecated.static byte
NUMBER
Deprecated.static byte
NUMBER_INT
Deprecated.static byte
NUMBER_LONG
Deprecated.static byte
OBJECT
Deprecated.static byte
OID
Deprecated.static byte
REF
Deprecated.static byte
REGEX
Deprecated.static byte
STRING
Deprecated.static byte
SYMBOL
Deprecated.static byte
TIMESTAMP
Deprecated.static byte
UNDEFINED
Deprecated.
-
Constructor Summary
Constructors Constructor Description BSON()
Deprecated.
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static void
<?> clazz, Transformer transformer)
Deprecated.Registers aTransformer
to use when decoding a specific class from BSON.static void
<?> clazz, Transformer transformer)
Deprecated.Registers aTransformer
to use to encode a specific class into BSON.static
objectToDecode)
Deprecated.Transforms theobjectToDecode
using all transformers registered for the class of this object.static
objectToEncode)
Deprecated.Transforms theobjectToEncode
using all transformers registered for the class of this object.static void
clearAllHooks()
Deprecated.Remove all decoding and encoding hooks for all classes.static void
clearDecodingHooks()
Deprecated.Clears all decoding hooks.static void
clearEncodingHooks()
Deprecated.Clears all encoding hooks.static BSONObject
decode(byte[] bytes)
Deprecated.Decodes a BSON byte array into a DBObject instance.static byte[]
encode(BSONObject doc)
Deprecated.Encodes a DBObject as a BSON byte array.static <Transformer>
<?> clazz)
Deprecated.Returns the decoding hook(s) associated with the specific classstatic <Transformer>
<?> clazz)
Deprecated.Returns the encoding hook(s) associated with the specified class.static boolean
hasDecodeHooks()
Deprecated.Gets whether any decoding transformers have been registered for any classes.static boolean
hasEncodeHooks()
Deprecated.Gets whether any encoding transformers have been registered for any classes.static int
regexFlag(char c)
Deprecated.Converts a regular expression modifier from the database into Java regular expression flags.static
regexFlags(int flags)
Deprecated.Converts Java regular expression flags into regular expression modifiers from the database.static int
s)
Deprecated.Converts a sequence of regular expression modifiers from the database into Java regular expression flags.static void
<?> clazz, Transformer transformer)
Deprecated.Remove a specific encoding hook for a specific class.static void
<?> clazz)
Deprecated.Remove all decoding hooks for a specific class.static void
<?> clazz, Transformer transformer)
Deprecated.Remove a specific encoding hook for a specific class.static void
<?> clazz)
Deprecated.Remove all encoding hooks for a specific class.static int
number)
Deprecated.Provides an integer representation of Boolean or Number.
-
-
-
Field Detail
-
EOO
public static final byte EOO
Deprecated.- See Also:
- Constant Field Values
-
NUMBER
public static final byte NUMBER
Deprecated.- See Also:
- Constant Field Values
-
STRING
public static final byte STRING
Deprecated.- See Also:
- Constant Field Values
-
OBJECT
public static final byte OBJECT
Deprecated.- See Also:
- Constant Field Values
-
ARRAY
public static final byte ARRAY
Deprecated.- See Also:
- Constant Field Values
-
BINARY
public static final byte BINARY
Deprecated.- See Also:
- Constant Field Values
-
UNDEFINED
public static final byte UNDEFINED
Deprecated.- See Also:
- Constant Field Values
-
OID
public static final byte OID
Deprecated.- See Also:
- Constant Field Values
-
BOOLEAN
public static final byte BOOLEAN
Deprecated.- See Also:
- Constant Field Values
-
DATE
public static final byte DATE
Deprecated.- See Also:
- Constant Field Values
-
NULL
public static final byte NULL
Deprecated.- See Also:
- Constant Field Values
-
REGEX
public static final byte REGEX
Deprecated.- See Also:
- Constant Field Values
-
REF
public static final byte REF
Deprecated.- See Also:
- Constant Field Values
-
CODE
public static final byte CODE
Deprecated.- See Also:
- Constant Field Values
-
SYMBOL
public static final byte SYMBOL
Deprecated.- See Also:
- Constant Field Values
-
CODE_W_SCOPE
public static final byte CODE_W_SCOPE
Deprecated.- See Also:
- Constant Field Values
-
NUMBER_INT
public static final byte NUMBER_INT
Deprecated.- See Also:
- Constant Field Values
-
TIMESTAMP
public static final byte TIMESTAMP
Deprecated.- See Also:
- Constant Field Values
-
NUMBER_LONG
public static final byte NUMBER_LONG
Deprecated.- See Also:
- Constant Field Values
-
MINKEY
public static final byte MINKEY
Deprecated.- See Also:
- Constant Field Values
-
MAXKEY
public static final byte MAXKEY
Deprecated.- See Also:
- Constant Field Values
-
B_GENERAL
public static final byte B_GENERAL
Deprecated.- See Also:
- Constant Field Values
-
B_FUNC
public static final byte B_FUNC
Deprecated.- See Also:
- Constant Field Values
-
B_BINARY
public static final byte B_BINARY
Deprecated.- See Also:
- Constant Field Values
-
B_UUID
public static final byte B_UUID
Deprecated.- See Also:
- Constant Field Values
-
-
Method Detail
-
hasEncodeHooks
public static boolean hasEncodeHooks()
Deprecated.Gets whether any encoding transformers have been registered for any classes.- Returns:
- true if any encoding hooks have been registered.
-
hasDecodeHooks
public static boolean hasDecodeHooks()
Deprecated.Gets whether any decoding transformers have been registered for any classes.- Returns:
- true if any decoding hooks have been registered.
-
addEncodingHook
public static void addEncodingHook(<?> clazz, Transformer transformer)
Deprecated.Registers aTransformer
to use to encode a specific class into BSON.- Parameters:
clazz
- the class to be transformed during encodingtransformer
- the transformer to use during encoding
-
addDecodingHook
public static void addDecodingHook(<?> clazz, Transformer transformer)
Deprecated.Registers aTransformer
to use when decoding a specific class from BSON. This class will be one of the basic types supported by BSON.- Parameters:
clazz
- the class to be transformed during decodingtransformer
- the transformer to use during decoding
-
applyEncodingHooks
public static applyEncodingHooks( objectToEncode)
Deprecated.Transforms theobjectToEncode
using all transformers registered for the class of this object.- Parameters:
objectToEncode
- the object being written to BSON.- Returns:
- the transformed object
-
applyDecodingHooks
public static applyDecodingHooks( objectToDecode)
Deprecated.Transforms theobjectToDecode
using all transformers registered for the class of this object.- Parameters:
objectToDecode
- the BSON object to decode- Returns:
- the transformed object
-
getEncodingHooks
public static <<?> clazz)
Deprecated.Returns the encoding hook(s) associated with the specified class.- Parameters:
clazz
- the class to fetch the encoding hooks for- Returns:
- a List of encoding transformers that apply to the given class
-
clearEncodingHooks
public static void clearEncodingHooks()
Deprecated.Clears all encoding hooks.
-
removeEncodingHooks
public static void removeEncodingHooks(<?> clazz)
Deprecated.Remove all encoding hooks for a specific class.- Parameters:
clazz
- the class to remove all the decoding hooks for
-
removeEncodingHook
public static void removeEncodingHook(<?> clazz, Transformer transformer)
Deprecated.Remove a specific encoding hook for a specific class. Thetransformer
passed as the parameter must beequals
to the transformer to remove.- Parameters:
clazz
- the class to remove the encoding hook fortransformer
- the specific encoding hook to remove.
-
getDecodingHooks
public static <<?> clazz)
Deprecated.Returns the decoding hook(s) associated with the specific class- Parameters:
clazz
- the class to fetch the decoding hooks for- Returns:
- a List of all the decoding Transformers that apply to the given class
-
clearDecodingHooks
public static void clearDecodingHooks()
Deprecated.Clears all decoding hooks.
-
removeDecodingHooks
public static void removeDecodingHooks(<?> clazz)
Deprecated.Remove all decoding hooks for a specific class.- Parameters:
clazz
- the class to remove all the decoding hooks for
-
removeDecodingHook
public static void removeDecodingHook(<?> clazz, Transformer transformer)
Deprecated.Remove a specific encoding hook for a specific class. Thetransformer
passed as the parameter must beequals
to the transformer to remove.- Parameters:
clazz
- the class to remove the decoding hook fortransformer
- the specific decoding hook to remove.
-
clearAllHooks
public static void clearAllHooks()
Deprecated.Remove all decoding and encoding hooks for all classes.
-
encode
public static byte[] encode(BSONObject doc)
Deprecated.Encodes a DBObject as a BSON byte array.- Parameters:
doc
- the document to encode- Returns:
- the document encoded as BSON
-
decode
public static BSONObject decode(byte[] bytes)
Deprecated.Decodes a BSON byte array into a DBObject instance.- Parameters:
bytes
- a document encoded as BSON- Returns:
- the document as a DBObject
-
regexFlags
public static int regexFlags( s)
Deprecated.Converts a sequence of regular expression modifiers from the database into Java regular expression flags.- Parameters:
s
- regular expression modifiers- Returns:
- the Java flags
- Throws:
- If sequence contains invalid flags.
-
regexFlag
public static int regexFlag(char c)
Deprecated.Converts a regular expression modifier from the database into Java regular expression flags.- Parameters:
c
- regular expression modifier- Returns:
- the Java flags
- Throws:
- If sequence contains invalid flags.
-
regexFlags
public static regexFlags(int flags)
Deprecated.Converts Java regular expression flags into regular expression modifiers from the database.- Parameters:
flags
- the Java flags- Returns:
- the Java flags
- Throws:
- if some flags couldn't be recognized.
-
toInt
public static int toInt( number)
Deprecated.Provides an integer representation of Boolean or Number. If argument is , then1
fortrue
will be returned or @{code 0} otherwise. If argument isNumber
, then will be called.- Parameters:
number
- the number to convert to an int- Returns:
- integer value
- Throws:
- if the argument is
null
or not or
-
-