br.com.brjdevs.java.snowflakes

Annotation Type Snowflake

@Documented
 @Retention(value=RUNTIME)
public @interface Snowflake

Snowflakes is a time-based ID generation, originally created by Twitter.

It's used by Twitter, Discord and other projects as a better reliable way of generating IDs instead of using Serial IDs.

A Snowflake is composed by a Custom-Epoch Timestamp, a Datacenter ID, a Worker ID and a Sequencial ID, being the Snowflakes.TWITTER_FACTORY the reference settings.

This annotation marks a field, method, parameter or anything else as a Snowflake. Can also be used to build Configs using reflections.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
long	epoch Returns the Epoch of the Snowflake

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
long	datacenterIdBits How much of the Snowflake is occupied by the Datacenter ID, in bits.
long	sequenceBits How much of the Snowflake is occupied by the Sequence ID, in bits.
long	workerIdBits How much of the Snowflake is occupied by the Worker ID, in bits.

Element Detail

epoch

public abstract long epoch

Returns the Epoch of the Snowflake

Returns:

the starting epoch

datacenterIdBits

public abstract long datacenterIdBits

How much of the Snowflake is occupied by the Datacenter ID, in bits.

Returns:

a long meaning the size of the Datacenter ID.

Default:

5L

sequenceBits

public abstract long sequenceBits

How much of the Snowflake is occupied by the Sequence ID, in bits.

Returns:

a long meaning the size of the Sequence ID.

Default:

12L

workerIdBits

public abstract long workerIdBits

How much of the Snowflake is occupied by the Worker ID, in bits.

Returns:

a long meaning the size of the Worker ID.

Default:

5L