com.github.f4b6a3.uuid.factory.abst

Class AbstractUuidCreator

java.lang.Object

com.github.f4b6a3.uuid.factory.abst.AbstractUuidCreator

Direct Known Subclasses:

AbstractNameBasedUuidCreator, AbstractTimeBasedUuidCreator, RandomUuidCreator

public abstract class AbstractUuidCreator
extends Object

Abstract class for subclasses that create UUID objects.

Field Summary

Fields

Modifier and Type	Field and Description
static UUID	NIL_UUID
static long	RFC4122_VARIANT_BITS
protected static long[]	RFC4122_VERSION_BITS
protected UuidVersion	version

Constructor Summary

Constructors

Constructor and Description
AbstractUuidCreator(UuidVersion version)

Method Summary

Modifier and Type	Method and Description
protected long	getVariantBits(long lsb) Returns the variant bits from the "Least Significant Bits".
UuidVersion	getVersion()
protected long	getVersionBits(long msb) Returns the version bits from the "Most Significant Bits".
protected long	setVariantBits(long lsb) Set UUID variant bits into the "Least Significant Bits".
protected long	setVersionBits(long msb) Set UUID version bits into the "Most Significant Bits".
boolean	valid(long msb, long lsb) Check if the UUID is valid.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

version

protected final UuidVersion version

NIL_UUID

public static final UUID NIL_UUID

RFC4122_VARIANT_BITS

public static final long RFC4122_VARIANT_BITS

See Also:

Constant Field Values

RFC4122_VERSION_BITS

protected static final long[] RFC4122_VERSION_BITS

Constructor Detail

AbstractUuidCreator

public AbstractUuidCreator(UuidVersion version)

Method Detail

getVersion

public UuidVersion getVersion()

valid

public boolean valid(long msb,
                     long lsb)

Check if the UUID is valid. It checks whether the variant and version are correct.

Parameters:

msb - the MSB

lsb - the LSB

Returns:

boolean true if valid

getVariantBits

protected long getVariantBits(long lsb)

Returns the variant bits from the "Least Significant Bits".

Parameters:

lsb - the LSB

Returns:

long the variant number bits

setVariantBits

protected long setVariantBits(long lsb)

Set UUID variant bits into the "Least Significant Bits".

Parameters:

lsb - the LSB

Returns:

the LSB with the correct variant bits

getVersionBits

protected long getVersionBits(long msb)

Returns the version bits from the "Most Significant Bits".

Parameters:

msb - the MSB

Returns:

long version number bits

setVersionBits

protected long setVersionBits(long msb)

Set UUID version bits into the "Most Significant Bits".

Parameters:

msb - the MSB

Returns:

the MSB