Package com.fayupable.snowflake.config

Record Class SnowflakeConfig

java.lang.Object
java.lang.Record
com.fayupable.snowflake.config.SnowflakeConfig
public record SnowflakeConfig(long epoch, long nodeId, int timestampBits, int nodeBits, int sequenceBits) extends Record
Configuration for the Snowflake id layout. Bit layout (MSB to LSB): 1 unused sign bit | timestampBits | nodeBits | sequenceBits. Default: 41-bit timestamp (~69 years from epoch), 10-bit node (up to 1024 nodes), 12-bit sequence (up to 4096 ids per millisecond per node).

  • Constructor Summary

    Constructors
    Constructor
    Description
    SnowflakeConfig(long epoch, long nodeId, int timestampBits, int nodeBits, int sequenceBits)
    Creates an instance of a SnowflakeConfig record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static SnowflakeConfig
    defaultConfig(long epoch, long nodeId)
     
    long
    epoch()
    Returns the value of the epoch record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    maxSequence()
     
    int
    nodeBits()
    Returns the value of the nodeBits record component.
    long
    nodeId()
    Returns the value of the nodeId record component.
    int
    nodeShift()
     
    int
    sequenceBits()
    Returns the value of the sequenceBits record component.
    int
    timestampBits()
    Returns the value of the timestampBits record component.
    int
    timestampShift()
     
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SnowflakeConfig

      public SnowflakeConfig(long epoch, long nodeId, int timestampBits, int nodeBits, int sequenceBits)
      Creates an instance of a SnowflakeConfig record class.
      Parameters:
      epoch - the value for the epoch record component
      nodeId - the value for the nodeId record component
      timestampBits - the value for the timestampBits record component
      nodeBits - the value for the nodeBits record component
      sequenceBits - the value for the sequenceBits record component

  • Method Details

    • defaultConfig

      public static SnowflakeConfig defaultConfig(long epoch, long nodeId)

    • maxSequence

      public long maxSequence()

    • nodeShift

      public int nodeShift()

    • timestampShift

      public int timestampShift()

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • epoch

      public long epoch()
      Returns the value of the epoch record component.
      Returns:
      the value of the epoch record component

    • nodeId

      public long nodeId()
      Returns the value of the nodeId record component.
      Returns:
      the value of the nodeId record component

    • timestampBits

      public int timestampBits()
      Returns the value of the timestampBits record component.
      Returns:
      the value of the timestampBits record component

    • nodeBits

      public int nodeBits()
      Returns the value of the nodeBits record component.
      Returns:
      the value of the nodeBits record component

    • sequenceBits

      public int sequenceBits()
      Returns the value of the sequenceBits record component.
      Returns:
      the value of the sequenceBits record component