Package com.atlassian.confluence.macro.params

Enum SortType

java.lang.Object

java.lang.Enum<SortType>

com.atlassian.confluence.macro.params.SortType

All Implemented Interfaces:

Serializable, Comparable<SortType>

public enum SortType
extends Enum<SortType>

Types of sorts supported by SearchSortParameter.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATION	Sort by creation time.
MODIFIED	Sort by last modification time.
NATURAL	Sort by natural ordering.
TITLE	Sort by title.

Method Summary

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

TITLE

public static final SortType TITLE

Sort by title.

NATURAL

public static final SortType NATURAL

Sort by natural ordering.

CREATION

public static final SortType CREATION

Sort by creation time.

MODIFIED

public static final SortType MODIFIED

Sort by last modification time.

Method Detail

values

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

Returns:

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

valueOf

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

getType

public final String getType()

Returns the type of this SortType as a string.

Returns:

the type of this SortType as a string

get

public static SortType get(String name)