Module datarush.library

Package com.pervasive.datarush.tokens

Enum Class TokenOrder

java.lang.Object

java.lang.Enum<TokenOrder>

com.pervasive.datarush.tokens.TokenOrder

All Implemented Interfaces:

Serializable, Comparable<TokenOrder>, java.lang.constant.Constable

public enum TokenOrder
extends Enum<TokenOrder>

An ordering of token values.

When ordering tokens, the null value is always considered the highest value.

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
ASCENDING	The ordering from lowest to highest value.
DESCENDING	The ordering from highest to least value.

Method Summary

Modifier and Type	Method	Description
int	getMultiplier()	Gets the multiplier associated with the ordering.
String	getShortName()	Gets an abbreviated name for the ordering.
static TokenOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TokenOrder[]	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

ASCENDING

public static final TokenOrder ASCENDING

The ordering from lowest to highest value.

DESCENDING

public static final TokenOrder DESCENDING

The ordering from highest to least value.

Method Details

values

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

getShortName

public String getShortName()

Gets an abbreviated name for the ordering.

Returns:

the abbreviated name.

getMultiplier

public int getMultiplier()

Gets the multiplier associated with the ordering. This is the value to apply to the results of compare() to get the appropriate sign reflecting the ordering.

Returns:

the ordering's multiplier.