Package org.bson

Enum BsonBinarySubType

java.lang.Object

java.lang.Enum<BsonBinarySubType>

org.bson.BsonBinarySubType

All Implemented Interfaces:

Serializable, Comparable<BsonBinarySubType>

public enum BsonBinarySubType
extends Enum<BsonBinarySubType>

The Binary subtype

Since:

3.0

Enum Constant Summary

Enum Constants

Enum Constant	Description
BINARY	Binary data.
COLUMN	Columnar data
ENCRYPTED	Encrypted 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

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(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

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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 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(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:

IllegalArgumentException - if this enum type 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.