Package org.bson

Class BsonBinary

java.lang.Object

org.bson.BsonValue

org.bson.BsonBinary

public class BsonBinary
extends BsonValue

A representation of the BSON Binary type. Note that for performance reasons instances of this class are not immutable, so care should be taken to only modify the underlying byte array if you know what you're doing, or else make a defensive copy.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
BsonBinary(byte[] data)	Construct a new instance with the given data and the default sub-type
BsonBinary(byte type, byte[] data)	Construct a new instance with the given data and binary sub type.
BsonBinary(UUID uuid)	Construct a Type 4 BsonBinary from the given UUID.
BsonBinary(UUID uuid, UuidRepresentation uuidRepresentation)	Construct a new instance from the given UUID and UuidRepresentation
BsonBinary(BinaryVector vector)	Constructs a subtype 9 BsonBinary from the given BinaryVector.
BsonBinary(BsonBinarySubType type, byte[] data)	Construct a new instance with the given data and binary sub type.

Method Summary

Modifier and Type	Method	Description
UUID	asUuid()	Returns the binary as a UUID.
UUID	asUuid(UuidRepresentation uuidRepresentation)	Returns the binary as a UUID.
BinaryVector	asVector()	Returns the binary as a BinaryVector.
boolean	equals(Object o)
BsonType	getBsonType()	Gets the BSON type of this value.
byte[]	getData()	Gets the data of this Binary.
byte	getType()	Gets the type of this Binary.
int	hashCode()
String	toString()

Methods inherited from class org.bson.BsonValue

asArray, asBinary, asBoolean, asDateTime, asDBPointer, asDecimal128, asDocument, asDouble, asInt32, asInt64, asJavaScript, asJavaScriptWithScope, asNumber, asObjectId, asRegularExpression, asString, asSymbol, asTimestamp, isArray, isBinary, isBoolean, isDateTime, isDBPointer, isDecimal128, isDocument, isDouble, isInt32, isInt64, isJavaScript, isJavaScriptWithScope, isNull, isNumber, isObjectId, isRegularExpression, isString, isSymbol, isTimestamp

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

BsonBinary

public BsonBinary(byte[] data)

Construct a new instance with the given data and the default sub-type

Parameters:

data - the data

See Also:

• BsonBinarySubType.BINARY

BsonBinary

public BsonBinary(BsonBinarySubType type,
 byte[] data)

Construct a new instance with the given data and binary sub type.

Parameters:

data - the data

type - the binary sub type

See Also:

• BsonBinarySubType.BINARY

BsonBinary

public BsonBinary(byte type,
 byte[] data)

Construct a new instance with the given data and binary sub type.

Parameters:

data - the data

type - the binary sub type

See Also:

• BsonBinarySubType.BINARY

BsonBinary

public BsonBinary(UUID uuid)

Construct a Type 4 BsonBinary from the given UUID.

Parameters:

uuid - the UUID

Since:

3.9

BsonBinary

public BsonBinary(BinaryVector vector)

Constructs a subtype 9 BsonBinary from the given BinaryVector.

Parameters:

vector - the BinaryVector

Since:

5.3

BsonBinary

public BsonBinary(UUID uuid,
 UuidRepresentation uuidRepresentation)

Construct a new instance from the given UUID and UuidRepresentation

Parameters:

uuid - the UUID

uuidRepresentation - the UUID representation

Since:

3.9

Method Details

asUuid

public UUID asUuid()

Returns the binary as a UUID.

Note:The BsonBinary subtype must be BsonBinarySubType.UUID_STANDARD.

Returns:

the uuid

Throws:

BsonInvalidOperationException - if BsonBinary subtype is not BsonBinarySubType.UUID_STANDARD

Since:

3.9

See Also:

• asUuid(UuidRepresentation)
• BsonBinarySubType

asVector

public BinaryVector asVector()

Returns the binary as a BinaryVector. The subtype must be 9.

Returns:

the vector

Throws:

BsonInvalidOperationException - if the binary subtype is not BsonBinarySubType.VECTOR.

Since:

5.3

asUuid

public UUID asUuid(UuidRepresentation uuidRepresentation)

Returns the binary as a UUID.

Note:The BsonBinary subtype must be either BsonBinarySubType.UUID_STANDARD or BsonBinarySubType.UUID_LEGACY.

Parameters:

uuidRepresentation - the UUID representation, must be UuidRepresentation.STANDARD or UuidRepresentation.JAVA_LEGACY

Returns:

the uuid

Throws:

BsonInvalidOperationException - if the BsonBinary subtype is incompatible with the given uuidRepresentation, or if the uuidRepresentation is not UuidRepresentation.STANDARD or UuidRepresentation.JAVA_LEGACY.

Since:

3.9

getBsonType

public BsonType getBsonType()

Description copied from class: BsonValue

Gets the BSON type of this value.

Specified by:

getBsonType in class BsonValue

Returns:

the BSON type, which may not be null (but may be BSONType.NULL)

getType

public byte getType()

Gets the type of this Binary.

Returns:

the type

getData

public byte[] getData()

Gets the data of this Binary.

This method returns the internal copy of the byte array, so only modify the contents of the returned array if the intention is to change the state of this instance.

Returns:

the data

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object