Package org.graylog2.rest.models

Enum Class SortOrder

java.lang.Object

java.lang.Enum<SortOrder>

org.graylog2.rest.models.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SortOrder>, Constable

public enum SortOrder
extends Enum<SortOrder>

Sort order for querying MongoDB to be used as a query param in REST resources.

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
ASCENDING
DESCENDING

Method Summary

Modifier and Type	Method	Description
static SortOrder	fromString(String order)
abstract org.bson.conversions.Bson	toBsonSort(String... fields)	Generate a Bson sort object that can be used directly as a parameter for querying MongoDB.
abstract org.bson.conversions.Bson	toBsonSort(List<String> fields)	Generate a Bson sort object that can be used directly as a parameter for querying MongoDB.
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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASCENDING

public static final SortOrder ASCENDING

DESCENDING

public static final SortOrder DESCENDING

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

fromString

public static SortOrder fromString(String order)

toBsonSort

public abstract org.bson.conversions.Bson toBsonSort(String... fields)

Generate a Bson sort object that can be used directly as a parameter for querying MongoDB. Calls Sorts.ascending(String...) or Sorts.descending(String...) as appropriate.

Parameters:

fields - Fields to sort on in the specified order.

Returns:

A BSON object as returned by the Sorts factory methods

toBsonSort

public abstract org.bson.conversions.Bson toBsonSort(List<String> fields)

Generate a Bson sort object that can be used directly as a parameter for querying MongoDB. Calls Sorts.ascending(List) or Sorts.descending(List) as appropriate.

Parameters:

fields - Fields to sort on in the specified order.

Returns:

A BSON object as returned by the Sorts factory methods