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

## Class IoStep<S>

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

- All Implemented Interfaces:
    Serializable, Cloneable, Iterator<Traverser.Admin<S>>, Step<S,S>, Configuring, Parameterizing, ReadWriting

      public class IoStep<S>
      extends AbstractStep<S,S>
      implements ReadWriting

  Handles read and write operations into the `Graph`.
  Author:
    Stephen Mallette (http://stephen.genoprime.com)
  See Also:
    Serialized Form

- - ### Nested Class Summary

    - ### Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.step.ReadWriting

      `ReadWriting.Mode`

  - ### 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
    `IoStep(Traversal.Admin traversal, String file)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `IoStep` | `clone()` Cloning is used to duplicate steps for the purpose of traversal optimization and OLTP replication.
    `void` | `configure(Object... keyValues)` Accept a configuration to the `Step`.
    `protected String` | `detectFileType()`
    `protected List<IoRegistry>` | `detectRegistries()`
    `String` | `getFile()` Get the file location to write to.
    `ReadWriting.Mode` | `getMode()`
    `Parameters` | `getParameters()` Gets the parameters on the step.
    `int` | `hashCode()`
    `protected Traverser.Admin<S>` | `processNextStart()`
    `protected Traverser.Admin<S>` | `read(File file)`
    `void` | `setMode(ReadWriting.Mode mode)`
    `String` | `toString()`
    `protected Traverser.Admin<S>` | `write(File file)`

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

      `addLabel, addStart, addStarts, equals, getId, getLabels, getNextStep, getPreviousStep, getStarts, getTraversal, hasNext, hasStarts, 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`

- - ### Constructor Detail

    - #### IoStep

          public IoStep(Traversal.Admin traversal,
                        String file)

  - ### Method Detail

    - #### setMode

          public void setMode(ReadWriting.Mode mode)

      Specified by:
        `setMode` in interface `ReadWriting`

    - #### getMode

          public ReadWriting.Mode getMode()

      Specified by:
        `getMode` in interface `ReadWriting`

    - #### getFile

          public String getFile()

      Description copied from interface: `ReadWriting`
      Get the file location to write to.
      Specified by:
        `getFile` in interface `ReadWriting`

    - #### getParameters

          public Parameters getParameters()

      Description copied from interface: `Parameterizing`
      Gets the parameters on the step.
      Specified by:
        `getParameters` in interface `Parameterizing`

    - #### configure

          public void configure(Object... keyValues)

      Description copied from interface: `Configuring`
      Accept a configuration to the `Step`. Note that this interface extends `Parameterizing` and so there is an expectation that the `Step` implementation will have a `Parameters` instance that will house any values passed to this method. Storing these configurations in `Parameters` is not a requirement however, IF the configuration is an expected option for the step and can be stored on a member field that can be accessed on the step by more direct means (i.e. like a getter method).
      Specified by:
        `configure` in interface `Configuring`

    - #### processNextStart

          protected Traverser.Admin<S> processNextStart()

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

    - #### write

          protected Traverser.Admin<S> write(File file)

    - #### read

          protected Traverser.Admin<S> read(File file)

    - #### detectFileType

          protected String detectFileType()

    - #### detectRegistries

          protected List<IoRegistry> detectRegistries()

    - #### hashCode

          public int hashCode()

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

    - #### toString

          public String toString()

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

    - #### clone

          public IoStep 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

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