Package org.bson

Class 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 Detail

      • 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​(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 Detail

      • asUuid

        public UUID asUuid()
        Returns the binary as a UUID. The binary type must be 4.
        Returns:
        the uuid
        Since:
        3.9
      • asUuid

        public UUID asUuid​(UuidRepresentation uuidRepresentation)
        Returns the binary as a UUID.
        Parameters:
        uuidRepresentation - the UUID representation
        Returns:
        the uuid
        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
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object