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

## Class StartStep<S>

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

- All Implemented Interfaces:
    Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>
  Direct Known Subclasses:
    CypherStartStep, InjectStep

      public class StartStep<S>
      extends AbstractStep<S,S>

  Author:
    Marko A. Rodriguez (http://markorodriguez.com)
  See Also:
    Serialized Form

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected boolean` | `first`
    `protected Object` | `start`

    - ### 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
    `StartStep(Traversal.Admin traversal)`
    `StartStep(Traversal.Admin traversal, Object start)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `StartStep<S>` | `clone()` Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
    `<T> T` | `getStart()`
    `int` | `hashCode()`
    `static boolean` | `isVariableStartStep(Step<?,?> step)`
    `protected Traverser.Admin<S>` | `processNextStart()`
    `String` | `toString()`

    - ### Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.step.util.AbstractStep

      `addLabel, addStart, addStarts, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, isTraverserStepIdAndLabelsSetByChild, next, prepareTraversalForNextStep, removeLabel, reset, setId, setNextStep, setPreviousStep, setTraversal`

    - ### 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`

- - ### Field Detail

    - #### start

          protected Object start

    - #### first

          protected boolean first

  - ### Constructor Detail

    - #### StartStep

          public StartStep(Traversal.Admin traversal,
                           Object start)

    - #### StartStep

          public StartStep(Traversal.Admin traversal)

  - ### Method Detail

    - #### getStart

          public <T> T getStart()

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `AbstractStep<S,S>`

    - #### processNextStart

          protected Traverser.Admin<S> processNextStart()

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

    - #### clone

          public StartStep<S> clone()

      Description copied from interface: `Step`
      Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication. When cloning a step, it is important that the steps, the cloned step is equivalent to the state of the step when `Step.reset()` is called. Moreover, the previous and next steps should be set to `EmptyStep`.
      Specified by:
        `clone` in interface `Step<S,S>`
      Overrides:
        `clone` in class `AbstractStep<S,S>`
      Returns:
        The cloned step

    - #### hashCode

          public int hashCode()

      Overrides:
        `hashCode` in class `AbstractStep<S,S>`

    - #### isVariableStartStep

          public static boolean isVariableStartStep(Step<?,?> step)

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