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

Class RetainStep<S>

java.lang.Object

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

org.apache.tinkerpop.gremlin.process.traversal.step.filter.FilterStep<S>

org.apache.tinkerpop.gremlin.process.traversal.step.filter.RetainStep<S>

All Implemented Interfaces:

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

public final class RetainStep<S>
extends FilterStep<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.util.AbstractStep

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

Constructor Summary

Constructors

Constructor and Description
RetainStep(Traversal.Admin traversal, Collection<S> retainCollection)
RetainStep(Traversal.Admin traversal, S retainObject)
RetainStep(Traversal.Admin traversal, String sideEffectKeyOrPathLabel)

Method Summary

Modifier and Type	Method and Description
protected boolean	filter(Traverser.Admin<S> traverser)
Set<TraverserRequirement>	getRequirements() Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.
String	toString()

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.filter.FilterStep

processNextStart

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

addStart, addStarts, clone, 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

RetainStep

public RetainStep(Traversal.Admin traversal,
                  String sideEffectKeyOrPathLabel)

RetainStep

public RetainStep(Traversal.Admin traversal,
                  Collection<S> retainCollection)

RetainStep

public RetainStep(Traversal.Admin traversal,
                  S retainObject)

Method Detail

filter

protected boolean filter(Traverser.Admin<S> traverser)

Specified by:

filter in class FilterStep<S>

toString

public String toString()

Overrides:

toString in class AbstractStep<S,S>

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