Package org.apache.tinkerpop.gremlin.process.traversal

Enum Class Scope

java.lang.Object

java.lang.Enum<Scope>

org.apache.tinkerpop.gremlin.process.traversal.Scope

All Implemented Interfaces:

Serializable, Comparable<Scope>, Constable

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)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	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

Modifier and Type	Method	Description
Scope	opposite()
static Scope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Scope[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static Scope[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Scope valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

opposite

public Scope opposite()