Package dev.voidframework.core.lang

Class CUID

java.lang.Object

dev.voidframework.core.lang.CUID

All Implemented Interfaces:

Serializable, Comparable<CUID>

public final class CUID
extends Object
implements Serializable, Comparable<CUID>

Collision-resistant ID optimized for horizontal scaling and performance.

See Also:

• CUID official website
• Serialized Form

Method Summary

Modifier and Type	Method	Description
int	compareTo(CUID cuid)
boolean	equals(Object o)
static CUID	fromString(String cuidAsString)	Creates a CUID from the string standard representation.
int	hashCode()
static boolean	isValid(String cuidAsString)	Checks the CUID from the string standard representation.
static CUID	randomCUID()	Generates a new random CUID.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

randomCUID

public static CUID randomCUID()

Generates a new random CUID.

Returns:

Newly generated CUID

fromString

public static CUID fromString(String cuidAsString)

Creates a CUID from the string standard representation.

Parameters:

cuidAsString - A string that specifies a CUID

Returns:

A CUID with the specified value

Throws:

IllegalArgumentException - If the string is not conform

isValid

public static boolean isValid(String cuidAsString)

Checks the CUID from the string standard representation.

Parameters:

cuidAsString - A string that specifies a CUID

Returns:

true If the string is not conform, otherwise, false

compareTo

public int compareTo(CUID cuid)

Specified by:

compareTo in interface Comparable<CUID>

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object