public final class EmptyStep<S,E> extends Object implements Step<S,E>, TraversalParent
Modifier and Type | Method and Description |
---|---|
void |
addLabel(String label)
Add a label to this step.
|
void |
addStart(Traverser.Admin<S> start)
Add a single
Traverser.Admin to the step. |
void |
addStarts(Iterator<Traverser.Admin<S>> starts)
Add an iterator of
Traverser.Admin objects of type S to the step. |
EmptyStep<S,E> |
clone()
Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
|
boolean |
equals(Object object) |
String |
getId()
Get the unique id of this step.
|
Set<String> |
getLabels()
Get the labels of this step.
|
Step<E,?> |
getNextStep()
Get the next step to the current step.
|
Step<?,S> |
getPreviousStep()
Get the step prior to the current step.
|
Set<TraverserRequirement> |
getRequirements()
Provide the necessary
TraverserRequirement that must be met by the traverser in order for the step to
function properly. |
<A,B> Traversal.Admin<A,B> |
getTraversal()
Get the
Traversal.Admin that this step is contained within. |
int |
hashCode() |
boolean |
hasNext() |
boolean |
hasStarts()
Determines if starts objects are present without iterating forward.
|
static <S,E> EmptyStep<S,E> |
instance() |
Traverser.Admin<E> |
next() |
void |
removeLabel(String label)
Remove a label from this step.
|
void |
reset()
Reset the state of the step such that it has no incoming starts.
|
void |
setId(String id)
Get the unique id of the step.
|
void |
setNextStep(Step<E,?> step)
Set the step that is next to the current step.
|
void |
setPreviousStep(Step<?,S> step)
Set the step that is previous to the current step.
|
void |
setTraversal(Traversal.Admin<?,?> traversal)
Set the
Traversal that this step is contained within. |
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
forEachRemaining, remove
addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getLocalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild
public static <S,E> EmptyStep<S,E> instance()
public void addStarts(Iterator<Traverser.Admin<S>> starts)
Step
Traverser.Admin
objects of type S to the step.public boolean hasStarts()
Step
ReducingBarrierStep
implementations where they always return true
for calls to
Iterator.hasNext()
. Using this function gives insight to what the step itself is holding in its iterator without
performing any sort of processing on the step itself.public void addStart(Traverser.Admin<S> start)
Step
Traverser.Admin
to the step.public void setPreviousStep(Step<?,S> step)
Step
setPreviousStep
in interface Step<S,E>
step
- the previous step of this steppublic void reset()
Step
public Step<?,S> getPreviousStep()
Step
getPreviousStep
in interface Step<S,E>
public void setNextStep(Step<E,?> step)
Step
setNextStep
in interface Step<S,E>
step
- the next step of this steppublic Step<E,?> getNextStep()
Step
getNextStep
in interface Step<S,E>
public <A,B> Traversal.Admin<A,B> getTraversal()
Step
Traversal.Admin
that this step is contained within.getTraversal
in interface Step<S,E>
A
- The incoming object type of the traversalB
- The outgoing object type of the traversalpublic void setTraversal(Traversal.Admin<?,?> traversal)
Step
Traversal
that this step is contained within.setTraversal
in interface Step<S,E>
traversal
- the new traversal for this steppublic EmptyStep<S,E> clone()
Step
Step.reset()
is called. Moreover, the previous and next steps should be set to EmptyStep
.public Set<String> getLabels()
Step
Step.addLabel(java.lang.String)
.public void addLabel(String label)
Step
public void removeLabel(String label)
Step
removeLabel
in interface Step<S,E>
label
- the label to remove from this steppublic void setId(String id)
Step
public boolean hasNext()
hasNext
in interface Iterator<Traverser.Admin<E>>
public Traverser.Admin<E> next()
next
in interface Iterator<Traverser.Admin<E>>
public Set<TraverserRequirement> getRequirements()
Step
TraverserRequirement
that must be met by the traverser in order for the step to
function properly. The provided default implements returns an empty set.getRequirements
in interface Step<S,E>
Copyright © 2013–2022 Apache Software Foundation. All rights reserved.