com.eyeq.pivot4j.sort

Enum SortCriteria

java.lang.Object

java.lang.Enum<SortCriteria>

com.eyeq.pivot4j.sort.SortCriteria

All Implemented Interfaces:

Serializable, Comparable<SortCriteria>

public enum SortCriteria
extends Enum<SortCriteria>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC sort hierarchically ascending
BASC sort ascending breaking hierarchy
BDESC sort descending breaking hierarchy
BOTTOMCOUNT perform bottomcount
DESC sort hierarchically descending
TOPCOUNT perform topcount

Method Summary

Methods

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

Enum Constant Detail

ASC

public static final SortCriteria ASC

sort hierarchically ascending

DESC

public static final SortCriteria DESC

sort hierarchically descending

BASC

public static final SortCriteria BASC

sort ascending breaking hierarchy

BDESC

public static final SortCriteria BDESC

sort descending breaking hierarchy

TOPCOUNT

public static final SortCriteria TOPCOUNT

perform topcount

BOTTOMCOUNT

public static final SortCriteria BOTTOMCOUNT

perform bottomcount

Method Detail

values

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

Returns:

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

valueOf

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