com.github.f4b6a3.uuid

Class UuidCreator

java.lang.Object

com.github.f4b6a3.uuid.UuidCreator

public class UuidCreator
extends Object

Facade to the UUID factories.

Constructor Summary

Constructors

Constructor and Description
UuidCreator()

Method Summary

Modifier and Type	Method and Description
static CombGuidCreator	getCombCreator() Returns a CombGuidCreator.
static UUID	getCombGuid() Returns a COMB GUID for MS SQL Server.
static UUID	getDceSecurity(byte localDomain, int localIdentifier) Returns a DCE Security UUID based on a local domain and a local identifier.
static DceSecurityUuidCreator	getDceSecurityCreator() Returns a DceSecurityUuidCreator that creates UUID version 2.
static UUID	getDceSecurityWithMac(byte localDomain, int localIdentifier) Returns a DCE Security UUID with machine address based on a local domain and a local identifier.
static UUID	getFastRandom() Returns a fast random UUID.
static RandomUuidCreator	getFastRandomCreator() Returns a RandomUuidCreator that creates UUID version 4.
static MssqlGuidCreator	getMssqlCreator() Returns a MssqlGuidCreator.
static UUID	getMssqlGuid() Returns a time-based GUID for MS SQL Server.
static UUID	getNameBasedMd5(String name) Returns a UUID based on a name, using MD5.
static UUID	getNameBasedMd5(UUID namespace, String name) Returns a UUID based on a name space and a name, using MD5.
static NameBasedMd5UuidCreator	getNameBasedMd5Creator() Returns a NameBasedMd5UuidCreator that creates UUID version 3.
static UUID	getNameBasedSha1(String name) Returns a UUID based on a name, using SHA1.
static UUID	getNameBasedSha1(UUID namespace, String name) Returns a UUID based on a name space and a name, using SHA1.
static NameBasedSha1UuidCreator	getNameBasedSha1Creator() Returns a NameBasedSha1UuidCreator that creates UUID version 5.
static UUID	getNameBasedSha256(String name) Returns a UUID based on a name, using SHA256.
static UUID	getNameBasedSha256(UUID namespace, String name) Returns a UUID based on a name space and a name, using SHA256.
static NameBasedSha256UuidCreator	getNameBasedSha256Creator() Returns a NameBasedSha256UuidCreator that creates UUID version 4.
static UUID	getRandom() Returns a random UUID.
static RandomUuidCreator	getRandomCreator() Returns a RandomUuidCreator that creates UUID version 4.
static UUID	getSequential() Returns a UUID with timestamp and without machine address, but the bytes corresponding to timestamp are arranged in the "natural" order.
static SequentialUuidCreator	getSequentialCreator() Returns a SequentialUuidCreator that creates UUID version 0.
static UUID	getSequentialWithMac() Returns a UUID with timestamp and machine address, but the bytes corresponding to timestamp are arranged in the "natural" order.
static UUID	getTimeBased() Returns a UUID with timestamp and without machine address.
static TimeBasedUuidCreator	getTimeBasedCreator() Returns a TimeBasedUuidCreator that creates UUID version 1.
static UUID	getTimeBasedWithMac() Returns a UUID with timestamp and machine address.

Methods inherited from class java.lang.Object

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

Constructor Detail

UuidCreator

public UuidCreator()

Method Detail

getRandom

public static UUID getRandom()

Returns a random UUID. The random generator used is SecureRandom with SHA1PRNG algorithm.

 It uses the Details: 
 - Version number: 4
 - Variant number: 1
 - Random generator: SecureRandom
 

Returns:

a random UUID

getFastRandom

public static UUID getFastRandom()

Returns a fast random UUID. The random generator used is Xorshift128PlusRandom.

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

Returns:

a random UUID

getSequential

public static UUID getSequential()

Returns a UUID with timestamp and without machine address, but the bytes corresponding to timestamp are arranged in the "natural" order.

 Details: 
 - Version number: 0 (non-standard)
 - Variant number: 1 
 - Has timestamp?: YES 
 - Has hardware address (MAC)?: NO 
 - Timestamp bytes are in the RFC-4122 order?: NO 
 

Returns:

a sequential UUID

getSequentialWithMac

public static UUID getSequentialWithMac()

Returns a UUID with timestamp and machine address, but the bytes corresponding to timestamp are arranged in the "natural" order.

 Details: 
 - Version number: 0 (non-standard)
 - Variant number: 1 
 - Has timestamp?: YES 
 - Has hardware address (MAC)?: YES 
 - Timestamp bytes are in the RFC-4122 order?: NO 
 

Returns:

a sequential UUID with MAC

getTimeBased

public static UUID getTimeBased()

Returns a UUID with timestamp and without machine address.

 Details: 
 - Version number: 1 
 - Variant number: 1 
 - Has timestamp?: YES 
 - Has hardware address (MAC)?: NO 
 - Timestamp bytes are in the RFC-4122 order?: YES 
 

Returns:

a time-based UUID

getTimeBasedWithMac

