Package net.sf.jasperreports.engine.analytics.dataset

Enum BucketOrder

java.lang.Object

java.lang.Enum<BucketOrder>

net.sf.jasperreports.engine.analytics.dataset.BucketOrder

All Implemented Interfaces:

Serializable, Comparable<BucketOrder>, NamedEnum

public enum BucketOrder
extends Enum<BucketOrder>
implements NamedEnum

Author:

Lucian Chirita (lucianc@users.sourceforge.net)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASCENDING	Ascending order constant.
DESCENDING	Descending order constant.
NONE	No sorting.

Field Summary

Fields

Modifier and Type	Field	Description
static String	EXCEPTION_MESSAGE_KEY_CANNOT_TRANSLATE_NONE
static String	EXCEPTION_MESSAGE_KEY_UNKNOWN_ORDER_ENUM

Method Summary

Modifier and Type	Method	Description
static BucketOrder	fromSortOrderEnum(SortOrderEnum orderValue)
BucketOrder	getDefault()
String	getName()
static SortOrderEnum	toSortOrderEnum(BucketOrder order)
static BucketOrder	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BucketOrder[]	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

ASCENDING

public static final BucketOrder ASCENDING

Ascending order constant.

DESCENDING

public static final BucketOrder DESCENDING

Descending order constant.

NONE

public static final BucketOrder NONE

No sorting.

Field Detail

EXCEPTION_MESSAGE_KEY_CANNOT_TRANSLATE_NONE

public static final String EXCEPTION_MESSAGE_KEY_CANNOT_TRANSLATE_NONE

See Also:

Constant Field Values

EXCEPTION_MESSAGE_KEY_UNKNOWN_ORDER_ENUM

public static final String EXCEPTION_MESSAGE_KEY_UNKNOWN_ORDER_ENUM

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getName

public String getName()

Specified by:

getName in interface NamedEnum

toSortOrderEnum

public static SortOrderEnum toSortOrderEnum(BucketOrder order)

fromSortOrderEnum

public static BucketOrder fromSortOrderEnum(SortOrderEnum orderValue)

getDefault

public BucketOrder getDefault()

Specified by:

getDefault in interface NamedEnum