org.apache.tinkerpop.gremlin.process.traversal.step.sideEffect

## Class SideEffectStep<S>

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

- All Implemented Interfaces:
    Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>
  Direct Known Subclasses:
    AddPropertyStep, AggregateLocalStep, GroupCountSideEffectStep, GroupSideEffectStep, LambdaSideEffectStep, ProfileSideEffectStep, SackValueStep, SubgraphStep, TraversalSideEffectStep, TreeSideEffectStep

      public abstract class SideEffectStep<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 and Description
    `SideEffectStep(Traversal.Admin traversal)`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected Traverser.Admin<S>` | `processNextStart()`
    `protected abstract void` | `sideEffect(Traverser.Admin<S> traverser)`

    - ### 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 org.apache.tinkerpop.gremlin.process.traversal.Step

      `equals, getRequirements`

    - ### Methods inherited from interface java.util.Iterator

      `forEachRemaining, remove`

- - ### Constructor Detail

    - #### SideEffectStep

          public SideEffectStep(Traversal.Admin traversal)

  - ### Method Detail

    - #### sideEffect

          protected abstract void sideEffect(Traverser.Admin<S> traverser)

    - #### processNextStart

          protected Traverser.Admin<S> processNextStart()

      Specified by:
        `processNextStart` in class `AbstractStep<S,S>`

Copyright © 2013–2021 Apache Software Foundation. All rights reserved.