io.geewit.snowflake.UidGenerator Maven / Gradle / Ivy

Go to download

package io.geewit.snowflake;


import io.geewit.snowflake.exception.UidGenerateException;

/**
 * Represents a unique id generator.
 *
 * @author geewit
 */
public interface UidGenerator {

    /**
     * Get a unique ID
     *
     * @return UID
     * @throws UidGenerateException
     */
    long getUID() throws UidGenerateException;

    /**
     * Parse the UID into elements which are used to generate the UID. 

     * Such as timestamp & workerId & sequence...
     *
     * @param uid
     * @return Parsed info
     */
    String parseUID(long uid);

}