public static UUID getTimeBasedWithMac()

Returns a UUID with timestamp and machine address.

 Details: 
 - Version number: 1 
 - Variant number: 1 
 - Has timestamp?: YES 
 - Has hardware address (MAC)?: YES 
 - Timestamp bytes are in the RFC-4122 order?: YES 
 

Returns:

a time-based UUID

getDceSecurity

public static UUID getDceSecurity(byte localDomain,
                                  int localIdentifier)

Returns a DCE Security UUID based on a local domain and a local identifier.

 Domain identifiers listed in the RFC-4122: 
 - Local Domain Person (POSIX UserID) = 0;
 - Local Domain Group (POSIX GroupID) = 1;
 - Local Domain Org = 2.

 Details: 
 - Version number: 2 
 - Variant number: 1 
 - Local domain: informed by user 
 - Has hardware address (MAC)?: NO 
 - Timestamp bytes are in the RFC-4122 order?: YES 
 

Parameters:

localDomain - a local domain

localIdentifier - a local identifier

Returns:

a DCE Security UUID

getDceSecurityWithMac

public static UUID getDceSecurityWithMac(byte localDomain,
                                         int localIdentifier)

Returns a DCE Security UUID with machine address based on a local domain and a local identifier.

 Domain identifiers listed in the RFC-4122: 
 - Local Domain Person (POSIX UserID) = 0;
 - Local Domain Group (POSIX GroupID) = 1;
 - Local Domain Org = 2.

 Details: 
 - Version number: 2 
 - Variant number: 1 
 - Local domain: informed by user 
 - Has hardware address (MAC)?: YES 
 - Timestamp bytes are in the RFC-4122 order?: YES 
 

Parameters:

localDomain - a local domain

localIdentifier - a local identifier

Returns:

a DCE Security UUID

getNameBasedMd5

public static UUID getNameBasedMd5(String name)

Returns a UUID based on a name, using MD5.

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

Parameters:

name - a name string

Returns:

a name-based UUID

getNameBasedMd5

public static UUID getNameBasedMd5(UUID namespace,
                                   String name)

Returns a UUID based on a name space and a name, using MD5.

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

Parameters:

namespace - a name space UUID

name - a name string

Returns:

a name-based UUID

getNameBasedSha1

public static UUID getNameBasedSha1(String name)

Returns a UUID based on a name, using SHA1.

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

Parameters:

name - a name string

Returns:

a name-based UUID

getNameBasedSha1

public static UUID getNameBasedSha1(UUID namespace,
                                    String name)

Returns a UUID based on a name space and a name, using SHA1.

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

Parameters:

namespace - a name space UUID

name - a name string

Returns:

a name-based UUID

getNameBasedSha256

public static UUID getNameBasedSha256(String name)

Returns a UUID based on a name, using SHA256.

 Details: 
 - Version number: 4 
 - Variant number: 1 
 - Hash Algorithm: SHA256 
 - Name Space: none 
 

Parameters:

name - a name string

Returns:

a name-based UUID

getNameBasedSha256

public static UUID getNameBasedSha256(UUID namespace,
                                      String name)

Returns a UUID based on a name space and a name, using SHA256.

 Details: 
 - Version number: 4 
 - Variant number: 1 
 - Hash Algorithm: SHA256 
 - Name Space: informed by user 
 

Parameters:

namespace - a name space UUID

name - a name string

Returns:

a name-based UUID

getMssqlGuid

public static UUID getMssqlGuid()

Returns a time-based GUID for MS SQL Server.

Returns:

a MSSQL GUID

getCombGuid

public static UUID getCombGuid()

Returns a COMB GUID for MS SQL Server.

Returns:

a COMB GUID

getSequentialCreator

public static SequentialUuidCreator getSequentialCreator()

Returns a SequentialUuidCreator that creates UUID version 0.

Returns:

SequentialUuidCreator

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

getRandomCreator

public static RandomUuidCreator getRandomCreator()

Returns a RandomUuidCreator that creates UUID version 4.

Returns:

RandomUuidCreator

getFastRandomCreator

public static RandomUuidCreator getFastRandomCreator()

Returns a RandomUuidCreator that creates UUID version 4. The random generator used is Xorshift128PlusRandom.

Returns:

RandomUuidCreator

getNameBasedSha1Creator

public static NameBasedSha1UuidCreator getNameBasedSha1Creator()

Returns a NameBasedSha1UuidCreator that creates UUID version 5.

Returns:

NameBasedSha1UuidCreator

getNameBasedSha256Creator

public static NameBasedSha256UuidCreator getNameBasedSha256Creator()

Returns a NameBasedSha256UuidCreator that creates UUID version 4.

Returns:

NameBasedSha256UuidCreator

getMssqlCreator

public static MssqlGuidCreator getMssqlCreator()

Returns a MssqlGuidCreator.

Returns:

MssqlGuidCreator

getCombCreator

public static CombGuidCreator getCombCreator()

Returns a CombGuidCreator.

Returns:

CombGuidCreator