Package org.opengrok.indexer.web

Enum Class SortOrder

java.lang.Object

java.lang.Enum<SortOrder>

org.opengrok.indexer.web.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SortOrder>, Constable

public enum SortOrder
extends Enum<SortOrder>

Sort orders recognized in the web UI.

Version:

$Revision$

Author:

Jens Elkner

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method	Description
static SortOrder	get(String name)	Get the Sort order wrt.
String	getDesc()	A more user friendly description (UI name) of the sort order.
String	toString()	The query parameter name.
static SortOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortOrder[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

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 Details

values

public static SortOrder[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SortOrder valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

get

public static SortOrder get(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 String toString()

The query parameter name.

Overrides:

toString in class Enum<SortOrder>

Returns:

just return the name

getDesc

public String getDesc()

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

Returns:

a very short description.