Package me.ahoo.cosid.snowflake

Class SnowflakeIdState

java.lang.Object

me.ahoo.cosid.snowflake.SnowflakeIdState

All Implemented Interfaces:

Comparable<SnowflakeIdState>

@Immutable
public class SnowflakeIdState
extends Object
implements Comparable<SnowflakeIdState>

Immutable state object representing a parsed Snowflake ID.

This class holds the decomposed components of a Snowflake ID: the raw ID, machine ID, sequence number, timestamp, and a human-readable friendly format (timestamp-machineId-sequence).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnowflakeIdState.SnowflakeIdStateBuilder	Builder for SnowflakeIdState.

Method Summary

Modifier and Type	Method	Description
static SnowflakeIdState.SnowflakeIdStateBuilder	builder()	Creates a new builder for SnowflakeIdState.
int	compareTo(SnowflakeIdState other)	Compares this state to another by raw ID value.
boolean	equals(Object other)
@NonNull String	getFriendlyId()	Gets the human-readable form of this ID.
long	getId()	Gets the raw snowflake ID value.
int	getMachineId()	Gets the machine ID component.
long	getSequence()	Gets the sequence number component.
@NonNull LocalDateTime	getTimestamp()	Gets the timestamp when this ID was generated.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SnowflakeIdState.SnowflakeIdStateBuilder builder()

Creates a new builder for SnowflakeIdState.

Returns:

a new builder instance

getId

public long getId()

Gets the raw snowflake ID value.

Returns:

the raw 64-bit ID

getMachineId

public int getMachineId()

Gets the machine ID component.

Returns:

the machine ID

getSequence

public long getSequence()

Gets the sequence number component.

Returns:

the sequence number

getTimestamp

public @NonNull LocalDateTime getTimestamp()

Gets the timestamp when this ID was generated.

Returns:

the timestamp as LocalDateTime

getFriendlyId

public @NonNull String getFriendlyId()

Gets the human-readable form of this ID.

Returns:

friendly ID in format timestamp-machineId-sequence

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(SnowflakeIdState other)

Compares this state to another by raw ID value.

Specified by:

compareTo in interface Comparable<SnowflakeIdState>

Parameters:

other - the other SnowflakeIdState to compare

Returns:

comparison result