com.tinkerpop.pipes.sideeffect

Class OptionalPipe<S>

java.lang.Object

com.tinkerpop.pipes.AbstractPipe<S,E>

com.tinkerpop.pipes.util.AbstractMetaPipe<S,S>

com.tinkerpop.pipes.sideeffect.OptionalPipe<S>

All Implemented Interfaces:

Pipe<S,S>, SideEffectPipe<S,Object>, SideEffectPipe.LazySideEffectPipe<S,Object>, MetaPipe, Iterable<S>, Iterator<S>

public class OptionalPipe<S>
extends AbstractMetaPipe<S,S>
implements SideEffectPipe.LazySideEffectPipe<S,Object>, MetaPipe

OptionalPipe will compute the incoming object within the internal pipe. It is similar to BackFilterPipe, except that no filtering occurs. Moreover, it is a SideEffectPipe in that it is only useful for its side-effect (internal pipe) behavior. However, getSideEffect() simply returns null as there is no internal data structure.

Author:

Marko A. Rodriguez (http://markorodriguez.com)

Nested Class Summary

Nested classes/interfaces inherited from interface com.tinkerpop.pipes.sideeffect.SideEffectPipe

SideEffectPipe.GreedySideEffectPipe<S,T>, SideEffectPipe.LazySideEffectPipe<S,T>

Field Summary

Fields inherited from class com.tinkerpop.pipes.AbstractPipe

currentEnd, pathEnabled, starts

Fields inherited from interface com.tinkerpop.pipes.Pipe

NO_PATH_MESSAGE

Constructor Summary

Constructors

Constructor and Description
OptionalPipe(Pipe<S,?> pipe)

Method Summary

Methods

Modifier and Type	Method and Description
List<Pipe>	getPipes()
Object	getSideEffect() The side effect is the behavior of the internal pipe which is not a gettable data structure.
S	processNextStart()
String	toString()

Methods inherited from class com.tinkerpop.pipes.util.AbstractMetaPipe

enablePath, reset

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

getCurrentPath, getPathToHere, hasNext, iterator, next, remove, setStarts, setStarts, setStarts

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tinkerpop.pipes.Pipe

enablePath, getCurrentPath, reset, setStarts, setStarts

Methods inherited from interface java.util.Iterator

hasNext, next, remove

Methods inherited from interface java.lang.Iterable

iterator

Constructor Detail

OptionalPipe

public OptionalPipe(Pipe<S,?> pipe)

Method Detail

processNextStart

public S processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,S>

getSideEffect

public Object getSideEffect()

The side effect is the behavior of the internal pipe which is not a gettable data structure.

Specified by:

getSideEffect in interface SideEffectPipe<S,Object>

Returns:

will return null

toString

public String toString()

Overrides:

toString in class AbstractPipe<S,S>

getPipes

public List<Pipe> getPipes()

Specified by:

getPipes in interface MetaPipe