Modifier and Type	Class and Description
private static class	CUID.Common
private static class	CUID.CUIDv1 CUID Version 1.
private static class	CUID.CUIDv2 CUID Version 2.

Modifier and Type	Field and Description
private static final int	NUMBER_BASE
private static final long	serialVersionUID
private final String	value CUID internal value holder.

Access	Constructor and Description
private	CUID(final String A valid CUID value value) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
public int	compareTo(final CUID cuid) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(final Object An object o) Overrides java.lang.Object.equals. Returns `true` if the argument is equal to current object, `false` otherwise.
public static CUID	Returns: A `CUID` with the specified value fromString(final String A string that specifies a `CUID` (Version 1 or 2) cuidAsString) Creates a `CUID` from the string standard representation.
public int	Returns: Generated hashcode hashCode() Overrides java.lang.Object.hashCode. Generates a hash code.
public static boolean	Returns: `true` If the string is conforms, otherwise, `false` isValid(final String A string that specifies a `CUID` (Version 1 or 2) cuidAsString) Checks the `CUID` from the string standard representation.
public static CUID	Returns: Newly generated CUID (Version 1) randomCUID1() Generates a new random CUID (Version 1).
public static CUID	Returns: Newly generated CUID (Version 2) randomCUID2() Generates a new random CUID (Version 2).
public static CUID	Returns: Newly generated CUID (Version 2) randomCUID2(final int requested CUID length length) Generates a new random CUID (Version 2).
private static int	Returns: a non-negative value safeAbs(final int the integer value i) Always return non-negative value.
public String	Returns: String containing the `CUID` toString() Overrides java.lang.Object.toString. Returns the string representation.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

NUMBER_BASE	back to summary
private static final int NUMBER_BASE

serialVersionUID	back to summary
private static final long serialVersionUID

value	back to summary
private final String value CUID internal value holder.

Constructor Detail

CUID	back to summary
private CUID(final String value) Creates a new instance. Parameters value:String A valid CUID value Since 1.0.0

CUID

back to summary

private CUID(final String value)

Creates a new instance.

Parameters

value:String: A valid CUID value

Since

1.0.0

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(final CUID cuid) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override Since 1.0.0

public int compareTo(final CUID cuid)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

Since

1.0.0

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Returns `true` if the argument is equal to current object, `false` otherwise. Parameters o:Object An object Annotations @Override Since 1.0.0

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Returns true if the argument is equal to current object, false otherwise.

Parameters

o:Object: An object

Annotations

@Override

Since

1.0.0

fromString back to summary

fromString	back to summary
public static CUID fromString(final String cuidAsString) Creates a `CUID` from the string standard representation. Parameters cuidAsString:String A string that specifies a `CUID` (Version 1 or 2) Returns:CUID A `CUID` with the specified value Exceptions IllegalArgumentException: If the string is not conform Since 1.0.0

public static CUID fromString(final String cuidAsString)

Creates a CUID from the string standard representation.

Parameters

cuidAsString:String: A string that specifies a CUID (Version 1 or 2)

Returns:CUID

A CUID with the specified value

Exceptions

IllegalArgumentException:: If the string is not conform

Since

1.0.0

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Generates a hash code. Returns:int Generated hashcode Annotations @Override Since 1.0.0

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Generates a hash code.

Returns:int

Generated hashcode

Annotations

@Override

Since

1.0.0

isValid back to summary

isValid	back to summary
public static boolean isValid(final String cuidAsString) Checks the `CUID` from the string standard representation. Parameters cuidAsString:String A string that specifies a `CUID` (Version 1 or 2) Returns:boolean `true` If the string is conforms, otherwise, `false` Since 1.0.0

public static boolean isValid(final String cuidAsString)

Checks the CUID from the string standard representation.

Parameters

cuidAsString:String: A string that specifies a CUID (Version 1 or 2)

Returns:boolean

true If the string is conforms, otherwise, false

Since

1.0.0

