airframe-ulid
API
Generated with
airframe-ulid/wvlet.airframe.ulid/ULID

ULID

wvlet.airframe.ulid.ULID
See theULID companion object
final class ULID(ulid: String) extends Ordered[ULID]

ULID string, consisting of 26 characters.

Attributes

Companion
object
Graph
Supertypes
trait Ordered[ULID]
trait Comparable[ULID]
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def compare(that: ULID): Int

Attributes

Definition Classes
Ordered
override def equals(other: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
def randomness: (Long, Long)

Return 80-bits randomness value of this ULID using a pair of (Long (16-bit), Long (64-bit))

Return 80-bits randomness value of this ULID using a pair of (Long (16-bit), Long (64-bit))

Attributes

def timestamp: Long

Return 48-bit UNIX-time of this ULID in milliseconds

Return 48-bit UNIX-time of this ULID in milliseconds

Attributes

def toBytes: Array[Byte]

Get a 128-bit (16 byte) binary representation of this ULID.

Get a 128-bit (16 byte) binary representation of this ULID.

Attributes

def toInstant: Instant
override def toString: String

Return the string representation of this ULID

Return the string representation of this ULID

Attributes

Definition Classes
Any
def toUUID: UUID

Convert this ULID to java.util.UUID

Convert this ULID to java.util.UUID

Attributes

Inherited methods

def <(that: ULID): Boolean

Attributes

Inherited from:
Ordered
def <=(that: ULID): Boolean

Attributes

Inherited from:
Ordered
def >(that: ULID): Boolean

Attributes

Inherited from:
Ordered
def >=(that: ULID): Boolean

Attributes

Inherited from:
Ordered
def compareTo(that: ULID): Int

Attributes

Inherited from:
Ordered

Concrete fields

lazy val epochMillis: Long

Get the epoch milliseconds (milliseconds from 1970-01-01 UTC) of this ULID.

Get the epoch milliseconds (milliseconds from 1970-01-01 UTC) of this ULID.

Attributes

Generated with