Package com.spertus.jacquard.common

Enum Class Result.Order

java.lang.Object

java.lang.Enum<Result.Order>

com.spertus.jacquard.common.Result.Order

All Implemented Interfaces:

Serializable, Comparable<Result.Order>, Constable

Enclosing class:

Result

public static enum Result.Order
extends Enum<Result.Order>

The publication order for results. The default is NATURAL. This is used by Result.reorderResults(List, Order).

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
ALPHABETICAL	Alphabetical order by result name.
DECREASING_MAX_SCORE	In decreasing order by maximum score.
INCREASING_MAX_SCORE	In increasing order by maximum score.
NATURAL	The order in which they were generated.

Method Summary

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

NATURAL

public static final Result.Order NATURAL

The order in which they were generated. In other words, this will not reorder elements.

ALPHABETICAL

public static final Result.Order ALPHABETICAL

Alphabetical order by result name.

INCREASING_MAX_SCORE

public static final Result.Order INCREASING_MAX_SCORE

In increasing order by maximum score.

DECREASING_MAX_SCORE

public static final Result.Order DECREASING_MAX_SCORE

In decreasing order by maximum score.

Method Details

values

public static Result.Order[] 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 Result.Order 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