RequirementsStep (Apache TinkerPop 3.6.6-SNAPSHOT API)

java.lang.Object
- org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,S>
- - org.apache.tinkerpop.gremlin.process.traversal.step.util.RequirementsStep<S>

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>
```
public final class RequirementsStep<S>
extends AbstractStep<S,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, labels, nextEnd, nextStep, previousStep, starts, traversal, traverserStepIdAndLabelsSetByChild

Constructor Summary

Constructors
Constructor Description

RequirementsStep(Traversal.Admin traversal, Set<TraverserRequirement> requirements)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addRequirement(TraverserRequirement requirement)`
`Set<TraverserRequirement>`	`getRequirements()`	Provide the necessary `TraverserRequirement` that must be met by the traverser in order for the step to function properly.
`protected Traverser.Admin<S>`	`processNextStart()`

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep
addLabel, addStart, addStarts, clone, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hashCode, hasNext, hasStarts, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal, toString

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

- Constructor Detail
  - RequirementsStep
```
public RequirementsStep(Traversal.Admin traversal,
                        Set<TraverserRequirement> requirements)
```
- Method Detail
  - addRequirement
```
public void addRequirement(TraverserRequirement requirement)
```
  - 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
  - processNextStart
```
protected Traverser.Admin<S> processNextStart()
                                       throws NoSuchElementException
```
    Specified by:
    
    processNextStart in class AbstractStep<S,S>
    
    Throws:
    
    NoSuchElementException