randomCUID1	back to summary
public static CUID randomCUID1() Generates a new random CUID (Version 1). Returns:CUID Newly generated CUID (Version 1) Since 2.0.0

randomCUID1

back to summary

public static CUID randomCUID1()

Generates a new random CUID (Version 1).

Returns:CUID: Newly generated CUID (Version 1)
Since: 2.0.0

randomCUID2	back to summary
public static CUID randomCUID2() Generates a new random CUID (Version 2). Returns:CUID Newly generated CUID (Version 2) Since 2.0.0

randomCUID2

back to summary

public static CUID randomCUID2()

Generates a new random CUID (Version 2).

Returns:CUID: Newly generated CUID (Version 2)
Since: 2.0.0

randomCUID2	back to summary
public static CUID randomCUID2(final int length) Generates a new random CUID (Version 2). Parameters length:int requested CUID length Returns:CUID Newly generated CUID (Version 2) Since 2.0.1

randomCUID2

back to summary

public static CUID randomCUID2(final int length)

Generates a new random CUID (Version 2).

Parameters

length:int: requested CUID length

Returns:CUID

Newly generated CUID (Version 2)

Since

2.0.1

safeAbs	back to summary
private static int safeAbs(final int i) Always return non-negative value. Parameters i:int the integer value Returns:int a non-negative value Since 2.0.3

safeAbs

back to summary

private static int safeAbs(final int i)

Always return non-negative value.

Parameters

i:int: the integer value

Returns:int

a non-negative value

Since

2.0.3

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns the string representation. Returns:String String containing the `CUID` Annotations @Override Since 1.0.0

public String toString()

Overrides java.lang.Object.toString.

Returns the string representation.

Returns:String

String containing the CUID

Annotations

@Override

Since

1.0.0

io.github.thibaultmeyer.cuid back to summary

private final Class CUID.Common

Class Inheritance

extends Object

java.lang.Object
io.github.thibaultmeyer.cuid.CUID.Common

Field Summary

Modifier and Type	Field and Description
private static final String	MACHINE_FINGERPRINT
private static final SecureRandom	NUMBER_GENERATOR
private static final byte[]	RANDOM_BUFFER
private static final int	RANDOM_BUFFER_SIZE
private static int	randomBufferIndex

Constructor Summary

Access	Constructor and Description
private	Common()

Method Summary

Modifier and Type	Method and Description
private static String	Returns: The machine fingerprint getMachineFingerprint() retrieves the machine fingerprint.
private static synchronized int	Returns: A random integer nextIntValue() Retrieves next random integer value.
private static String	Returns: The padded string padWithZero(final String The string to pad str, final int The size to keep size) Pads string with leading zero.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

MACHINE_FINGERPRINT	back to summary
private static final String MACHINE_FINGERPRINT

NUMBER_GENERATOR	back to summary
private static final SecureRandom NUMBER_GENERATOR

RANDOM_BUFFER	back to summary
private static final byte[] RANDOM_BUFFER

RANDOM_BUFFER_SIZE	back to summary
private static final int RANDOM_BUFFER_SIZE

randomBufferIndex	back to summary
private static int randomBufferIndex

Constructor Detail

Common	back to summary
private Common()

Method Detail

getMachineFingerprint	back to summary
private static String getMachineFingerprint() retrieves the machine fingerprint. Returns:String The machine fingerprint Since 1.0.0

getMachineFingerprint

back to summary

private static String getMachineFingerprint()

retrieves the machine fingerprint.

Returns:String: The machine fingerprint
Since: 1.0.0

nextIntValue	back to summary
private static synchronized int nextIntValue() Retrieves next random integer value. Returns:int A random integer Since 1.0.0

nextIntValue

back to summary

private static synchronized int nextIntValue()

Retrieves next random integer value.

Returns:int: A random integer
Since: 1.0.0

padWithZero	back to summary
private static String padWithZero(final String str, final int size) Pads string with leading zero. Parameters str:String The string to pad size:int The size to keep Returns:String The padded string Since 1.0.0

padWithZero

back to summary

private static String padWithZero(final String str, final int size)

