Package me.ahoo.cosid.converter

Class SnowflakeFriendlyIdConverter

java.lang.Object
me.ahoo.cosid.converter.SnowflakeFriendlyIdConverter
All Implemented Interfaces:
IdConverter, Statistical
public class SnowflakeFriendlyIdConverter extends Object implements IdConverter
Converts Snowflake IDs to human-readable string format.

Provides friendly string representations of Snowflake IDs with embedded timestamp and machine information.

  • Field Details

    • INSTANCE

      public static final IdConverter INSTANCE
      Shared instance using millisecond parser.

  • Constructor Details

    • SnowflakeFriendlyIdConverter

      public SnowflakeFriendlyIdConverter(SnowflakeIdStateParser snowflakeIdStateParser)
      Creates a converter with the specified parser.
      Parameters:
      snowflakeIdStateParser - the Snowflake ID state parser

  • Method Details

    • getParser

      public SnowflakeIdStateParser getParser()
      Gets the parser.
      Returns:
      the parser

    • asString

      public @NonNull String asString(long id)
      Description copied from interface: IdConverter
      Convert a long type ID to its String representation.

      This method transforms a numeric ID into a string format according to the specific conversion algorithm implemented by the converter. For example, a radix converter might convert the number 12345 to "3d7".

      Specified by:
      asString in interface IdConverter
      Parameters:
      id - The long type ID to convert
      Returns:
      The String representation of the ID

    • asLong

      public long asLong(@NonNull String idString)
      Description copied from interface: IdConverter
      Convert a String type ID back to its long representation.

      This method performs the reverse operation of IdConverter.asString(long), transforming a string ID back into its original numeric form. Implementations should be able to correctly parse strings generated by their IdConverter.asString(long) method.

      Specified by:
      asLong in interface IdConverter
      Parameters:
      idString - The String type ID to convert
      Returns:
      The long representation of the ID

    • stat

      public Stat stat()
      Description copied from interface: IdConverter
      Get statistical information about this converter.

      This method provides basic statistical information about the converter, including its implementation class name.

      Specified by:
      stat in interface IdConverter
      Specified by:
      stat in interface Statistical
      Returns:
      Statistical information about this converter