Package org.bson

Enum BsonBinarySubType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<BsonBinarySubType>
    public enum BsonBinarySubType
extends java.lang.Enum<BsonBinarySubType>
    The Binary subtype
    Since:
    3.0

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BINARY
      Binary data.
      FUNCTION
      A function.
      MD5
      An MD5 hash.
      OLD_BINARY
      Obsolete binary data subtype (use Binary instead).
      USER_DEFINED
      User defined binary data.
      UUID_LEGACY
      A UUID in a driver dependent legacy byte order.
      UUID_STANDARD
      A UUID in standard network byte order.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      byte getValue()
      Gets the byte representation of this subtype.
      static boolean isUuid​(byte value)
      Returns true if the given value is a UUID subtype
      static BsonBinarySubType valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static BsonBinarySubType[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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.

      • USER_DEFINED

        public static final BsonBinarySubType USER_DEFINED
        User defined binary data.

    • Method Detail

      • values

        public static BsonBinarySubType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (BsonBinarySubType c : BsonBinarySubType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static BsonBinarySubType valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.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.