com.tinkerpop.gremlin.process.graph.step.branch

Class BranchStep<S>

java.lang.Object

com.tinkerpop.gremlin.process.util.AbstractStep<S,S>

com.tinkerpop.gremlin.process.graph.step.branch.BranchStep<S>

All Implemented Interfaces:

EngineDependent, Step<S,S>, java.lang.Cloneable, java.util.Iterator<Traverser<S>>

public class BranchStep<S>
extends AbstractStep<S,S>
implements EngineDependent

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BranchStep.GoToLabels<S>

Field Summary

Fields inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

id, label, nextEnd, nextStep, previousStep, PROFILING_ENABLED, starts, traversal, traverserStepIdSetByChild

Constructor Summary

Constructors

Constructor and Description
BranchStep(Traversal traversal)

Method Summary

Modifier and Type	Method and Description
BranchStep<S>	clone() Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
java.util.Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
void	onEngine(TraversalEngine traversalEngine)
Traverser<S>	processNextStart()
void	setFunction(java.util.function.Function<Traverser<S>,java.util.Collection<java.lang.String>> function)
java.lang.String	toString()

Methods inherited from class com.tinkerpop.gremlin.process.util.AbstractStep

addStart, addStarts, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, reset, setId, setLabel, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Constructor Detail

BranchStep

public BranchStep(Traversal traversal)

Method Detail

getRequirements

public java.util.Set<TraverserRequirement> getRequirements()

Description copied from interface: Step

Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly. The provided default implements returns an empty set.

Specified by:

getRequirements in interface Step<S,S>

Returns:

the set of requirements

processNextStart

public Traverser<S> processNextStart()

Specified by:

processNextStart in class AbstractStep<S,S>

onEngine

public void onEngine(TraversalEngine traversalEngine)

Specified by:

onEngine in interface EngineDependent

clone

public BranchStep<S> clone()
                    throws java.lang.CloneNotSupportedException

Description copied from interface: Step

Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication. When cloning a step, it is important that the steps, the cloned step is equivalent to the state of the step when reset() is called. Moreover, the previous and next steps should be set to EmptyStep.

Specified by:

clone in interface Step<S,S>

Overrides:

clone in class AbstractStep<S,S>

Returns:

The cloned step

Throws:

java.lang.CloneNotSupportedException

setFunction

public void setFunction(java.util.function.Function<Traverser<S>,java.util.Collection<java.lang.String>> function)

toString

public java.lang.String toString()

Overrides:

toString in class AbstractStep<S,S>