enumj

Class FlatMapPipeProcessor<In,Out>

java.lang.Object

enumj.AbstractPipeProcessor<T,R>

enumj.AbstractPipeMultiProcessor<In,Out>

enumj.FlatMapPipeProcessor<In,Out>

Type Parameters:

In - input value mapped to an Iterator.

Out - output value from the generated sub-iterator.

final class FlatMapPipeProcessor<In,Out>
extends AbstractPipeMultiProcessor<In,Out>

Pipe processor that flattens sub-iterators generated by mapping enumerated elements.

See Also:

MapPipeProcessor, ZipPipeProcessor

Field Summary

Fields inherited from class enumj.AbstractPipeProcessor

hasNextNeedsValue, nextOnSameSourceOnNoValue

Constructor Summary

Constructors

Constructor and Description
FlatMapPipeProcessor(Function<In,Iterator<Out>> mapper) Constructs a FlatMapPipeProcessor instances.

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.
boolean	needsValue() Gets whether the processor needs a fresh input value to produce output values.
void	processInputValue(In value) Processes an input value in order to return a result, if any.
protected Out	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

FlatMapPipeProcessor

public FlatMapPipeProcessor(Function<In,Iterator<Out>> mapper)

Constructs a FlatMapPipeProcessor instances.

The new FlatMapPipeProcessor stores its mapper internally.

Parameters:

mapper - Function instance mapping input elements to sub-iterators.

Method Detail

needsValue

public boolean needsValue()

Description copied from class: AbstractPipeMultiProcessor

Gets whether the processor needs a fresh input value to produce output values.

Unlike AbstractPipeProcessor, this type of processor may yield more than one output for a single input. This means feeding in input values must be put on hold as long as the current processor still has output values to provide. This state ends when needsValue returns true.

Specified by:

needsValue in class AbstractPipeMultiProcessor<In,Out>

Returns:

true if the processor needs a new input to produce outputs, false otherwise.

See Also:

AbstractPipeProcessor

processInputValue

public void processInputValue(In 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<In,Out>

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<In,Out>

Returns:

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

See Also:

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

retrieveOutputValue

protected Out retrieveOutputValue()

Description copied from class: AbstractPipeProcessor

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

Specified by:

retrieveOutputValue in class AbstractPipeProcessor<In,Out>

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<In,Out>

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<In,Out>

Returns:

true if processing must stop, false otherwise.