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

Interface IsStepContract<S>

All Superinterfaces:

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

All Known Implementing Classes:

IsStep, IsStepPlaceholder

public interface IsStepContract<S>
extends Step<S,S>

Defines the contract for steps containing a single P.

Field Summary

Fields

Modifier and Type	Field	Description
static List<Class<? extends Step>>	CONCRETE_STEPS	Concrete implementations of this contract that can be referenced as TinkerPop implementations.

Method Summary

Modifier and Type	Method	Description
P<S>	getPredicate()	Retrieves the step's predicate.
default P<S>	getPredicateGValueSafe()
Set<TraverserRequirement>	getRequirements()	Provide the necessary TraverserRequirement that must be met by the traverser in order for the step to function properly.

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

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

addLabel, addStart, addStarts, clearLabels, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getTraversal, hasStarts, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Field Detail

CONCRETE_STEPS

static final List<Class<? extends Step>> CONCRETE_STEPS

Concrete implementations of this contract that can be referenced as TinkerPop implementations.

Method Detail

getPredicate

P<S> getPredicate()

Retrieves the step's predicate.

Returns:

the predicate associated with the step

getPredicateGValueSafe

default P<S> getPredicateGValueSafe()

getRequirements

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