Package org.apache.tinkerpop.gremlin.structure

Enum Class T

java.lang.Object

java.lang.Enum<T>

org.apache.tinkerpop.gremlin.structure.T

All Implemented Interfaces:

Serializable, Comparable<T>, Constable, Function<Element,Object>

public enum T
extends Enum<T>
implements Function<Element,Object>

A collection of (T)okens which allows for more concise Traversal definitions. T implements Function can be used to map an element to its token value. For example, T.id.apply(element).

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
id	Id (representing Element.id())
key	Key (representing Property.key())
label	Label (representing Element.label())
value	Value (representing Property.value())

Method Summary

Modifier and Type	Method	Description
abstract Object	apply(Element element)
static T	fromString(String accessor)
abstract String	getAccessor()
static T	valueOf(String name)	Returns the enum constant of this class with the specified name.
static T[]	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

Methods inherited from interface java.util.function.Function

andThen, compose

Enum Constant Details

label

public static final T label

Label (representing Element.label())

Since:

3.0.0-incubating

id

public static final T id

Id (representing Element.id())

Since:

3.0.0-incubating

key

public static final T key

Key (representing Property.key())

Since:

3.0.0-incubating

value

public static final T value

Value (representing Property.value())

Since:

3.0.0-incubating

Method Details

values

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

getAccessor

public abstract String getAccessor()

apply

public abstract Object apply(Element element)

Specified by:

apply in interface Function<Element,Object>

fromString

public static T fromString(String accessor)