io.realm

Enum Sort

java.lang.Object

java.lang.Enum<Sort>

io.realm.Sort

All Implemented Interfaces:

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

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

This class describes the sorting order used in Realm queries.

See Also:

Realm.allObjectsSorted(Class, String, Sort), RealmQuery.findAllSorted(String, Sort)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASCENDING
DESCENDING

Method Summary

Modifier and Type	Method and Description
boolean	getValue() Returns the value for this setting that is used by the underlying query engine.
static Sort	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Sort[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASCENDING

public static final Sort ASCENDING

DESCENDING

public static final Sort DESCENDING

Method Detail

values

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

Returns:

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

valueOf

public static Sort 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 boolean getValue()

Returns the value for this setting that is used by the underlying query engine.

Returns:

The value used by the underlying query engine to indicate this value.