org.refcodes.generator.impls

Class UniqueIdGeneratorImpl

java.lang.Object

org.refcodes.generator.impls.UniqueIdGeneratorImpl

All Implemented Interfaces:

Iterator<String>, Generator<String>, IdGenerator

Direct Known Subclasses:

UniqueIdGeneratorSingleton

public class UniqueIdGeneratorImpl
extends Object
implements IdGenerator

The UniqueIdGeneratorImpl is an implementation of the Generator capable of generating ID String instances unique on the system on which them were generated to IDs generated with the same UniqueIdGeneratorImpl on another system.

Constructor Summary

Constructors

Constructor and Description
UniqueIdGeneratorImpl() Constructs a UniqueIdGeneratorImpl with a default number Base#BASE_64 to be used for the ID and the given ID length of 36.
UniqueIdGeneratorImpl(int aIdLength) Constructs a UniqueIdGeneratorImpl with a default number Base#BASE_64 to be used for the ID and the provided ID length.

Method Summary

Modifier and Type	Method and Description
boolean	hasNext() Tests whether the Generator is capable of generating a Generator.next() item.
static void	initSeed() This method initializes the ID generator, it is invoked upon loading the utility class by the class loader (static block), though it may be called manually in case of ID collisions.
String	next() Generates a next item.
void	remove()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Detail

UniqueIdGeneratorImpl

public UniqueIdGeneratorImpl()

Constructs a UniqueIdGeneratorImpl with a default number Base#BASE_64 to be used for the ID and the given ID length of 36.

UniqueIdGeneratorImpl

public UniqueIdGeneratorImpl(int aIdLength)

Constructs a UniqueIdGeneratorImpl with a default number Base#BASE_64 to be used for the ID and the provided ID length.

Parameters:

aIdLength - The length for the generated IDs.

Method Detail

initSeed

public static void initSeed()

This method initializes the ID generator, it is invoked upon loading the utility class by the class loader (static block), though it may be called manually in case of ID collisions. Then a new random number as starting point for a specific part of the ID and the IP address are newly set.

hasNext

public boolean hasNext()

Description copied from interface: Generator

Tests whether the Generator is capable of generating a Generator.next() item.

Specified by:

hasNext in interface Iterator<String>

Specified by:

hasNext in interface Generator<String>

next

public String next()

Description copied from interface: Generator

Generates a next item.

Specified by:

next in interface Iterator<String>

Specified by:

next in interface Generator<String>

Returns:

The next item generated

remove

public void remove()

Specified by:

remove in interface Iterator<String>