com.github.f4b6a3.uuid.enums

Enum UuidVariant

java.lang.Object

java.lang.Enum<UuidVariant>

com.github.f4b6a3.uuid.enums.UuidVariant

All Implemented Interfaces:

Serializable, Comparable<UuidVariant>

public enum UuidVariant
extends Enum<UuidVariant>

UUID variants defined by RFC 9562.

List of variants:

• VARIANT_RESERVED_NCS: 0
• VARIANT_STANDARD: 2
• VARIANT_RESERVED_MICROSOFT: 6
• VARIANT_RESERVED_FUTURE: 7

See Also:

RFC 9562

Enum Constant Summary

Enum Constants

Enum Constant and Description
VARIANT_RESERVED_FUTURE Reserved for future definition.
VARIANT_RESERVED_MICROSOFT Reserved for Microsoft Corporation backward compatibility.
VARIANT_RESERVED_NCS Reserved for NCS backward compatibility.
VARIANT_STANDARD The variant specified in RFC 9562.

Method Summary

Modifier and Type	Method and Description
int	getValue() Get the number value.
static UuidVariant	getVariant(int value) Get the enum value.
static UuidVariant	valueOf(String name) Returns the enum constant of this type with the specified name.
static UuidVariant[]	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

VARIANT_RESERVED_NCS

public static final UuidVariant VARIANT_RESERVED_NCS

Reserved for NCS backward compatibility.

VARIANT_STANDARD

public static final UuidVariant VARIANT_STANDARD

The variant specified in RFC 9562.

VARIANT_RESERVED_MICROSOFT

public static final UuidVariant VARIANT_RESERVED_MICROSOFT

Reserved for Microsoft Corporation backward compatibility.

VARIANT_RESERVED_FUTURE

public static final UuidVariant VARIANT_RESERVED_FUTURE

Reserved for future definition.

Method Detail

values

public static UuidVariant[] 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 (UuidVariant c : UuidVariant.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static UuidVariant 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

getValue

public int getValue()

Get the number value.

Returns:

a number

getVariant

public static UuidVariant getVariant(int value)

Get the enum value.

Parameters:

value - a number.

Returns:

the enum