Package org.bson

Class BasicBSONDecoder

java.lang.Object

org.bson.BasicBSONDecoder

All Implemented Interfaces:

BSONDecoder

public class BasicBSONDecoder
extends Object
implements BSONDecoder

Basic implementation of BSONDecoder interface that creates BasicBSONObject instances

Constructor Summary

Constructors

Constructor	Description
BasicBSONDecoder()

Method Summary

Modifier and Type	Method	Description
int	decode(byte[] bytes, BSONCallback callback)	Decode a single BSON object into the given callback from the given byte array.
int	decode(InputStream in, BSONCallback callback)	Decode a single BSON object into the given callback from the given input stream.
static UuidRepresentation	getDefaultUuidRepresentation()	Gets the default UuidRepresentation to use when decoding BSON binary values.
BSONObject	readObject(byte[] bytes)	Read a single BSON object from the given bytes.
BSONObject	readObject(InputStream in)	Read a single BSON object from the given input stream.
static void	setDefaultUuidRepresentation(UuidRepresentation uuidRepresentation)	Sets the global (JVM-wide) UuidRepresentation to use when decoding BSON binary values with subtypes of either BsonBinarySubType.UUID_STANDARD or BsonBinarySubType.UUID_LEGACY.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicBSONDecoder

public BasicBSONDecoder()

Method Details

setDefaultUuidRepresentation

public static void setDefaultUuidRepresentation(UuidRepresentation uuidRepresentation)

Sets the global (JVM-wide) UuidRepresentation to use when decoding BSON binary values with subtypes of either BsonBinarySubType.UUID_STANDARD or BsonBinarySubType.UUID_LEGACY.

If the BsonBinarySubType of the value to be decoded matches the binary subtype of the UuidRepresentation, then the value will be decoded to an instance of UUID, according to the semantics of the UuidRepresentation. Otherwise, it will be decoded to an instance of Binary.

Defaults to UuidRepresentation.JAVA_LEGACY. If set to UuidRepresentation.UNSPECIFIED, attempting to decode any UUID will throw a BSONException.

Parameters:

uuidRepresentation - the uuid representation, which may not be null

Since:

4.7

See Also:

• BSONCallback.gotUUID(String, long, long)
• BasicBSONEncoder.setDefaultUuidRepresentation(UuidRepresentation)

getDefaultUuidRepresentation

public static UuidRepresentation getDefaultUuidRepresentation()

Gets the default UuidRepresentation to use when decoding BSON binary values.

If unset, the default is UuidRepresentation.JAVA_LEGACY.

Returns:

the uuid representation, which may not be null

Since:

4.7

See Also:

• BSONCallback.gotUUID(String, long, long)
• BasicBSONEncoder.setDefaultUuidRepresentation(UuidRepresentation)

readObject

public BSONObject readObject(byte[] bytes)

Description copied from interface: BSONDecoder

Read a single BSON object from the given bytes.

Specified by:

readObject in interface BSONDecoder

Parameters:

bytes - the bytes in BSON format

Returns:

the BSON object for the given bytes

readObject

public BSONObject readObject(InputStream in)
                      throws IOException

Description copied from interface: BSONDecoder

Read a single BSON object from the given input stream.

Specified by:

readObject in interface BSONDecoder

Parameters:

in - the input stream in BSON format

Returns:

the BSON object for the given bytes

Throws:

IOException - if there's a problem reading the object from the InputStream

decode

public int decode(byte[] bytes,
 BSONCallback callback)

Description copied from interface: BSONDecoder

Decode a single BSON object into the given callback from the given byte array.

Specified by:

decode in interface BSONDecoder

Parameters:

bytes - the bytes in BSON format

callback - the callback

Returns:

the number of bytes in the BSON object

decode

public int decode(InputStream in,
 BSONCallback callback)
           throws IOException

Description copied from interface: BSONDecoder

Decode a single BSON object into the given callback from the given input stream.

Specified by:

decode in interface BSONDecoder

Parameters:

in - the input stream in BSON format

callback - the callback

Returns:

the number of bytes read from the input stream

Throws:

IOException - if there's a problem reading from the InputStream