enumj

Class SkipPipeProcessor<E>

java.lang.Object

enumj.AbstractPipeProcessor<E,E>

enumj.SkipPipeProcessor<E>

Type Parameters:

E - type of enumerated elements.

final class SkipPipeProcessor<E>
extends AbstractPipeProcessor<E,E>

Pipe processor that skips over a number of elements.

See Also:

SkipWhilePipeProcessor, WhilePipeProcessor

Field Summary

Fields inherited from class enumj.AbstractPipeProcessor

hasNextNeedsValue, nextOnSameSourceOnNoValue

Constructor Summary

Constructors

Constructor and Description
SkipPipeProcessor(long n) Constructs a SkipPipeProcessor that skips over n elements.

Method Summary

Modifier and Type	Method and Description
protected void	clearOutputValue() Clears the processed result after being returned by AbstractPipeProcessor.retrieveOutputValue().
boolean	hasOutputValue() Gets whether processing was successful and the processor has a value to yield.
boolean	isInactive() Gets whether the processor does not process any more and the pipeline up to it should be discarded.
void	processInputValue(E value) Processes an input value in order to return a result, if any.
protected E	retrieveOutputValue() Retrieves the processed result produced by AbstractPipeProcessor.processInputValue(Object).

Methods inherited from class enumj.AbstractPipeProcessor

enqueueFilter, enqueueMap, getNext, getOutputValue, getSource, pushFrontFilter, pushFrontMap, setNext, setSource

Methods inherited from class java.lang.Object

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

Constructor Detail

SkipPipeProcessor

public SkipPipeProcessor(long n)

Constructs a SkipPipeProcessor that skips over n elements.

The new SkipPipeProcessor stores its limit internally.

Parameters:

n - number of elements to skip.

Method Detail

processInputValue

public void processInputValue(E value)

Description copied from class: AbstractPipeProcessor

Processes an input value in order to return a result, if any.

The result of processing must be stored internally.

Specified by:

processInputValue in class AbstractPipeProcessor<E,E>

Parameters:

value - Value to process.

See Also:

AbstractPipeProcessor.hasOutputValue(), AbstractPipeProcessor.getOutputValue()

hasOutputValue

public boolean hasOutputValue()

Description copied from class: AbstractPipeProcessor

Gets whether processing was successful and the processor has a value to yield.

If AbstractPipeProcessor.hasOutputValue() returns false than no internal storage of input or output may take place.

Specified by:

hasOutputValue in class AbstractPipeProcessor<E,E>

Returns:

true if there is an output value to yield, false otherwise.

See Also:

AbstractPipeProcessor.processInputValue(java.lang.Object), AbstractPipeProcessor.getOutputValue()

retrieveOutputValue

protected E retrieveOutputValue()

Description copied from class: AbstractPipeProcessor

Retrieves the processed result produced by AbstractPipeProcessor.processInputValue(Object).

Specified by:

retrieveOutputValue in class AbstractPipeProcessor<E,E>

Returns:

Processed result.

See Also:

AbstractPipeProcessor.getOutputValue(), AbstractPipeProcessor.clearOutputValue()

clearOutputValue

protected void clearOutputValue()

Description copied from class: AbstractPipeProcessor

Clears the processed result after being returned by AbstractPipeProcessor.retrieveOutputValue().

Specified by:

clearOutputValue in class AbstractPipeProcessor<E,E>

See Also:

AbstractPipeProcessor.getOutputValue(), AbstractPipeProcessor.retrieveOutputValue()

isInactive

public boolean isInactive()

Description copied from class: AbstractPipeProcessor

Gets whether the processor does not process any more and the pipeline up to it should be discarded.

AbstractPipeProcessor.isInactive() returning true is equivalent to the situation when no matter with what value AbstractPipeProcessor.processInputValue(Object) will be called, AbstractPipeProcessor.hasOutputValue() will always return false.

Most processors have this function return false with the exception of while and limit compositions. These will turn completely inactive once a certain condition is met.

Specified by:

isInactive in class AbstractPipeProcessor<E,E>

Returns:

true if processing must stop, false otherwise.