Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AbstractCounterComposite<T> - Class in org.refcodes.generator
-
The
AbstractCounterComposite
combines severalCounter
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 withAbstractCounterComposite.hasNext()
and a counter is increased bynext()
). - AbstractCounterComposite(Counter<T>...) - Constructor for class org.refcodes.generator.AbstractCounterComposite
-
Constructs a
AbstractCounterComposite
daisy chaining the providedCounter
instances. - actualCounters() - Method in class org.refcodes.generator.AbstractCounterComposite
-
Returns the current actual counters' state (an individual value for each counter in the returned array as of the order the counters have been added).
- AlphabetCounter - Class in org.refcodes.generator
-
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". - AlphabetCounter(char...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(int, char...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(int, int, char...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(int, int, Collection<Character>) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(int, int, CharSet) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(int, Collection<Character>) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(int, CharSet) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(File...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given wordsFile
elements to provide one by one (one word per line) contained in each file subsequently till all words have been processed, therewith representing the alphabet counter through which to iterate. - AlphabetCounter(InputStream...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given wordsInputStream
elements to provide one by one (one word per line) contained in each file subsequently till all words have been processed, therewith representing the alphabet counter through which to iterate. - AlphabetCounter(String) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
by parsing the given expression to construct the alphabet from the according expression's attributes. - AlphabetCounter(String...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given words which to provide one by one after all words have been processed.. - AlphabetCounter(String, char...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(String, int, char...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(String, int, int, char...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(String, int, int, Collection<Character>) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(String, int, int, CharSet) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(String, File...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given wordsFile
elements to provide one by one (one word per line) contained in each file subsequently till all words have been processed, therewith representing the alphabet counter through which to iterate. - AlphabetCounter(String, InputStream...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given wordsInputStream
elements to provide one by one (one word per line) contained in each file subsequently till all words have been processed, therewith representing the alphabet counter through which to iterate. - AlphabetCounter(String, String...) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given words which to provide one by one after all words have been processed.. - AlphabetCounter(String, Collection<Character>) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(String, Collection<Character>, int) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(String, CharSet) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(String, CharSet, int) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(Collection<Character>) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(CharSet) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the given attributes. - AlphabetCounter(AlphabetCounterMetrics) - Constructor for class org.refcodes.generator.AlphabetCounter
-
Constructs an
AlphabetCounter
using the givenAlphabetCounterMetrics
. - AlphabetCounterComposite - Class in org.refcodes.generator
-
The
AlphabetCounterComposite
creates aIdCounterComposite
composed ofAlphabetCounter
instances which's alphabets are retrieved from expressions each (to be combined to a singleIdCounter
). - AlphabetCounterComposite(String...) - Constructor for class org.refcodes.generator.AlphabetCounterComposite
-
Constructs the
AlphabetCounterComposite
by evaluating the provided expressions and creating the accordingAlphabetCounter
instances. - AlphabetCounterComposite(AlphabetCounter...) - Constructor for class org.refcodes.generator.AlphabetCounterComposite
-
Constructs the
AlphabetCounterComposite
from the providedAlphabetCounter
instances. - AlphabetCounterComposite(AlphabetCounterMetrics...) - Constructor for class org.refcodes.generator.AlphabetCounterComposite
-
Constructs the
AlphabetCounterComposite
from the providedAlphabetCounterMetrics
definitions. - AlphabetCounterMetrics - Class in org.refcodes.generator
-
The
AlphabetCounterMetrics
define the metrics for configuring anAlphabetCounter
such as the characters used as alphabet and the counter's min and max lengths (duplicate definitions of characters are ignored). - AlphabetCounterMetrics() - Constructor for class org.refcodes.generator.AlphabetCounterMetrics
-
Instantiates a new alphabet counter metrics.
- AlphabetCounterMetrics(int, int, char...) - Constructor for class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an
AlphabetCounterMetrics
using the given attributes. - AlphabetCounterMetrics(File...) - Constructor for class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an
AlphabetCounterMetrics
using the given wordsFile
elements to provide one by one (one word per line) contained in each file subsequently till all words have been processed, therewith representing the alphabet counter through which to iterate. - AlphabetCounterMetrics(String) - Constructor for class org.refcodes.generator.AlphabetCounterMetrics
-
Parses the given expression to construct the
AlphabetCounterMetrics
from the according expression's attributes. - AlphabetCounterMetrics(String...) - Constructor for class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an
AlphabetCounterMetrics
using the given words to provide one by one till all words have been processed, therewith representing the alphabet counter through which to iterate. - AlphabetCounterMetrics(String, int, int, char...) - Constructor for class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an
AlphabetCounterMetrics
using the given attributes. - AlphabetCounterMetrics(String, File...) - Constructor for class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an
AlphabetCounterMetrics
using the given wordsFile
elements to provide one by one (one word per line) contained in each file subsequently till all words have been processed, therewith representing the alphabet counter through which to iterate. - AlphabetCounterMetrics(String, String[]) - Constructor for class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an
AlphabetCounterMetrics
using the given words to provide one by one till all words have been processed, therewith representing the alphabet counter through which to iterate.
B
- BASE64 - Enum constant in enum class org.refcodes.generator.UniqueIdGenerator.IdEncoding
-
Normal BASE-64 alike encoding (padding chars are omitted).
- BASE64_URL - Enum constant in enum class org.refcodes.generator.UniqueIdGenerator.IdEncoding
-
BASE64 URL alike encoding (padding chars are omitted) enabling the use of the IDs in an URL.
- BufferedGenerator<T> - Interface in org.refcodes.generator
-
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 theGenerator
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).
C
- clear() - Method in class org.refcodes.generator.SeriesMonitorDecorator
-
Clears the list of unprocessed IDs.
- ConcurrentBufferedGeneratorDecorator<T> - Class in org.refcodes.generator
-
The
ConcurrentBufferedGeneratorDecorator
decorates aGenerator
with read-ahead functionality by buffering generated IDs till a predefined maximum is reached and refilling the buffer periodically upon dropping below a threshold. - ConcurrentBufferedGeneratorDecorator(Iterator<T>) - Constructor for class org.refcodes.generator.ConcurrentBufferedGeneratorDecorator
-
Constructs the
ConcurrentBufferedGeneratorDecorator
decorating the providedGenerator
using theConcurrentBufferedGeneratorDecorator.DEFAULT_MAX_BUFFER_SIZE
for the per thread read-ahead buffer. - ConcurrentBufferedGeneratorDecorator(Iterator<T>, int, int, long, boolean, boolean) - Constructor for class org.refcodes.generator.ConcurrentBufferedGeneratorDecorator
-
Constructs the
ConcurrentBufferedGeneratorDecorator
decorating the providedGenerator
with the provided properties. - Counter<T> - Interface in org.refcodes.generator
-
A
Counter
is aGenerator
with means to reset theCounter
state to its initial position (value) from which to begin counting again, e.g. whenhasNext()
returns false, then callingResetable.reset()
will make theCounter
instance to start again from the very first beginning andhasNext()
will return true until the "end" of the countable elements has been reached (by consuming them withnext()
).
D
- DEFAULT_BUFFER_SIZE - Static variable in class org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator
- dispose() - Method in class org.refcodes.generator.ConcurrentBufferedGeneratorDecorator
- dispose() - Method in class org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator
F
- forEachRemaining(Consumer<? super T>) - Method in class org.refcodes.generator.SeriesMonitorDecorator
G
- Generator<T> - Interface in org.refcodes.generator
-
A
Generator
generates objects of a dedicated type in mass production. - getAlphabet() - Method in class org.refcodes.generator.AlphabetCounter
-
Returns the alphabet used by this counter.
- getAlphabet() - Method in class org.refcodes.generator.AlphabetCounterMetrics
-
Returns the alphabet to be used by the
AlphabetCounter
. - getChildren() - Method in class org.refcodes.generator.AbstractCounterComposite
- getChildren() - Method in class org.refcodes.generator.AlphabetCounterComposite
- getDecoratee() - Method in class org.refcodes.generator.ConcurrentBufferedGeneratorDecorator
- getDecoratee() - Method in class org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator
- getInstance() - Static method in class org.refcodes.generator.UniqueIdGeneratorSingleton
-
Retrieves the
UniqueIdGeneratorSingleton
. - getMaxLength() - Method in class org.refcodes.generator.AlphabetCounterMetrics
-
Returns the counter's max length, a value of -1 denotes an infinite length.
- getMinLength() - Method in class org.refcodes.generator.AlphabetCounterMetrics
-
Returns the counter's min length.
- getStartValue() - Method in class org.refcodes.generator.AlphabetCounterMetrics
-
Returns the counter's start value.
- getWords() - Method in class org.refcodes.generator.AlphabetCounterMetrics
-
Returns the words to be used by the
AlphabetCounter
. - getWordsFiles() - Method in class org.refcodes.generator.AlphabetCounterMetrics
-
Retrieves the words
File
lists referenced by theseAlphabetCounterMetrics
. - getWordsStreams() - Method in class org.refcodes.generator.AlphabetCounterMetrics
-
Retrieves the words
InputStream
lists referenced by theseAlphabetCounterMetrics
.
H
- hasNext() - Method in class org.refcodes.generator.AbstractCounterComposite
- hasNext() - Method in class org.refcodes.generator.AlphabetCounter
- hasNext() - Method in class org.refcodes.generator.ConcurrentBufferedGeneratorDecorator
- hasNext() - Method in interface org.refcodes.generator.Generator
- hasNext() - Method in class org.refcodes.generator.SeriesMonitorDecorator
- hasNext() - Method in class org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator
- hasNext() - Method in class org.refcodes.generator.UniqueIdGenerator
I
- IdCounter - Interface in org.refcodes.generator
- IdCounterComposite - Class in org.refcodes.generator
-
The
IdCounterComposite
combines severalIdCounter
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 withAbstractCounterComposite.hasNext()
and a counter is increased byIdCounterComposite.next()
). - IdCounterComposite(IdCounter...) - Constructor for class org.refcodes.generator.IdCounterComposite
-
Constructs a
IdCounterComposite
daisy chaining the providedIdCounter
instances. - IdGenerator - Interface in org.refcodes.generator
-
The
IdGenerator
interface defines generator functionality forString
instances. - initSeed() - Static method in class org.refcodes.generator.UniqueIdGenerator
-
This method initializes the TID generator, it is invoked upon loading the utility class by the class loader (static block), though it may be called manually in case of TID collisions.
L
- lastProcessed() - Method in interface org.refcodes.generator.SeriesMonitor
-
Returns the last ID of fully processed IDs in the series of generated IDs.
- lastProcessed() - Method in class org.refcodes.generator.SeriesMonitorDecorator
-
Returns the last ID of fully processed IDs in the series of generated IDs.
M
- markAsProcessed(T) - Method in interface org.refcodes.generator.SeriesMonitor
-
Marks a ID previously generated using
next()
as being processed, the last ID of fully processed IDs in the series of generated IDs can be identified using theSeriesMonitor.lastProcessed()
method. - markAsProcessed(T) - Method in class org.refcodes.generator.SeriesMonitorDecorator
-
Marks a ID previously generated using
next()
as being processed, the last ID of fully processed IDs in the series of generated IDs can be identified using theSeriesMonitor.lastProcessed()
method.
N
- next() - Method in class org.refcodes.generator.AlphabetCounter
-
Generates a next item.
- next() - Method in class org.refcodes.generator.ConcurrentBufferedGeneratorDecorator
-
Generates a next item.
- next() - Method in interface org.refcodes.generator.Generator
-
Generates a next item.
- next() - Method in class org.refcodes.generator.IdCounterComposite
-
Generates a next item.
- next() - Method in class org.refcodes.generator.SeriesMonitorDecorator
-
Generates a next item.
- next() - Method in class org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator
-
Generates a next item.
- next() - Method in class org.refcodes.generator.UniqueIdGenerator
-
Generates a next item.
- nextCounters() - Method in class org.refcodes.generator.AbstractCounterComposite
-
Returns the
next()
value as of the individual underlyingAlphabetCounter
instances (an individual value for each counter in the returned array as of the order the counters have been added). - nextCounters() - Method in class org.refcodes.generator.AlphabetCounterComposite
-
Returns the
IdCounterComposite.next()
value as of the individual underlyingAlphabetCounter
instances.
O
- org.refcodes.generator - module org.refcodes.generator
- 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 theAlphabetCounter
alongside theAlphabetCounterComposite
types) as well as multi threading concurrency support (as of theConcurrentBufferedGeneratorDecorator
and theThreadLocalBufferedGeneratorDecorator
types) for suchGenerator
(Iterator
) types.
P
- parseAlphabetExpression(String) - Method in class org.refcodes.generator.AlphabetCounterMetrics
-
Parses the provided alphabet expression and sets the properties of this
AlphabetCounterMetrics
instance accordingly.
R
- remove() - Method in class org.refcodes.generator.SeriesMonitorDecorator
- remove() - Method in class org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator
- remove() - Method in class org.refcodes.generator.UniqueIdGenerator
- reset() - Method in class org.refcodes.generator.AbstractCounterComposite
- reset() - Method in class org.refcodes.generator.AlphabetCounter
S
- SeriesMonitor<T> - Interface in org.refcodes.generator
-
The
SeriesMonitor
is aGenerator
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> - Class in org.refcodes.generator
-
The
SeriesMonitorDecorator
decorates aGenerator
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(Generator<T>) - Constructor for class org.refcodes.generator.SeriesMonitorDecorator
-
Constructs the
SeriesMonitorDecorator
decorating the providedGenerator
. - suspend() - Method in class org.refcodes.generator.ConcurrentBufferedGeneratorDecorator
- suspend() - Method in class org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator
T
- ThreadLocalBufferedGeneratorDecorator<T> - Class in org.refcodes.generator
-
The
ThreadLocalBufferedGeneratorDecorator
decorates aGenerator
with read-ahead functionality by buffering generated IDs on a perThread
basis: The resultingGenerator
is thread safe!. - ThreadLocalBufferedGeneratorDecorator(Iterator<T>) - Constructor for class org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator
-
Constructs the
ThreadLocalBufferedGeneratorDecorator
decorating the providedGenerator
using theThreadLocalBufferedGeneratorDecorator.DEFAULT_BUFFER_SIZE
for the per thread read-ahead buffer. - ThreadLocalBufferedGeneratorDecorator(Iterator<T>, int) - Constructor for class org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator
-
Constructs the
ThreadLocalBufferedGeneratorDecorator
decorating the providedGenerator
. - toAlphabetExpression() - Method in class org.refcodes.generator.AlphabetCounter
-
Provides the alphabet expressions as of the state of this
AlphabetCounter
instance. - toAlphabetExpression() - Method in class org.refcodes.generator.AlphabetCounterMetrics
-
Provides the alphabet expression represented by the
AlphabetCounterMetrics
. - toAlphabetExpression(String, int, int, char...) - Static method in class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an alphabet expression from the provided metrics.
- toAlphabetExpression(String, File[]) - Static method in class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an alphabet expression from the provided files.
- toAlphabetExpression(String, InputStream[]) - Static method in class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an alphabet expression from the provided files.
- toAlphabetExpression(String, String[]) - Static method in class org.refcodes.generator.AlphabetCounterMetrics
-
Constructs an alphabet expression from the provided words.
- toAlphabetExpressions() - Method in class org.refcodes.generator.AlphabetCounterComposite
-
Provides the alphabet expressions as of the state of the nested
AlphabetCounter
instances. - toString() - Method in class org.refcodes.generator.AlphabetCounter
- toString() - Method in class org.refcodes.generator.AlphabetCounterComposite
- toString() - Method in class org.refcodes.generator.AlphabetCounterMetrics
U
- UniqueIdGenerator - Class in org.refcodes.generator
-
The
UniqueIdGenerator
is an implementation of theGenerator
capable of generating TIDString
instances unique on the system on which them were generated to IDs generated with the sameUniqueIdGenerator
on another system. - UniqueIdGenerator() - Constructor for class org.refcodes.generator.UniqueIdGenerator
-
Constructs a
UniqueIdGenerator
with a default TID length of 36. - UniqueIdGenerator(int) - Constructor for class org.refcodes.generator.UniqueIdGenerator
-
Constructs a
UniqueIdGenerator
with the provided TID length. - UniqueIdGenerator(int, UniqueIdGenerator.IdEncoding) - Constructor for class org.refcodes.generator.UniqueIdGenerator
-
Constructs a
UniqueIdGenerator
with the provided TID length. - UniqueIdGenerator(UniqueIdGenerator.IdEncoding) - Constructor for class org.refcodes.generator.UniqueIdGenerator
-
Constructs a
UniqueIdGenerator
with a default TID length of 36. - UniqueIdGenerator.IdEncoding - Enum Class in org.refcodes.generator
-
Defines the type of BASE-64 encoding to use for generated IDs.
- UniqueIdGeneratorSingleton - Class in org.refcodes.generator
-
The Class UniqueIdGeneratorSingleton.
V
- valueOf(String) - Static method in enum class org.refcodes.generator.UniqueIdGenerator.IdEncoding
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.refcodes.generator.UniqueIdGenerator.IdEncoding
-
Returns an array containing the constants of this enum class, in the order they are declared.
_
- _alphabet - Variable in class org.refcodes.generator.AlphabetCounterMetrics
- _alphabetExpression - Variable in class org.refcodes.generator.AlphabetCounterMetrics
- _maxLength - Variable in class org.refcodes.generator.AlphabetCounterMetrics
- _minLength - Variable in class org.refcodes.generator.AlphabetCounterMetrics
- _startValue - Variable in class org.refcodes.generator.AlphabetCounterMetrics
- _words - Variable in class org.refcodes.generator.AlphabetCounterMetrics
- _wordsFiles - Variable in class org.refcodes.generator.AlphabetCounterMetrics
- _wordsStreams - Variable in class org.refcodes.generator.AlphabetCounterMetrics
All Classes and Interfaces|All Packages|Constant Field Values