com.jcabi.github

Enum Search.Order

java.lang.Object

java.lang.Enum<Search.Order>

com.jcabi.github.Search.Order

All Implemented Interfaces:

StringEnum, Serializable, Comparable<Search.Order>

Enclosing interface:

Search

public static enum Search.Order
extends Enum<Search.Order>
implements StringEnum

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC Sorting ascending.
DESC Sorting descending.

Method Summary

Methods

Modifier and Type	Method and Description
String	identifier() Get sort order.
static Search.Order	valueOf(String name) Returns the enum constant of this type with the specified name.
static Search.Order[]	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

ASC

public static final Search.Order ASC

Sorting ascending.

DESC

public static final Search.Order DESC

Sorting descending.

Method Detail

values

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

Returns:

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

valueOf

public static Search.Order 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

identifier

@NotNull(message="identifier string is never NULL")
public String identifier()

Get sort order.

Specified by:

identifier in interface StringEnum

Returns:

String