Package com.github.f4b6a3.uuid

Class UuidCreator

java.lang.Object

com.github.f4b6a3.uuid.UuidCreator

public class UuidCreator
extends Object

Facade to the UUID factories.

Method Summary

Modifier and Type	Method	Description
static AltCombGuidCreator	getAltCombCreator()	Returns a AltCombGuidCreator.
static UUID	getAltCombGuid()	Returns an alternate COMB GUID.
static CombGuidCreator	getCombCreator()	Returns a CombGuidCreator.
static UUID	getCombGuid()	Returns a COMB GUID.
static UUID	getDceSecurity(UuidLocalDomain localDomain, int localIdentifier)	Returns a DCE Security UUID.
static DceSecurityUuidCreator	getDceSecurityCreator()	Returns a DceSecurityUuidCreator that creates UUID version 2.
static UUID	getDceSecurityWithMac(UuidLocalDomain localDomain, int localIdentifier)	Returns a DCE Security UUID.
static UUID	getFastRandomBased()	Returns a random UUID generated by a fast random generator.
static UUID	getNameBasedMd5(byte[] name)	Returns a name-based UUID (MD5).
static UUID	getNameBasedMd5(UuidNamespace namespace, byte[] name)	Returns a name-based UUID (MD5).
static UUID	getNameBasedMd5(UuidNamespace namespace, String name)	Returns a name-based UUID (MD5).
static UUID	getNameBasedMd5(String name)	Returns a name-based UUID (MD5).
static NameBasedMd5UuidCreator	getNameBasedMd5Creator()	Returns a NameBasedMd5UuidCreator that creates UUID version 3.
static UUID	getNameBasedSha1(byte[] name)	Returns a name-based UUID (SHA1).
static UUID	getNameBasedSha1(UuidNamespace namespace, byte[] name)	Returns a name-based UUID (SHA1).
static UUID	getNameBasedSha1(UuidNamespace namespace, String name)	Returns a name-based UUID (SHA1).
static UUID	getNameBasedSha1(String name)	Returns a name-based UUID (SHA1).
static NameBasedSha1UuidCreator	getNameBasedSha1Creator()	Returns a NameBasedSha1UuidCreator that creates UUID version 5.
static UUID	getNil()	Returns a Nil UUID.
static UUID	getRandomBased()	Returns a random UUID.
static RandomBasedUuidCreator	getRandomBasedCreator()	Returns a RandomBasedUuidCreator that creates UUID version 4.
static UUID	getTimeBased()	Returns a time-based UUID.
static TimeBasedUuidCreator	getTimeBasedCreator()	Returns a TimeBasedUuidCreator that creates UUID version 1.
static UUID	getTimeBasedWithMac()	Returns a time-based UUID with hardware address.
static UUID	getTimeOrdered()	Returns a time-ordered UUID.
static TimeOrderedUuidCreator	getTimeOrderedCreator()	Returns a TimeOrderedUuidCreator that creates UUID version 6.
static UUID	getTimeOrderedWithMac()	Returns a time-ordered UUID with hardware address.

Methods inherited from class java.lang.Object

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

Method Detail

getNil

public static UUID getNil()

Returns a Nil UUID. The nil UUID is special UUID that has all 128 bits set to zero.

Returns:

a Nil UUID

getRandomBased

public static UUID getRandomBased()

Returns a random UUID.

 Details: 
 - Version number: 4
 - Random generator: SecureRandom
 

Returns:

a version 4 UUID

getFastRandomBased

public static UUID getFastRandomBased()

Returns a random UUID generated by a fast random generator.

 Details: 
 - Version number: 4 
 - Random generator: Xorshift128PlusRandom
 

Returns:

a version 4 UUID

getTimeBased

public static UUID getTimeBased()

Returns a time-based UUID.

 Details: 
 - Version number: 1
 - Has timestamp?: YES
 - Has hardware address (MAC)?: NO (random)
 

Returns:

a version 1 UUID

getTimeBasedWithMac

public static UUID getTimeBasedWithMac()

Returns a time-based UUID with hardware address.

 Details: 
 - Version number: 1 
 - Has timestamp?: YES 
 - Has hardware address (MAC)?: YES
 

Returns:

a version 1 UUID

getTimeOrdered

public static UUID getTimeOrdered()

Returns a time-ordered UUID.

 Details: 
 - Version number: 6
 - Has timestamp?: YES 
 - Has hardware address (MAC)?: NO (random)
 

Returns:

a version 6 UUID

getTimeOrderedWithMac

public static UUID getTimeOrderedWithMac()

Returns a time-ordered UUID with hardware address.

 Details: 
 - Version number: 6
 - Has timestamp?: YES 
 - Has hardware address (MAC)?: YES
 

Returns:

a version 6 UUID

getNameBasedMd5

public static UUID getNameBasedMd5(String name)

Returns a name-based UUID (MD5).

 Details: 
 - Version number: 3 
 - Hash Algorithm: MD5 
 - Name Space: none
 

Parameters:

name - a name string

Returns:

a version 3 UUID

getNameBasedMd5

public static UUID getNameBasedMd5(byte[] name)

