Package org.bson

Enum Class UuidRepresentation

java.lang.Object
java.lang.Enum<UuidRepresentation>
org.bson.UuidRepresentation
All Implemented Interfaces:
Serializable, Comparable<UuidRepresentation>, java.lang.constant.Constable

public enum UuidRepresentation extends Enum<UuidRepresentation>
The representation to use when converting a UUID to a BSON binary value. This class is necessary because the different drivers used to have different ways of encoding UUID, with the BSON subtype: \x03 UUID old.
Since:
3.0
  • Enum Constant Details

    • UNSPECIFIED

      public static final UuidRepresentation UNSPECIFIED
      An unspecified representation of UUID. Essentially, this is the null representation value.
      Since:
      3.12
    • STANDARD

      public static final UuidRepresentation STANDARD
      The canonical representation of UUID

      BSON binary subtype 4

    • C_SHARP_LEGACY

      public static final UuidRepresentation C_SHARP_LEGACY
      The legacy representation of UUID used by the C# driver

      BSON binary subtype 3

    • JAVA_LEGACY

      public static final UuidRepresentation JAVA_LEGACY
      The legacy representation of UUID used by the Java driver

      BSON binary subtype 3

    • PYTHON_LEGACY

      public static final UuidRepresentation PYTHON_LEGACY
      The legacy representation of UUID used by the Python driver, which is the same format as STANDARD, but has the UUID old BSON subtype (\x03)

      BSON binary subtype 3

  • Method Details

    • values

      public static UuidRepresentation[] 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 UuidRepresentation 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
    • getSubtype

      public BsonBinarySubType getSubtype()
      Gets the BSON binary subtype for the representation.
      Returns:
      the BSON binary subtype for the representation
      Throws:
      BSONException - if this is UNSPECIFIED
      Since:
      4.7