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

Enum Order

java.lang.Object

java.lang.Enum<Order>

org.apache.tinkerpop.gremlin.process.traversal.Order

All Implemented Interfaces:

Serializable, Comparable<Order>, Comparator<Object>

public enum Order
extends Enum<Order>
implements Comparator<Object>

Provides Comparator instances for ordering traversers.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com)

Enum Constant Summary

Enum Constants

Enum Constant	Description
asc	Order in ascending fashion.
desc	Order in descending fashion.
shuffle	Order in a random fashion.

Method Summary

Modifier and Type	Method	Description
abstract int	compare(Object first, Object second)
abstract Order	reversed()	Produce the opposite representation of the current Order enum.
static Order	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Order[]	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

Methods inherited from interface java.util.Comparator

equals, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Enum Constant Detail

shuffle

public static final Order shuffle

Order in a random fashion. While this enum implements Comparator, the compare(a,b) method is not supported as a direct call. This change to the implementation of compare(a,b) occurred at 3.5.0 but this implementation was never used directly within the TinkerPop code base.

Since:

3.0.0-incubating

asc

public static final Order asc

Order in ascending fashion.

Since:

3.3.4

desc

public static final Order desc

Order in descending fashion.

Since:

3.3.4

Method Detail

values

public static Order[] 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 (Order c : Order.values())
    System.out.println(c);

Returns:

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

valueOf

public static Order 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

compare

public abstract int compare(Object first,
                            Object second)

Specified by:

compare in interface Comparator<Object>

reversed

public abstract Order reversed()

Produce the opposite representation of the current Order enum.

Specified by:

reversed in interface Comparator<Object>