com.tinkerpop.pipes.branch

Class IfThenElsePipe<S,E>

java.lang.Object

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

com.tinkerpop.pipes.branch.IfThenElsePipe<S,E>

All Implemented Interfaces:

Pipe<S,E>, Iterable<E>, Iterator<E>

public class IfThenElsePipe<S,E>
extends AbstractPipe<S,E>

IfThenElsePipe will run each incoming S through the provided ifFunction. If the ifFunction returns true, then the S object is passed through the thenFunction. Otherwise, the S object is passed through the elseFunction. If the result of the thenFunction and the elseFunction is an iterable/iterator, it is unrolled.

Author:

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

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
IfThenElsePipe(PipeFunction<S,Boolean> ifFunction, PipeFunction<S,?> thenFunction, PipeFunction<S,?> elseFunction)

Method Summary

Methods

Modifier and Type	Method and Description
E	processNextStart()
void	reset() A pipe may maintain state.

Methods inherited from class com.tinkerpop.pipes.AbstractPipe

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

Methods inherited from class java.lang.Object

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

Constructor Detail

IfThenElsePipe

public IfThenElsePipe(PipeFunction<S,Boolean> ifFunction,
              PipeFunction<S,?> thenFunction,
              PipeFunction<S,?> elseFunction)

Method Detail

processNextStart

public E processNextStart()

Specified by:

processNextStart in class AbstractPipe<S,E>

reset

public void reset()

Description copied from interface: Pipe

A pipe may maintain state. Reset is used to remove state. The general use case for reset() is to reuse a pipe in another computation without having to create a new Pipe object. An implementation of this method should be recursive whereby the starts (if a Pipe) should have this method called on it.

Specified by:

reset in interface Pipe<S,E>

Overrides:

reset in class AbstractPipe<S,E>