Module org.refcodes.generator

Package org.refcodes.generator

package org.refcodes.generator

This artifact provides word morphs mass production functionality for generating arbitrary distinct IDs similar to UUIDs (as of the UniqueIdGenerator type) or for generating permutations of words with a given alphabet and permutation rules (as of the AlphabetCounter alongside the AlphabetCounterComposite types) as well as multi threading concurrency support (as of the ConcurrentBufferedGeneratorDecorator and the ThreadLocalBufferedGeneratorDecorator types) for such Generator (Iterator) types.

Please refer to the refcodes-generator: Mass produce password permutations and distinct IDs documentation for an up-to-date and detailed description on the usage of this artifact.

Class	Description
AbstractCounterComposite<T>	The AbstractCounterComposite combines several Counter instances which to use when generating data by daisy chaining the provided generator instances (end of counter 1 increases counter 2, end of counter 2 increases counter 3, ..., end of counter n-1 increases counter n, the end of a counter is determined with AbstractCounterComposite.hasNext() and a counter is increased by Generator.next()).
AlphabetCounter	The AlphabetCounter generates values by counting with an an alphabet of "digits", a decimal alphabet would contain the characters "0", "1", "2", "3", "4", "5", "6", "7", "8" and "9", a hexadecimal alphabet would contain the characters "0", "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B", "C", "D", "E", "F".
AlphabetCounterComposite	The AlphabetCounterComposite creates a IdCounterComposite composed of AlphabetCounter instances which's alphabets are retrieved from expressions each (to be combined to a single IdCounter).
AlphabetCounterMetrics	The AlphabetCounterMetrics define the metrics for configuring an AlphabetCounter such as the characters used as alphabet and the counter's min and max lengths (duplicate definitions of characters are ignored).
BufferedGenerator<T>	Base interface for a Generator using a buffer being filled upon demand or time schedule and which's buffering functionality may be suspended (Suspendable.suspend()) so that the Generator does only emit elements already present in the puffer till all elements in the buffer are expended (and does not place any new elements into the buffer to be emitted).
ConcurrentBufferedGeneratorDecorator<T>	The ConcurrentBufferedGeneratorDecorator decorates a Generator with read-ahead functionality by buffering generated IDs till a predefined maximum is reached and refilling the buffer periodically upon dropping below a threshold.
Counter<T>	A Counter is a Generator with means to reset the Counter state to its initial position (value) from which to begin counting again, e.g. when Generator.hasNext() returns false, then calling Resetable.reset() will make the Counter instance to start again from the very first beginning and Generator.hasNext() will return true until the "end" of the countable elements has been reached (by consuming them with Generator.next()).
Generator<T>	A Generator generates objects of a dedicated type in mass production.
IdCounter	The IdCounter provides means to implement a Counter for Ids of type String.
IdCounterComposite	The IdCounterComposite combines several IdCounter instances which to use when generating data by daisy chaining the provided generator instances (end of counter 1 increases counter 2, end of counter 2 increases counter 3, ..., end of counter n-1 increases counter n, the end of a counter is determined with AbstractCounterComposite.hasNext() and a counter is increased by IdCounterComposite.next()).
IdGenerator	The IdGenerator interface defines generator functionality for String instances.
SeriesMonitor<T>	The SeriesMonitor is a Generator with means to monitor the last fully processed (completed) ID of the series of generated IDs with all preceding generated IDs also being fully processed (completed): All IDs till the last fully processed (completed) ID have been processed.
SeriesMonitorDecorator<T>	The SeriesMonitorDecorator decorates a Generator with means to monitor the last fully processed (completed) ID of the series of generated IDs with all preceding generated IDs also being fully processed (completed): All IDs till the last fully processed (completed) ID have been processed.
ThreadLocalBufferedGeneratorDecorator<T>	The ThreadLocalBufferedGeneratorDecorator decorates a Generator with read-ahead functionality by buffering generated IDs on a per Thread basis: The resulting Generator is thread safe!.
UniqueIdGenerator	The UniqueIdGenerator is an implementation of the Generator capable of generating TID String instances unique on the system on which them were generated to IDs generated with the same UniqueIdGenerator on another system.
UniqueIdGenerator.IdEncoding	Defines the type of BASE-64 encoding to use for generated IDs.
UniqueIdGeneratorSingleton	The Class UniqueIdGeneratorSingleton.