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

Class InjectStep<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.StartStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.InjectStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>

public final class InjectStep<S>
extends StartStep<S>

Author:

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

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.StartStep

first, start

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
InjectStep(Traversal.Admin traversal, S... injections)

Method Summary

Modifier and Type	Method	Description
InjectStep<S>	clone()	Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
S[]	getInjections()	Gets the injections of the step but unwraps the GValue.
GValue<S>[]	getInjectionsGValue()	Get the injections of the step.
void	reset()	Reset the state of the step such that it has no incoming starts.

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect.StartStep

getStart, hashCode, isVariableStartStep, processNextStart, 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, setId, setNextStep, setPreviousStep, setTraversal

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Iterator

forEachRemaining, remove

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.Step

equals, getRequirements

Constructor Details

InjectStep

@SafeVarargs
public InjectStep(Traversal.Admin traversal,
 S... injections)

Method Details

clone

public InjectStep<S> 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 when Step.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 StartStep<S>

Returns:

The cloned step

reset

public void reset()

Description copied from interface: Step

Reset the state of the step such that it has no incoming starts. Internal states are to be reset, but any sideEffect data structures are not to be recreated.

Specified by:

reset in interface Step<S,S>

Overrides:

reset in class AbstractStep<S,S>

getInjectionsGValue

public GValue<S>[] getInjectionsGValue()

Get the injections of the step.

getInjections

public S[] getInjections()

Gets the injections of the step but unwraps the GValue.