org.spf4j.concurrent

Class UIDGenerator

java.lang.Object

org.spf4j.concurrent.UIDGenerator

All Implemented Interfaces:

Supplier<CharSequence>

@ParametersAreNonnullByDefault
public final class UIDGenerator
extends Object
implements Supplier<CharSequence>

Unique ID Generator Based on the assumptions: 1. host MAC address is used. (each network interface has a Unique ID) (encoded with provided encoder) 2. process id is used + current epoch seconds. it is assumed the PID is not recycled within a second. 3. A process sequence is used. UIDs will cycle after Long.MaxValue is reached.

Author:

zoly

Constructor Summary

Constructors

Constructor and Description
UIDGenerator(Sequence sequence)
UIDGenerator(Sequence sequence, com.google.common.io.BaseEncoding baseEncoding, long customEpoch, char separator, String prefix) Construct a UID Generator
UIDGenerator(Sequence sequence, long customEpoch)
UIDGenerator(Sequence sequence, String prefix)
UIDGenerator(Sequence sequence, String prefix, long customEpoch)

Method Summary

Modifier and Type	Method and Description
static StringBuilder	generateIdBase(String prefix, com.google.common.io.BaseEncoding baseEncoding, char separator, long customEpoch)
static StringBuilder	generateIdBase(String prefix, char separator)
static StringBuilder	generateIdBase(String prefix, char separator, long customEpoch)
CharSequence	get()
int	getMaxSize()
CharSequence	next()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UIDGenerator

public UIDGenerator(Sequence sequence)

UIDGenerator

public UIDGenerator(Sequence sequence,
                    String prefix)

UIDGenerator

public UIDGenerator(Sequence sequence,
                    long customEpoch)

UIDGenerator

public UIDGenerator(Sequence sequence,
                    String prefix,
                    long customEpoch)

UIDGenerator

public UIDGenerator(Sequence sequence,
                    com.google.common.io.BaseEncoding baseEncoding,
                    long customEpoch,
                    char separator,
                    String prefix)

Construct a UID Generator

Parameters:

sequence -

baseEncoding - - if null MAC address based ID will not be included.

Method Detail

generateIdBase

public static StringBuilder generateIdBase(String prefix,
                                           char separator)

generateIdBase

public static StringBuilder generateIdBase(String prefix,
                                           char separator,
                                           long customEpoch)

generateIdBase

public static StringBuilder generateIdBase(String prefix,
                                           com.google.common.io.BaseEncoding baseEncoding,
                                           char separator,
                                           long customEpoch)

getMaxSize

public int getMaxSize()

next

public CharSequence next()

toString

public String toString()

Overrides:

toString in class Object

get

public CharSequence get()

Specified by:

get in interface Supplier<CharSequence>