org.arl.fjage

Class UUID7

java.lang.Object

org.arl.fjage.UUID7

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<UUID7>

public final class UUID7
extends java.lang.Object
implements java.lang.Comparable<UUID7>, java.io.Serializable

A simple and lightweight implementation of UUIDv7 that is compatible with Java 8.

UUIDv7 is a time-based UUID version that is lexicographically sortable and contains a timestamp.

The structure of a UUIDv7 is as follows:

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                           unix_ts_ms                          |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |          unix_ts_ms           |  ver  |      rand_a           |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |var|                        rand_b                             |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                            rand_b                             |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 

• unix_ts_ms (48 bits): The Unix timestamp in milliseconds.
• ver (4 bits): The version number, which is 7.
• rand_a (12 bits): Random bits.
• var (2 bits): The variant, which is '10'.
• rand_b (62 bits): More random bits.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	compareTo(UUID7 o)
boolean	equals(java.lang.Object o)
static UUID7	fromUUID(java.util.UUID uuid) Creates a UUID7 from a standard java.util.UUID.
static UUID7	generate() Generates a new UUIDv7.
long	getTimestamp() Returns the timestamp embedded in this UUIDv7.
int	hashCode()
java.lang.String	toString()
java.util.UUID	toUUID() Converts this UUIDv7 to a standard java.util.UUID.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

generate

public static UUID7 generate()

Generates a new UUIDv7.

Returns:

A new UUIDv7 instance.

fromUUID

public static UUID7 fromUUID(java.util.UUID uuid)

Creates a UUID7 from a standard java.util.UUID.

Parameters:

uuid - The UUID to convert.

Returns:

A new UUID7 instance.

getTimestamp

public long getTimestamp()

Returns the timestamp embedded in this UUIDv7.

Returns:

The timestamp in milliseconds since the Unix epoch.

toUUID

public java.util.UUID toUUID()

Converts this UUIDv7 to a standard java.util.UUID.

Returns:

A java.util.UUID representation of this UUIDv7.

compareTo

public int compareTo(UUID7 o)

Specified by:

compareTo in interface java.lang.Comparable<UUID7>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object