Package me.ahoo.cosid.snowflake

Class ClockSyncSnowflakeId

java.lang.Object
me.ahoo.cosid.snowflake.ClockSyncSnowflakeId
All Implemented Interfaces:
Decorator<IdGenerator>, IdGenerator, IdGeneratorDecorator, SnowflakeId, Statistical, StringIdGenerator
public class ClockSyncSnowflakeId extends Object implements IdGeneratorDecorator, SnowflakeId
Clock Sync SnowflakeId.

  • Constructor Details

  • Method Details

    • getActual

      @Nonnull public SnowflakeId getActual()
      Description copied from interface: IdGeneratorDecorator
      Get the actual (wrapped) ID generator that this decorator is enhancing.

      This method returns the underlying ID generator that this decorator is wrapping. All ID generation requests are typically delegated to this actual generator, with the decorator adding its additional functionality.

      Specified by:
      getActual in interface Decorator<IdGenerator>
      Specified by:
      getActual in interface IdGeneratorDecorator
      Returns:
      The actual ID generator being decorated

    • generate

      public long generate()
      Description copied from interface: IdGeneratorDecorator
      Generate a distributed ID by delegating to the actual generator.

      This default implementation delegates the ID generation to the actual wrapped generator, ensuring that decorators can focus on adding functionality rather than reimplementing basic generation.

      Specified by:
      generate in interface IdGenerator
      Specified by:
      generate in interface IdGeneratorDecorator
      Returns:
      A unique distributed ID as a long value

    • stat

      public IdGeneratorStat stat()
      Description copied from interface: IdGeneratorDecorator
      Get statistical information about this decorated ID generator.

      This method provides combined statistical information from both the decorator itself and the actual generator it wraps, as well as the ID converter being used. This gives a complete picture of the generator's state.

      Specified by:
      stat in interface IdGenerator
      Specified by:
      stat in interface IdGeneratorDecorator
      Specified by:
      stat in interface SnowflakeId
      Specified by:
      stat in interface Statistical
      Returns:
      Statistical information about this decorated ID generator

    • getEpoch

      public long getEpoch()
      Description copied from interface: SnowflakeId
      Get the epoch timestamp used as the base for time calculations.

      This is the timestamp (in milliseconds) that serves as the starting point for the timestamp portion of generated IDs. IDs generated by this instance will have timestamps relative to this epoch.

      Specified by:
      getEpoch in interface SnowflakeId
      Returns:
      The epoch timestamp in milliseconds

    • getTimestampBit

      public int getTimestampBit()
      Description copied from interface: SnowflakeId
      Get the number of bits used for the timestamp portion.

      This determines the range of time that can be represented by the timestamp portion of the ID. More bits allow for a longer time range but leave fewer bits for machine ID and sequence.

      Specified by:
      getTimestampBit in interface SnowflakeId
      Returns:
      The number of timestamp bits

    • getMachineBit

      public int getMachineBit()
      Description copied from interface: SnowflakeId
      Get the number of bits used for the machine ID portion.

      This determines how many unique machines can participate in ID generation. More bits allow for more machines but leave fewer bits for timestamp and sequence.

      Specified by:
      getMachineBit in interface SnowflakeId
      Returns:
      The number of machine ID bits

    • getSequenceBit

      public int getSequenceBit()
      Description copied from interface: SnowflakeId
      Get the number of bits used for the sequence portion.

      This determines how many IDs can be generated per time unit (e.g., per millisecond). More bits allow for higher throughput within a single time unit but leave fewer bits for timestamp and machine ID.

      Specified by:
      getSequenceBit in interface SnowflakeId
      Returns:
      The number of sequence bits

    • isSafeJavascript

      public boolean isSafeJavascript()
      Description copied from interface: SnowflakeId
      Check if this Snowflake ID generator is safe for use in JavaScript.

      JavaScript can only safely represent integers up to 2^53 - 1. This method checks if the total bit size of the ID (timestamp + machine + sequence) is less than or equal to the maximum safe JavaScript number of bits, as defined in SafeJavaScriptSnowflakeId.JAVA_SCRIPT_MAX_SAFE_NUMBER_BIT.

      Specified by:
      isSafeJavascript in interface SnowflakeId
      Returns:
      true if the ID is JavaScript-safe, false otherwise

    • getMaxTimestamp

      public long getMaxTimestamp()
      Description copied from interface: SnowflakeId
      Get the maximum timestamp value that can be represented.

      This is the maximum value that can be stored in the timestamp portion of the ID, which determines how long the generator can be used before exhausting the timestamp space.

      Specified by:
      getMaxTimestamp in interface SnowflakeId
      Returns:
      The maximum timestamp value

    • getMaxMachineId

      public int getMaxMachineId()
      Description copied from interface: SnowflakeId
      Get the maximum machine ID value that can be represented.

      This is the maximum value that can be stored in the machine ID portion of the ID, which determines how many unique machines can participate in ID generation.

      Specified by:
      getMaxMachineId in interface SnowflakeId
      Returns:
      The maximum machine ID value

    • getMaxSequence

      public long getMaxSequence()
      Description copied from interface: SnowflakeId
      Get the maximum sequence value that can be represented.

      This is the maximum value that can be stored in the sequence portion of the ID, which determines how many IDs can be generated per time unit.

      Specified by:
      getMaxSequence in interface SnowflakeId
      Returns:
      The maximum sequence value

    • getLastTimestamp

      public long getLastTimestamp()
      Description copied from interface: SnowflakeId
      Get the timestamp of the last ID that was generated.

      This is used for clock synchronization and to ensure proper ordering of generated IDs. It can also help detect clock drift.

      Specified by:
      getLastTimestamp in interface SnowflakeId
      Returns:
      The timestamp of the last generated ID

    • getMachineId

      public int getMachineId()
      Description copied from interface: SnowflakeId
      Get the machine ID assigned to this generator.

      This is the unique identifier for the machine or instance that is generating IDs, which ensures global uniqueness across the distributed system.

      Specified by:
      getMachineId in interface SnowflakeId
      Returns:
      The machine ID