SortOrder (JQuranTree API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD

DETAIL: ENUM CONSTANTS | FIELD | METHOD

org.jqurantree.analysis
Enum SortOrder

java.lang.Object
  java.lang.Enum<SortOrder>
      org.jqurantree.analysis.SortOrder

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<SortOrder>

public enum SortOrder
extends java.lang.Enum<SortOrder>
extends java.lang.Enum<SortOrder>

The SortOrder enumeration specifies whether to sort the rows of an AnalysisTable in ascending or descending order.

Author:: Kais Dukes

Enum Constant Summary
`Ascending` Indicates that rows will be sorted in increasing order.
`Descending` Indicates that rows will be sorted in decreasing order.

Method Summary
`static SortOrder`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static SortOrder[]`	`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 SortOrder Ascending

Indicates that rows will be sorted in increasing order.

Descending

public static final SortOrder Descending

Indicates that rows will be sorted in decreasing order.

Method Detail

values

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

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

valueOf

public static SortOrder valueOf(java.lang.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:: java.lang.IllegalArgumentException - if this enum type has no constant with the specified name; java.lang.NullPointerException - if the argument is null