Package org.bson

Enum Class BsonBinarySubType

java.lang.Object
java.lang.Enum<BsonBinarySubType>
org.bson.BsonBinarySubType
All Implemented Interfaces:
Serializable, Comparable<BsonBinarySubType>, java.lang.constant.Constable
public enum BsonBinarySubType extends Enum<BsonBinarySubType>
The Binary subtype
Since:
3.0

  • Enum Constant Details

    • BINARY

      public static final BsonBinarySubType BINARY
      Binary data.

    • FUNCTION

      public static final BsonBinarySubType FUNCTION
      A function.

    • OLD_BINARY

      public static final BsonBinarySubType OLD_BINARY
      Obsolete binary data subtype (use Binary instead).

    • UUID_LEGACY

      public static final BsonBinarySubType UUID_LEGACY
      A UUID in a driver dependent legacy byte order.

    • UUID_STANDARD

      public static final BsonBinarySubType UUID_STANDARD
      A UUID in standard network byte order.

    • MD5

      public static final BsonBinarySubType MD5
      An MD5 hash.

    • ENCRYPTED

      public static final BsonBinarySubType ENCRYPTED
      Encrypted data.
      Since:
      4.4

    • COLUMN

      public static final BsonBinarySubType COLUMN
      Columnar data
      Since:
      4.4

    • USER_DEFINED

      public static final BsonBinarySubType USER_DEFINED
      User defined binary data.

  • Method Details

    • values

      public static BsonBinarySubType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static BsonBinarySubType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • isUuid

      public static boolean isUuid(byte value)
      Returns true if the given value is a UUID subtype
      Parameters:
      value - the subtype value as a byte
      Returns:
      true if value is a UUID subtype
      Since:
      3.4

    • getValue

      public byte getValue()
      Gets the byte representation of this subtype.
      Returns:
      this subtype as a byte.