com.github.f4b6a3.uuid.factory.standard

Class DceSecurityFactory

java.lang.Object

com.github.f4b6a3.uuid.factory.UuidFactory

com.github.f4b6a3.uuid.factory.AbstTimeBasedFactory

com.github.f4b6a3.uuid.factory.standard.DceSecurityFactory

public final class DceSecurityFactory
extends AbstTimeBasedFactory

Concrete factory for creating DCE Security unique identifiers (UUIDv2).

See Also:

UuidLocalDomain, DCE Security UUIDs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DceSecurityFactory.Builder Concrete builder for creating a DCE Security factory.

Nested classes/interfaces inherited from class com.github.f4b6a3.uuid.factory.UuidFactory

UuidFactory.Parameters

Field Summary

Fields inherited from class com.github.f4b6a3.uuid.factory.AbstTimeBasedFactory

clockseqFunction, lock, nodeidFunction, timeFunction

Fields inherited from class com.github.f4b6a3.uuid.factory.UuidFactory

version, versionMask

Constructor Summary

Constructors

Constructor and Description
DceSecurityFactory() Default constructor.

Method Summary

Modifier and Type	Method and Description
static DceSecurityFactory.Builder	builder() Returns a builder of DCE Security factory.
UUID	create() Always throws an exception.
UUID	create(byte localDomain, int localIdentifier) Returns a DCE Security unique identifier (UUIDv2).
UUID	create(int localIdentifier) Returns a DCE Security unique identifier (UUIDv2).
UUID	create(UuidFactory.Parameters parameters) Returns a DCE Security unique identifier (UUIDv2).
UUID	create(UuidLocalDomain localDomain, int localIdentifier) Returns a DCE Security unique identifier (UUIDv2).

Methods inherited from class com.github.f4b6a3.uuid.factory.AbstTimeBasedFactory

formatLeastSignificantBits, formatMostSignificantBits, selectNodeIdFunction, selectTimeFunction

Methods inherited from class com.github.f4b6a3.uuid.factory.UuidFactory

getVersion, nameBytes, nameBytes, namespaceBytes, namespaceBytes, namespaceBytes, toUuid

Methods inherited from class java.lang.Object

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

Constructor Detail

DceSecurityFactory

public DceSecurityFactory()

Default constructor.

Method Detail

builder

public static DceSecurityFactory.Builder builder()

Returns a builder of DCE Security factory.

Returns:

a builder

create

public UUID create(byte localDomain,
                   int localIdentifier)

Returns a DCE Security unique identifier (UUIDv2).

A DCE Security UUID is a modified UUIDv1.

Steps of creation:

1. Create a Time-based UUIDv1;
2. Replace the least significant 8 bits of the clock sequence with the local domain;
3. Replace the least significant 32 bits of the time stamp with the local identifier.

Parameters:

localDomain - a local domain

localIdentifier - a local identifier

Returns:

a DCE Security UUID

create

public UUID create(UuidLocalDomain localDomain,
                   int localIdentifier)

Returns a DCE Security unique identifier (UUIDv2).

Parameters:

localDomain - a local domain

localIdentifier - a local identifier

Returns:

a DCE Security UUID

create

public UUID create(int localIdentifier)

Returns a DCE Security unique identifier (UUIDv2).

The local domain is local domain used by this method defined by builder:

 DceSecurityFactory factory = DceSecurityFactory.builder().withLocalDomain(UuidLocalDomain).build();
 

Parameters:

localIdentifier - a local identifier

Returns:

a UUIDv2

create

public UUID create()

Always throws an exception.

Overrides the method AbstTimeBasedFactory.create() to throw an exception instead of returning a UUID.

Overrides:

create in class AbstTimeBasedFactory

Returns:

a time-based UUID

Throws:

UnsupportedOperationException - always

create

public UUID create(UuidFactory.Parameters parameters)

Returns a DCE Security unique identifier (UUIDv2).

Overrides:

create in class AbstTimeBasedFactory

Parameters:

parameters - parameters object

Returns:

a UUIDv2