Returns a name-based UUID (MD5).

 Details: 
 - Version number: 3 
 - Hash Algorithm: MD5 
 - Name Space: none
 

Parameters:

name - a byte array

Returns:

a version 3 UUID

getNameBasedMd5

public static UUID getNameBasedMd5(UuidNamespace namespace,
                                   String name)

Returns a name-based UUID (MD5). See: UuidNamespace.

 Details: 
 - Version number: 3 
 - Hash Algorithm: MD5 
 - Name Space: informed by user
 

Parameters:

namespace - a name space enumeration

name - a name string

Returns:

a version 3 UUID

getNameBasedMd5

public static UUID getNameBasedMd5(UuidNamespace namespace,
                                   byte[] name)

Returns a name-based UUID (MD5). See: UuidNamespace.

 Details: 
 - Version number: 3 
 - Hash Algorithm: MD5 
 - Name Space: informed by user
 

Parameters:

namespace - a name space enumeration

name - a byte array

Returns:

a version 3 UUID

getNameBasedSha1

public static UUID getNameBasedSha1(String name)

Returns a name-based UUID (SHA1).

 Details: 
 - Version number: 5 
 - Hash Algorithm: SHA1 
 - Name Space: none
 

Parameters:

name - a name string

Returns:

a version 5 UUID

getNameBasedSha1

public static UUID getNameBasedSha1(byte[] name)

Returns a name-based UUID (SHA1).

 Details: 
 - Version number: 5 
 - Hash Algorithm: SHA1 
 - Name Space: none
 

Parameters:

name - a byte array

Returns:

a version 5 UUID

getNameBasedSha1

public static UUID getNameBasedSha1(UuidNamespace namespace,
                                    String name)

Returns a name-based UUID (SHA1). See: UuidNamespace.

 Details: 
 - Version number: 5 
 - Hash Algorithm: SHA1 
 - Name Space: informed by user
 

Parameters:

namespace - a name space enumeration

name - a name string

Returns:

a version 5 UUID

getNameBasedSha1

public static UUID getNameBasedSha1(UuidNamespace namespace,
                                    byte[] name)

Returns a name-based UUID (SHA1). See: UuidNamespace.

 Details: 
 - Version number: 5 
 - Hash Algorithm: SHA1 
 - Name Space: informed by user
 

Parameters:

namespace - a name space enumeration

name - a byte array

Returns:

a version 5 UUID

getDceSecurity

public static UUID getDceSecurity(UuidLocalDomain localDomain,
                                  int localIdentifier)

Returns a DCE Security UUID. See: UuidLocalDomain.

 Details: 
 - Version number: 2 
 - Has hardware address (MAC)?: NO (random)
 

Parameters:

localDomain - a local domain enumeration

localIdentifier - a local identifier

Returns:

a version 2 UUID

getDceSecurityWithMac

public static UUID getDceSecurityWithMac(UuidLocalDomain localDomain,
                                         int localIdentifier)

Returns a DCE Security UUID. See: UuidLocalDomain.

 Details: 
 - Version number: 2 
 - Has hardware address (MAC)?: YES
 

Parameters:

localDomain - a local domain enumeration

localIdentifier - a local identifier

Returns:

a version 2 UUID

getCombGuid

public static UUID getCombGuid()

Returns a COMB GUID. The time a SUFFIX is at the LEAST significant bits.

Returns:

a GUID

getAltCombGuid

public static UUID getAltCombGuid()

Returns an alternate COMB GUID. The time a PREFIX is at the MOST significant bits.

Returns:

a GUID

getTimeBasedCreator

public static TimeBasedUuidCreator getTimeBasedCreator()

Returns a TimeBasedUuidCreator that creates UUID version 1.

Returns:

TimeBasedUuidCreator

getDceSecurityCreator

public static DceSecurityUuidCreator getDceSecurityCreator()

Returns a DceSecurityUuidCreator that creates UUID version 2.

Returns:

DceSecurityUuidCreator

getNameBasedMd5Creator

public static NameBasedMd5UuidCreator getNameBasedMd5Creator()

Returns a NameBasedMd5UuidCreator that creates UUID version 3.

Returns:

NameBasedMd5UuidCreator

getRandomBasedCreator

public static RandomBasedUuidCreator getRandomBasedCreator()

Returns a RandomBasedUuidCreator that creates UUID version 4.

Returns:

RandomBasedUuidCreator

getNameBasedSha1Creator

public static NameBasedSha1UuidCreator getNameBasedSha1Creator()

Returns a NameBasedSha1UuidCreator that creates UUID version 5.

Returns:

NameBasedSha1UuidCreator

getTimeOrderedCreator

public static TimeOrderedUuidCreator getTimeOrderedCreator()

Returns a TimeOrderedUuidCreator that creates UUID version 6.

Returns:

TimeOrderedUuidCreator

getCombCreator

public static CombGuidCreator getCombCreator()

Returns a CombGuidCreator.

Returns:

CombGuidCreator

getAltCombCreator

public static AltCombGuidCreator getAltCombCreator()

Returns a AltCombGuidCreator.

Returns:

AltCombGuidCreator