com.github.f4b6a3.uuid.factory.standard

Class TimeOrderedEpochFactory

java.lang.Object

com.github.f4b6a3.uuid.factory.UuidFactory

com.github.f4b6a3.uuid.factory.AbstRandomBasedFactory

com.github.f4b6a3.uuid.factory.AbstCombFactory

com.github.f4b6a3.uuid.factory.standard.TimeOrderedEpochFactory

public final class TimeOrderedEpochFactory
extends AbstCombFactory

Concrete factory for creating Unix epoch time-ordered unique identifiers (UUIDv7).

UUIDv7 is a new UUID version proposed by Peabody and Davis. It is similar to Prefix COMB GUID and ULID.

This factory creates 3 types:

• Type 1 (default): this type is divided in 3 components, namely time, counter and random. The counter component is incremented by 1 when the time repeats. The random component is always randomized.
• Type 2 (plus 1): this type is divided in 2 components, namely time and monotonic random. The monotonic random component is incremented by 1 when the time repeats. This type of UUID is like a Monotonic ULID. It can be much faster than the other types.
• Type 3 (plus n): this type is also divided in 2 components, namely time and monotonic random. The monotonic random component is incremented by a random positive integer between 1 and MAX when the time repeats. If the value of MAX is not specified, MAX is 2^32. This type of UUID is also like a Monotonic ULID.

Warning: this can change in the future.

Since:

5.0.0

See Also:

PrefixCombFactory, ULID Specification, New UUID formats, Revise Universally Unique Identifier Definitions (uuidrev)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeOrderedEpochFactory.Builder Concrete builder for creating a Unix epoch time-ordered factory.

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

AbstRandomBasedFactory.FastRandom, AbstRandomBasedFactory.IRandom, AbstRandomBasedFactory.SafeRandom

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.AbstCombFactory

timeFunction

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

lock, random, UUID_BYTES

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

version, versionMask

Constructor Summary

Constructors

Constructor and Description
TimeOrderedEpochFactory() Default constructor.
TimeOrderedEpochFactory(Clock clock) Constructor with a clock.
TimeOrderedEpochFactory(LongSupplier randomFunction) Constructor with a function which return random numbers.
TimeOrderedEpochFactory(LongSupplier randomFunction, Clock clock) Constructor with a function which a function which return random numbers and a clock.
TimeOrderedEpochFactory(Random random) Constructor with a random.
TimeOrderedEpochFactory(Random random, Clock clock) Constructor with a random and a clock.

Method Summary

Modifier and Type	Method and Description
static TimeOrderedEpochFactory.Builder	builder() Returns a builder of Unix epoch time-ordered factory.
UUID	create() Returns a time-ordered unique identifier (UUIDv7).
UUID	create(UuidFactory.Parameters parameters) Returns a time-ordered unique identifier (UUIDv7) for a given instant.

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

TimeOrderedEpochFactory

public TimeOrderedEpochFactory()

Default constructor.

TimeOrderedEpochFactory

public TimeOrderedEpochFactory(Clock clock)

Constructor with a clock.

Parameters:

clock - a clock

TimeOrderedEpochFactory

public TimeOrderedEpochFactory(Random random)

Constructor with a random.

Parameters:

random - a random

TimeOrderedEpochFactory

public TimeOrderedEpochFactory(Random random,
                               Clock clock)

Constructor with a random and a clock.

Parameters:

random - a random

clock - a clock

TimeOrderedEpochFactory

public TimeOrderedEpochFactory(LongSupplier randomFunction)

Constructor with a function which return random numbers.

Parameters:

randomFunction - a function

TimeOrderedEpochFactory

public TimeOrderedEpochFactory(LongSupplier randomFunction,
                               Clock clock)

Constructor with a function which a function which return random numbers and a clock.

Parameters:

randomFunction - a function

clock - a clock

Method Detail

builder

public static TimeOrderedEpochFactory.Builder builder()

Returns a builder of Unix epoch time-ordered factory.

Returns:

a builder

create

public UUID create()

Returns a time-ordered unique identifier (UUIDv7).

Specified by:

create in class UuidFactory

Returns:

a UUIDv7

create

public UUID create(UuidFactory.Parameters parameters)

Returns a time-ordered unique identifier (UUIDv7) for a given instant.

The random component is generated with each method invocation.

Overrides:

create in class AbstRandomBasedFactory

Parameters:

instant - a given instant

Returns:

a UUIDv7