org.opensolaris.opengrok.web

Enum SortOrder

java.lang.Object

java.lang.Enum<SortOrder>

org.opensolaris.opengrok.web.SortOrder

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SortOrder>

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

Sort orders recognized in the web UI.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BY_PATH sort by path
LASTMODIFIED sort by last modification time
RELEVANCY sort by relevancy

Method Summary

Methods

Modifier and Type	Method and Description
static SortOrder	get(java.lang.String name) Get the Sort order wrt.
java.lang.String	getDesc() A more user friendly description (UI name) of the sort order.
java.lang.String	toString() The query parameter name.
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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LASTMODIFIED

public static final SortOrder LASTMODIFIED

sort by last modification time

RELEVANCY

public static final SortOrder RELEVANCY

sort by relevancy

BY_PATH

public static final SortOrder BY_PATH

sort by path

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

get

public static SortOrder get(java.lang.String name)

Get the Sort order wrt. the given name.

Parameters:

name - the query parameter name of the order to find.

Returns:

null if there is no SortOrder with the given name, the corresponding SortOrder otherwise.

See Also:

toString()

toString

public java.lang.String toString()

The query parameter name.

Overrides:

toString in class java.lang.Enum<SortOrder>

getDesc

public java.lang.String getDesc()

A more user friendly description (UI name) of the sort order.

Returns:

a very short description.