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

All Implemented Interfaces:

Serializable, Cloneable, Iterator<Traverser.Admin<E>>, Step<S,E>
```
public final class LTrimLocalStep<S,E>
extends StringLocalStep<S,E>
```
Reference implementation for lTrim() step, a mid-traversal step which returns a string with leading whitespace removed. 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

LTrimLocalStep(Traversal.Admin traversal)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected 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.
`String`	`getStepName()`

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.StringLocalStep
map

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
  - LTrimLocalStep
```
public LTrimLocalStep(Traversal.Admin traversal)
```
- Method Detail
  - 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,E>
    
    Overrides:
    
    getRequirements in class StringLocalStep<S,E>
    
    Returns:
    
    the set of requirements
  - applyStringOperation
```
protected E applyStringOperation(String item)
```
    Specified by:
    
    applyStringOperation in class StringLocalStep<S,E>
  - getStepName
```
public String getStepName()
```
    Specified by:
    
    getStepName in class StringLocalStep<S,E>