enumj

Class CachedEnumerableState<E>

java.lang.Object

enumj.CachedEnumerableState<E>

Type Parameters:

E - Type of enumerated elements.

public final class CachedEnumerableState<E>
extends Object

Atomic composite state of CachedEnumerable.

See Also:

CachedEnumerable

Field Summary

Fields

Modifier and Type	Field and Description
CachedEnumerable<E>	cachedSource CachedEnumerable caching the instances of source.
Consumer<CachedEnumerable<E>>	callback Method to call when the cache limit is reached.
long	limit Maximum size of the cache.
Enumerable<E>	source Enumerable instance providing the elements to cache.

Constructor Summary

Constructors

Constructor and Description
CachedEnumerableState(Enumerable<E> source, CachedEnumerable<E> cachedSource, long limit, Consumer<CachedEnumerable<E>> callback) Constructs a CachedEnumerableState containing the given source, cache size and callback.

Method Summary

Modifier and Type	Method and Description
CachedEnumerableState<E>	disable() Gets a new CachedEnumerableState instance identical to the current one with the exception of having caching disabled.
CachedEnumerableState<E>	enable() Gets a new CachedEnumerableState instance identical to the current one with the exception of having caching enabled.
Enumerator<E>	enumerator() Gets an Enumerator instance that enumerates over the cached elements if caching is enabled or over the source Enumerable if caching is disabled.
boolean	isDisabled() Gets whether the caching is disabled.
boolean	onceOnly() Gets whether the source Enumerable is a once only enumerator.
CachedEnumerableState<E>	reset() Gets a new CachedEnumerableState instance identical to the current one with the exception that it is reset.
CachedEnumerableState<E>	resize(long newLimit) Gets a new CachedEnumerableState instance identical to the current one with the exception of a greater limit.

Methods inherited from class java.lang.Object

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

Field Detail

source

public final Enumerable<E> source

Enumerable instance providing the elements to cache.

cachedSource

public final CachedEnumerable<E> cachedSource

CachedEnumerable caching the instances of source.

See Also:

source

limit

public final long limit

Maximum size of the cache.

See Also:

callback

callback

public final Consumer<CachedEnumerable<E>> callback

Method to call when the cache limit is reached.

This method gets cachedSource as a parameter.

See Also:

limit

Constructor Detail

CachedEnumerableState

public CachedEnumerableState(Enumerable<E> source,
                             CachedEnumerable<E> cachedSource,
                             long limit,
                             Consumer<CachedEnumerable<E>> callback)

Constructs a CachedEnumerableState containing the given source, cache size and callback.

This constructor builds a CachedEnumerableState that is enabled by default.

Parameters:

source - Enumerable instance providing the elements to cache.

cachedSource - CachedEnumerable caching the elements of source.

limit - maximum cache size.

callback - method to call when the cache limit is reached.

Method Detail

isDisabled

public boolean isDisabled()

Gets whether the caching is disabled.

Returns:

true if caching is disabled, false otherwise.

See Also:

disable(), enable()

enable

public CachedEnumerableState<E> enable()

Gets a new CachedEnumerableState instance identical to the current one with the exception of having caching enabled.

Returns:

CachedEnumerableState with caching enabled.

See Also:

isDisabled(), disable()

disable

public CachedEnumerableState<E> disable()

Gets a new CachedEnumerableState instance identical to the current one with the exception of having caching disabled.

Returns:

CachedEnumerableState with caching disabled.

See Also:

isDisabled(), enable()

reset

public CachedEnumerableState<E> reset()

Gets a new CachedEnumerableState instance identical to the current one with the exception that it is reset.

Returns:

reset CachedEnumerableState limit.

See Also:

resize(long)

resize

public CachedEnumerableState<E> resize(long newLimit)

Gets a new CachedEnumerableState instance identical to the current one with the exception of a greater limit.

Parameters:

newLimit - value for the cache limit, larger than the current one.

Returns:

resized CachedEnumerableState limit.

Throws:

IllegalArgumentException - newLimit is not larger than the current limit.

See Also:

reset()

onceOnly

public boolean onceOnly()

Gets whether the source Enumerable is a once only enumerator.

Returns:

value of source.onceOnly().

See Also:

Enumerable.onceOnly()

enumerator

public Enumerator<E> enumerator()

Gets an Enumerator instance that enumerates over the cached elements if caching is enabled or over the source Enumerable if caching is disabled.

Returns:

potentially caching Enumerator instance.

See Also:

CacheEnumerator, Enumerable, CachedEnumerable