org.apache.tinkerpop.gremlin.process.traversal

## Enum Scope

- java.lang.Object
- - java.lang.Enum<Scope>
  - - org.apache.tinkerpop.gremlin.process.traversal.Scope

- All Implemented Interfaces:
    Serializable, Comparable<Scope>

      public enum Scope
      extends Enum<Scope>

  Many `Step` instance can have a variable scope which alter the manner in which the step will behave in relation to how the traversers are processed.
  Author:
    Marko A. Rodriguez (http://markorodriguez.com)

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `global` Informs the step to operate on the entire traversal.
    `local` Informs the step to operate on the current object in the step.

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `Scope` | `opposite()`
    `static Scope` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static Scope[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

      `clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf`

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### global

          public static final Scope global

      Informs the step to operate on the entire traversal.
      Since:
        3.0.0-incubating

    - #### local

          public static final Scope local

      Informs the step to operate on the current object in the step.
      Since:
        3.0.0-incubating

  - ### Method Detail

    - #### values

          public static Scope[] values()

      Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

          for (Scope c : Scope.values())
              System.out.println(c);

      Returns:
        an array containing the constants of this enum type, in the order they are declared

    - #### valueOf

          public static Scope valueOf(String name)

      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
        `name` - the name of the enum constant to be returned.
      Returns:
        the enum constant with the specified name
      Throws:
        `IllegalArgumentException` - if this enum type has no constant with the specified name
        `NullPointerException` - if the argument is null

    - #### opposite

          public Scope opposite()

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