io.nem.symbol.sdk.api

Enum OrderBy

java.lang.Object

java.lang.Enum<OrderBy>

io.nem.symbol.sdk.api.OrderBy

All Implemented Interfaces:

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

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

It defines the direction of ordered results.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC Values are sorted from small/old to big/new.
DESC Values are sorted from big/new to small/old.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getValue()
static OrderBy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OrderBy[]	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 OrderBy ASC

Values are sorted from small/old to big/new.

DESC

public static final OrderBy DESC

Values are sorted from big/new to small/old.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public java.lang.String getValue()