Package de.fxlae.typeid

Class TypeId

java.lang.Object

de.fxlae.typeid.TypeId

public final class TypeId
extends Object

An implementation of TypeID for Java.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static TypeId	generate()	Creates a new TypeId without prefix, based on UUIDv7.
static TypeId	generate(String prefix)	Creates a new prefixed TypeId based on UUIDv7.
String	getPrefix()	Returns the prefix of this TypeId.
UUID	getUuid()	Returns the underlying UUID of this TypeId.
int	hashCode()
static TypeId	of(String prefix, UUID uuid)	Creates a new TypeId, based on the given prefix and UUID.
static TypeId	of(UUID uuid)	Creates a new TypeId without prefix, based on the given UUID.
static TypeId	parse(String text)	Parses the textual representation of a TypeID and returns a TypeId instance.
String	toString()	Returns the textual representation of this TypeId.

Methods inherited from class java.lang.Object

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

Method Details

getPrefix

public String getPrefix()

Returns the prefix of this TypeId.

Returns:

the prefix.

getUuid

public UUID getUuid()

Returns the underlying UUID of this TypeId.

Returns:

the UUID.

generate

public static TypeId generate(String prefix)
                       throws IllegalArgumentException

Creates a new prefixed TypeId based on UUIDv7.

Parameters:

prefix - the prefix to use.

Returns:

the new TypeId.

Throws:

IllegalArgumentException

generate

public static TypeId generate()

Creates a new TypeId without prefix, based on UUIDv7.

Note: "no prefix" means empty string, not null.

Returns:

the new TypeId.

of

public static TypeId of(UUID uuid)
                 throws IllegalArgumentException

Creates a new TypeId without prefix, based on the given UUID.

The UUID can be of any version.

Note: "no prefix" means empty string, not null.

Parameters:

uuid - the UUID to use.

Returns:

the new TypeId.

Throws:

IllegalArgumentException

of

public static TypeId of(String prefix,
 UUID uuid)
                 throws IllegalArgumentException

Creates a new TypeId, based on the given prefix and UUID.

Parameters:

prefix - the prefix to use.

uuid - the UUID to use.

Returns:

the new TypeId.

Throws:

IllegalArgumentException

parse

public static TypeId parse(String text)
                    throws IllegalArgumentException

Parses the textual representation of a TypeID and returns a TypeId instance.

Parameters:

text - the textual representation.

Returns:

the new TypeId.

Throws:

IllegalArgumentException

toString

public String toString()

Returns the textual representation of this TypeId.

Overrides:

toString in class Object

Returns:

the textual representation.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object