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

Enum Class GraphOp

java.lang.Object

java.lang.Enum<GraphOp>

org.apache.tinkerpop.gremlin.process.traversal.GraphOp

All Implemented Interfaces:

Serializable, Comparable<GraphOp>, Constable

public enum GraphOp
extends Enum<GraphOp>

A GraphOp or "graph operation" is a static GremlinLang form that does not translate to a traversal but instead refers to a specific function to perform on a graph instance.

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
TX_COMMIT	Commit a transaction.
TX_ROLLBACK	Rollback a transaction.

Method Summary

Modifier and Type	Method	Description
boolean	equals(GremlinLang bc)
GremlinLang	getGremlinLang()	Gets the GremlinLang that represents this graph operation.
static GraphOp	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GraphOp[]	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

TX_COMMIT

public static final GraphOp TX_COMMIT

Commit a transaction.

TX_ROLLBACK

public static final GraphOp TX_ROLLBACK

Rollback a transaction.

Method Details

values

public static GraphOp[] 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 GraphOp 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

getGremlinLang

public GremlinLang getGremlinLang()

Gets the GremlinLang that represents this graph operation. There is no notion of immutable GremlinLang instances so it is important that the object returned here is not modified. If they are changed, the operations will no longer be recognized. In a future version, we should probably introduce the concept of immutable GremlinLang to prevent this possibility - https://issues.apache.org/jira/browse/TINKERPOP-2545

equals

public boolean equals(GremlinLang bc)