Module org.refcodes.generator

Package org.refcodes.generator

Class ThreadLocalBufferedGeneratorDecorator<T>

java.lang.Object

org.refcodes.generator.ThreadLocalBufferedGeneratorDecorator<T>

Type Parameters:

T - the generic type of the elements being generated.

All Implemented Interfaces:

Iterator<T>, BufferedGenerator<T>, Generator<T>, org.refcodes.mixin.DecorateeAccessor<Iterator<T>>, org.refcodes.mixin.Disposable, org.refcodes.mixin.Suspendable

public class ThreadLocalBufferedGeneratorDecorator<T>
extends Object
implements BufferedGenerator<T>, org.refcodes.mixin.DecorateeAccessor<Iterator<T>>, org.refcodes.mixin.Disposable

The ThreadLocalBufferedGeneratorDecorator decorates a Generator with read-ahead functionality by buffering generated IDs on a per Thread basis: The resulting Generator is thread safe!.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.mixin.DecorateeAccessor

org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE extends Object,B extends org.refcodes.mixin.DecorateeAccessor.DecorateeBuilder<DECORATEE,B>>, org.refcodes.mixin.DecorateeAccessor.DecorateeMutator<DECORATEE extends Object>, org.refcodes.mixin.DecorateeAccessor.DecorateeProperty<DECORATEE extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor	Description
ThreadLocalBufferedGeneratorDecorator(Iterator<T> aDecoratee)	Constructs the ThreadLocalBufferedGeneratorDecorator decorating the provided Generator using the DEFAULT_BUFFER_SIZE for the per thread read-ahead buffer.
ThreadLocalBufferedGeneratorDecorator(Iterator<T> aDecoratee, int aBufferSize)	Constructs the ThreadLocalBufferedGeneratorDecorator decorating the provided Generator.

Method Summary

Modifier and Type	Method	Description
void	dispose()
Iterator<T>	getDecoratee()
boolean	hasNext()	Tests whether the Generator is capable of generating a Generator.next() item.
T	next()	Generates a next item.
void	remove()
void	suspend()

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

Field Details

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

• Constant Field Values

Constructor Details

ThreadLocalBufferedGeneratorDecorator

public ThreadLocalBufferedGeneratorDecorator(Iterator<T> aDecoratee)

Constructs the ThreadLocalBufferedGeneratorDecorator decorating the provided Generator using the DEFAULT_BUFFER_SIZE for the per thread read-ahead buffer.

Parameters:

aDecoratee - The Generator to be decorated.

ThreadLocalBufferedGeneratorDecorator

public ThreadLocalBufferedGeneratorDecorator(Iterator<T> aDecoratee,
 int aBufferSize)

Constructs the ThreadLocalBufferedGeneratorDecorator decorating the provided Generator.

Parameters:

aDecoratee - The Generator to be decorated.

aBufferSize - The size of the read-ahead buffer

Method Details

hasNext

public boolean hasNext()

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

Specified by:

hasNext in interface Generator<T>

Specified by:

hasNext in interface Iterator<T>

Returns:

true, if successful

next

public T next()

Generates a next item.

Specified by:

next in interface Generator<T>

Specified by:

next in interface Iterator<T>

Returns:

The next item generated

remove

public void remove()

Specified by:

remove in interface Iterator<T>

suspend

public void suspend()

Specified by:

suspend in interface org.refcodes.mixin.Suspendable

getDecoratee

public Iterator<T> getDecoratee()

Specified by:

getDecoratee in interface org.refcodes.mixin.DecorateeAccessor<T>

dispose

public void dispose()

Specified by:

dispose in interface org.refcodes.mixin.Disposable