Package com.github.f4b6a3.ulid
Class UlidCreator
- java.lang.Object
-
- com.github.f4b6a3.ulid.UlidCreator
-
public final class UlidCreator extends Object
A factory for Universally Unique Lexicographically Sortable Identifiers. See the ULID spec: https://github.com/ulid/spec
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static UUIDfromString(String ulid)Returns a ULID as GUID from a string.static UUIDgetUlid()Returns a ULID as GUID.static UlidSpecCreatorgetUlidSpecCreator()Return a GUID creator for direct use.static StringgetUlidString()Returns a ULID string.static StringtoString(UUID ulid)Convert a UUID to ULID string The returning string is encoded to Crockford's base32.
-
-
-
Method Detail
-
fromString
public static UUID fromString(String ulid)
Returns a ULID as GUID from a string. The input string must be encoded to Crockford's base32, following the ULID specification. An exception is thrown if the ULID string is invalid.- Parameters:
ulid- a ULID string- Returns:
- a UUID
- Throws:
InvalidUlidException- if invalid
-
toString
public static String toString(UUID ulid)
Convert a UUID to ULID string The returning string is encoded to Crockford's base32.- Parameters:
uuid- a UUID- Returns:
- a ULID string
-
getUlid
public static UUID getUlid()
Returns a ULID as GUID. The random component is generated by a secure random number generator:SecureRandom.- Returns:
- a UUID
-
getUlidString
public static String getUlidString()
Returns a ULID string. The returning string is encoded to Crockford's base32. The random component is generated by a secure random number generator:SecureRandom.- Returns:
- a ULID string
-
getUlidSpecCreator
public static UlidSpecCreator getUlidSpecCreator()
Return a GUID creator for direct use.- Returns:
- a
UlidSpecCreator
-
-