UlidUtil (ulid-creator 1.0.1 API)

java.lang.Object
- com.github.f4b6a3.ulid.util.UlidUtil

```
public class UlidUtil
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UlidUtil.UlidUtilException

Nested Classes
Modifier and Type	Class and Description
`static class`	`UlidUtil.UlidUtilException`

Field Summary

Fields
Modifier and Type Field and Description

protected static long TIMESTAMP_MAX

protected static String ULID_PATTERN_LOOSE

protected static String ULID_PATTERN_STRICT

Fields
Modifier and Type	Field and Description
`protected static long`	`TIMESTAMP_MAX`
`protected static String`	`ULID_PATTERN_LOOSE`
`protected static String`	`ULID_PATTERN_STRICT`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Instant`	`extractInstant(String ulid)`
`static String`	`extractRandomnessComponent(String ulid)`
`static long`	`extractTimestamp(String ulid)`
`static String`	`extractTimestampComponent(String ulid)`
`protected static long`	`extractUnixMilliseconds(String ulid)`
`static String`	`fromBytesToUlid(byte[] bytes)` Convert an array of bytes to a ULID string.
`static UUID`	`fromBytesToUuid(byte[] bytes)` Get a UUID from an array of bytes;
`static byte[]`	`fromUlidToBytes(String ulid)` Convert a ULID string to an array of bytes.
`static UUID`	`fromUlidToUuid(String ulid)` Converts a ULID string to a UUID.
`static byte[]`	`fromUuidToBytes(UUID uuid)` Get the array of bytes from a UUID.
`static String`	`fromUuidToUlid(UUID uuid)` Convert a UUID to ULID string
`static boolean`	`isValid(String ulid)` Checks if the string is a valid ULID.
`static boolean`	`isValid(String ulid, boolean strict)` Checks if the string is a valid ULID.
`protected static void`	`validate(String ulid)` Checks if the ULID string is a valid.
`protected static void`	`validate(String ulid, boolean strict)` Checks if the ULID string is a valid.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TIMESTAMP_MAX
```
protected static final long TIMESTAMP_MAX
```
  - ULID_PATTERN_STRICT
```
protected static final String ULID_PATTERN_STRICT
```
    See Also:
    
    Constant Field Values
  - ULID_PATTERN_LOOSE
```
protected static final String ULID_PATTERN_LOOSE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - fromUuidToUlid
```
public static String fromUuidToUlid(UUID uuid)
```
    Convert a UUID to ULID string
    
    Parameters:
    
    uuid - a UUID
    
    Returns:
    
    a ULID
  - fromUlidToUuid
```
public static UUID fromUlidToUuid(String ulid)
```
    Converts a ULID string to a UUID. An exception is thrown if the ULID string is invalid.
    
    Parameters:
    
    ulid - a ULID
    
    Returns:
    
    a UUID if valid
  - fromUuidToBytes
```
public static byte[] fromUuidToBytes(UUID uuid)
```
    Get the array of bytes from a UUID.
    
    Parameters:
    
    uuid - a UUID
    
    Returns:
    
    an array of bytes
  - fromBytesToUuid
```
public static UUID fromBytesToUuid(byte[] bytes)
```
    Get a UUID from an array of bytes;
    
    Parameters:
    
    bytes - an array of bytes
    
    Returns:
    
    a UUID
  - fromBytesToUlid
```
public static String fromBytesToUlid(byte[] bytes)
```
    Convert an array of bytes to a ULID string.
    
    Parameters:
    
    bytes - a byte array
    
    Returns:
    
    a ULID string
  - fromUlidToBytes
```
public static byte[] fromUlidToBytes(String ulid)
```
    Convert a ULID string to an array of bytes.
    
    Parameters:
    
    ulid - a ULID string
    
    Returns:
    
    an array of bytes
  - validate
```
protected static void validate(String ulid)
```
    Checks if the ULID string is a valid. The validation mode is not strict. See validate(String, boolean).
    
    Parameters:
    
    ulid - a ULID
  - validate
```
protected static void validate(String ulid,
                               boolean strict)
```
    Checks if the ULID string is a valid. See validate(String, boolean).
    
    Parameters:
    
    ulid - a ULID
  - isValid
```
public static boolean isValid(String ulid)
```
    Checks if the string is a valid ULID. The validation mode is not strict. See validate(String, boolean).
  - isValid
```
public static boolean isValid(String ulid,
                              boolean strict)
```
    Checks if the string is a valid ULID.
```
 Strict validation: checks if the string is in the ULID specification format:
 
 - 0123456789ABCDEFGHJKMNPKRS (26 alphanumeric, case insensitive, except iI, lL, oO and uU)
 
 Loose validation: checks if the string is in one of these formats:

 - 0123456789ABCDEFGHIJKLMNOP (26 alphanumeric, case insensitive, except uU)
 
```
    Parameters:
    
    ulid - a ULID
    
    strict - true for strict validation, false for loose validation
    
    Returns:
    
    boolean true if valid
  - extractTimestamp
```
public static long extractTimestamp(String ulid)
```
  - extractInstant
```
public static Instant extractInstant(String ulid)
```
  - extractTimestampComponent
```
public static String extractTimestampComponent(String ulid)
```
  - extractRandomnessComponent
```
public static String extractRandomnessComponent(String ulid)
```
  - extractUnixMilliseconds
```
protected static long extractUnixMilliseconds(String ulid)
```

Class UlidUtil

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TIMESTAMP_MAX

ULID_PATTERN_STRICT

ULID_PATTERN_LOOSE

Method Detail

fromUuidToUlid

fromUlidToUuid

fromUuidToBytes

fromBytesToUuid

fromBytesToUlid

fromUlidToBytes

validate

validate

isValid

isValid

extractTimestamp

extractInstant

extractTimestampComponent

extractRandomnessComponent

extractUnixMilliseconds