Pads string with leading zero.

Parameters

str:String: The string to pad
size:int: The size to keep

Returns:String

The padded string

Since

1.0.0

io.github.thibaultmeyer.cuid back to summary

private final Class CUID.CUIDv1

Class Inheritance

extends Object

java.lang.Object
io.github.thibaultmeyer.cuid.CUID.CUIDv1

CUID Version 1.

Since: 1.0.0

Field Summary

Modifier and Type	Field and Description
private static final int	BLOCK_SIZE
private static int	counter
private static final int	DISCRETE_VALUE
private static final int	LENGTH_STANDARD
private static final String	START_CHARACTER

Constructor Summary

Access	Constructor and Description
private	CUIDv1()

Method Summary

Modifier and Type	Method and Description
private static String	Returns: Newly generated block of data getRandomBlock() Generates a random block of data.
private static synchronized int	Returns: The counter next value nextCounterValue() Retrieves the counter next value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BLOCK_SIZE	back to summary
private static final int BLOCK_SIZE

counter	back to summary
private static int counter

DISCRETE_VALUE	back to summary
private static final int DISCRETE_VALUE

LENGTH_STANDARD	back to summary
private static final int LENGTH_STANDARD

START_CHARACTER	back to summary
private static final String START_CHARACTER

Constructor Detail

CUIDv1	back to summary
private CUIDv1()

Method Detail

getRandomBlock	back to summary
private static String getRandomBlock() Generates a random block of data. Returns:String Newly generated block of data Since 1.0.0

getRandomBlock

back to summary

private static String getRandomBlock()

Generates a random block of data.

Returns:String: Newly generated block of data
Since: 1.0.0

nextCounterValue	back to summary
private static synchronized int nextCounterValue() Retrieves the counter next value. Returns:int The counter next value Since 1.0.0

nextCounterValue

back to summary

private static synchronized int nextCounterValue()

Retrieves the counter next value.

Returns:int: The counter next value
Since: 1.0.0

io.github.thibaultmeyer.cuid back to summary

private final Class CUID.CUIDv2

Class Inheritance

extends Object

java.lang.Object
io.github.thibaultmeyer.cuid.CUID.CUIDv2

CUID Version 2.

Since: 2.0.0

Field Summary

Modifier and Type	Field and Description
private static final char[]	ALPHABET_ARRAY
private static int	counter
private static final int	LENGTH_STANDARD
private static final int[]	PRIME_NUMBER_ARRAY

Constructor Summary

Access	Constructor and Description
private	CUIDv2()

Method Summary

Modifier and Type	Method and Description
private static String	Returns: String containing hash computeHash(final String content, final int saltLength) Computes hash.
private static String	Returns: String containing entropy in base `CUID#NUMBER_BASE` createEntropy(final int Length of the entropy string length) Creates an entropy string.
private static synchronized int	Returns: The counter next value nextCounterValue() Retrieves the counter next value.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

ALPHABET_ARRAY	back to summary
private static final char[] ALPHABET_ARRAY

counter	back to summary
private static int counter

LENGTH_STANDARD	back to summary
private static final int LENGTH_STANDARD

PRIME_NUMBER_ARRAY	back to summary
private static final int[] PRIME_NUMBER_ARRAY

Constructor Detail

CUIDv2	back to summary
private CUIDv2()

Method Detail

computeHash	back to summary
private static String computeHash(final String content, final int saltLength) Computes hash. Returns:String String containing hash

computeHash

back to summary

private static String computeHash(final String content, final int saltLength)

Computes hash.

Returns:String: String containing hash

createEntropy back to summary

private static String createEntropy(final int length)

Creates an entropy string.

Parameters

length:int: Length of the entropy string

Returns:String

String containing entropy in base CUID#NUMBER_BASE

nextCounterValue

back to summary

private static synchronized int nextCounterValue()

Retrieves the counter next value.

Returns:int: The counter next value

public final Class CUID

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CUID.Common

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CUID.CUIDv1

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class CUID.CUIDv2

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail