Class SackValueStep<S,A,B>
- java.lang.Object
-
- org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,S>
-
- org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.SackValueStep<S,A,B>
-
- All Implemented Interfaces:
Serializable
,AutoCloseable
,Cloneable
,Iterator<Traverser.Admin<S>>
,Step<S,S>
,ByModulating
,LambdaHolder
,TraversalParent
public final class SackValueStep<S,A,B> extends AbstractStep<S,S> implements TraversalParent, ByModulating, LambdaHolder
- 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, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild
-
-
Constructor Summary
Constructors Constructor Description SackValueStep(Traversal.Admin traversal, BiFunction<A,B,A> sackFunction)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SackValueStep<S,A,B>
clone()
Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.List<Traversal.Admin<S,B>>
getLocalChildren()
Set<TraverserRequirement>
getRequirements()
Provide the necessaryTraverserRequirement
that must be met by the traverser in order for the step to function properly.BiFunction<A,B,A>
getSackFunction()
int
hashCode()
void
modulateBy(Traversal.Admin<?,?> sackTraversal)
protected Traverser.Admin<S>
processNextStart()
void
replaceLocalChild(Traversal.Admin<?,?> oldTraversal, Traversal.Admin<?,?> newTraversal)
void
setTraversal(Traversal.Admin<?,?> parentTraversal)
Set theTraversal
that this step is contained within.String
toString()
-
Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep
addLabel, addStart, addStarts, clearLabels, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.ByModulating
modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy, modulateBy
-
Methods inherited from interface java.util.Iterator
forEachRemaining, remove
-
Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent
addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild
-
-
-
-
Constructor Detail
-
SackValueStep
public SackValueStep(Traversal.Admin traversal, BiFunction<A,B,A> sackFunction)
-
-
Method Detail
-
modulateBy
public void modulateBy(Traversal.Admin<?,?> sackTraversal)
- Specified by:
modulateBy
in interfaceByModulating
-
replaceLocalChild
public void replaceLocalChild(Traversal.Admin<?,?> oldTraversal, Traversal.Admin<?,?> newTraversal)
- Specified by:
replaceLocalChild
in interfaceTraversalParent
-
getLocalChildren
public List<Traversal.Admin<S,B>> getLocalChildren()
- Specified by:
getLocalChildren
in interfaceTraversalParent
-
processNextStart
protected Traverser.Admin<S> processNextStart()
- Specified by:
processNextStart
in classAbstractStep<S,S>
-
toString
public String toString()
- Overrides:
toString
in classAbstractStep<S,S>
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classAbstractStep<S,S>
-
getSackFunction
public BiFunction<A,B,A> getSackFunction()
-
getRequirements
public Set<TraverserRequirement> getRequirements()
Description copied from interface:Step
Provide the necessaryTraverserRequirement
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 interfaceStep<S,A>
- Returns:
- the set of requirements
-
clone
public SackValueStep<S,A,B> clone()
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 whenStep.reset()
is called. Moreover, the previous and next steps should be set toEmptyStep
.
-
setTraversal
public void setTraversal(Traversal.Admin<?,?> parentTraversal)
Description copied from interface:Step
Set theTraversal
that this step is contained within.- Specified by:
setTraversal
in interfaceStep<S,A>
- Overrides:
setTraversal
in classAbstractStep<S,S>
- Parameters:
parentTraversal
- the new traversal for this step
-
-