ReplaceStep (Apache TinkerPop 4.0.0-SNAPSHOT API)

java.lang.Object
- org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep<S,E>
- - org.apache.tinkerpop.gremlin.process.traversal.step.map.MapStep<S,E>
  - - org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep<S,String>
    - - org.apache.tinkerpop.gremlin.process.traversal.step.map.ReplaceStep<S>

All Implemented Interfaces:

Serializable, AutoCloseable, Cloneable, Iterator<Traverser.Admin<String>>, Step<S,String>, TraversalParent
```
public final class ReplaceStep<S>
extends ScalarMapStep<S,String>
implements TraversalParent
```
Reference implementation for substring step, a mid-traversal step which returns a string with the specified characters in the original string replaced with the new characters. Any null arguments will be a no-op and the original string is returned. Null values are not processed and remain as null when returned. If the incoming traverser is a non-String value then an IllegalArgumentException will be thrown.

Author:

David Bechberger (http://bechberger.com), Yang Xia (http://github.com/xiazcy)

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

ReplaceStep(Traversal.Admin traversal, String oldChar, String newChar)

Method Summary

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

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.map.ScalarMapStep
processNextStart

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep
addLabel, addStart, addStarts, clearLabels, 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

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.TraversalParent
addGlobalChild, addLocalChild, asStep, close, getGlobalChildren, getLocalChildren, getSelfAndChildRequirements, integrateChild, removeGlobalChild, removeLocalChild, replaceLocalChild

- Constructor Detail
  - ReplaceStep
```
public ReplaceStep(Traversal.Admin traversal,
                   String oldChar,
                   String newChar)
```
- Method Detail
  - map
```
protected String map(Traverser.Admin<S> traverser)
```
    Specified by:
    
    map in class ScalarMapStep<S,String>
  - 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.
    
    Specified by:
    
    getRequirements in interface Step<S,String>
    
    Returns:
    
    the set of requirements