StringLocalStep (Apache TinkerPop 3.7.2 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,E>
    - - org.apache.tinkerpop.gremlin.process.traversal.step.util.StringLocalStep<S,E>

All Implemented Interfaces:

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

Direct Known Subclasses:

LengthLocalStep, LTrimLocalStep, ReplaceLocalStep, RTrimLocalStep, SplitLocalStep, SubstringLocalStep, ToLowerLocalStep, ToUpperLocalStep, TrimLocalStep
```
public abstract class StringLocalStep<S,E>
extends ScalarMapStep<S,E>
```
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

StringLocalStep(Traversal.Admin traversal)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract E`	`applyStringOperation(String item)`
`Set<TraverserRequirement>`	`getRequirements()`	Provide the necessary `TraverserRequirement` that must be met by the traverser in order for the step to function properly.
`protected abstract String`	`getStepName()`
`protected E`	`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

- Constructor Detail
  - StringLocalStep
```
public StringLocalStep(Traversal.Admin traversal)
```
- Method Detail
  - map
```
protected E map(Traverser.Admin<S> traverser)
```
    Specified by:
    
    map in class ScalarMapStep<S,E>
  - 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
  - applyStringOperation
```
protected abstract E applyStringOperation(String item)
```
  - getStepName
```
protected abstract String getStepName()
```