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

Enum Class Pick

java.lang.Object

java.lang.Enum<Pick>

org.apache.tinkerpop.gremlin.process.traversal.Pick

All Implemented Interfaces:

Serializable, Comparable<Pick>, Constable

public enum Pick
extends Enum<Pick>

A token used with option().

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
any	Acceptable option for any match.
none	The option to take when no match is found.
unproductive	If the incoming traverser is unproductive then match on this option.

Method Summary

Modifier and Type	Method	Description
static Pick	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Pick[]	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

any

public static final Pick any

Acceptable option for any match.

none

public static final Pick none

The option to take when no match is found.

unproductive

public static final Pick unproductive

If the incoming traverser is unproductive then match on this option.

Method Details

values

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