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

Interface RangeLocalStepContract<S>

All Superinterfaces:

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

All Known Implementing Classes:

RangeLocalStep, RangeLocalStepPlaceholder

public interface RangeLocalStepContract<S>
extends Step<S,S>, Ranging

Defines the contract for range related steps.

Field Summary

Fields

Modifier and Type	Field	Description
static final 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
Long	getHighRange()	Retrieves the higher bound of the range.
default GValue<Long>	getHighRangeAsGValue()	getHighRange, retaining the GValue container and without pinning the variable.
Long	getLowRange()	Retrieves the lower bound of the range.
default GValue<Long>	getLowRangeAsGValue()	getLowRange, retaining the GValue container and without pinning the variable.

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, getRequirements, getTraversal, hasStarts, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal

Field Details

CONCRETE_STEPS

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

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

Method Details

getLowRange

Long getLowRange()

Retrieves the lower bound of the range.

Specified by:

getLowRange in interface Ranging

Returns:

the value representing the lower bound of the range

getHighRange

Long getHighRange()

Retrieves the higher bound of the range.

Specified by:

getHighRange in interface Ranging

Returns:

the higher bound of the range as an object of type V

getLowRangeAsGValue

default GValue<Long> getLowRangeAsGValue()

getLowRange, retaining the GValue container and without pinning the variable. It is the caller's responsibility to ensure that this value is not used to alter the traversal in any way which is not generalizable to any parameter value.

Returns:

the lower bound for range().

getHighRangeAsGValue

default GValue<Long> getHighRangeAsGValue()

getHighRange, retaining the GValue container and without pinning the variable. It is the caller's responsibility to ensure that this value is not used to alter the traversal in any way which is not generalizable to any parameter value.

Returns:

the upper bound for range().