org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect

Class SideEffectCapStep<S,E>

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.util.SupplyingBarrierStep<S,E>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SideEffectCapStep<S,E>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser<E>>, Step<S,E>

public final class SideEffectCapStep<S,E>
extends SupplyingBarrierStep<S,E>

Author:

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

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

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

Constructor Summary

Constructors

Constructor and Description
SideEffectCapStep(Traversal.Admin traversal, String... sideEffectKeys)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getMapOfSideEffects()
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
List<String>	getSideEffectKeys()
E	supply()
String	toString()

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.SupplyingBarrierStep

clone, processNextStart, reset

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

addStart, addStarts, getId, getLabel, getNextStep, getPreviousStep, getTraversal, hasNext, next, 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

SideEffectCapStep

public SideEffectCapStep(Traversal.Admin traversal,
                         String... sideEffectKeys)

Method Detail

toString

public String toString()

Overrides:

toString in class AbstractStep<S,E>

getSideEffectKeys

public List<String> getSideEffectKeys()

getRequirements

public 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.

Returns:

the set of requirements

supply

public E supply()

Specified by:

supply in class SupplyingBarrierStep<S,E>

getMapOfSideEffects

public Map<String,Object> getMapOfSideEffects()