org.lenskit.data.dao

Enum SortOrder

java.lang.Object

java.lang.Enum<SortOrder>

org.lenskit.data.dao.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SortOrder>

public enum SortOrder
extends Enum<SortOrder>

Compatibility

Public (but may add orders)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY Deprecated.
ASCENDING Ascending order.
DESCENDING Descending order.
ITEM Deprecated.
TIMESTAMP Deprecated.
USER Deprecated.

Method Summary

Modifier and Type	Method and Description
Comparator<Event>	getEventComparator() Get the event comparator for a sort order.
static SortOrder	valueOf(String name) Returns the enum constant of this type with the specified name.
static SortOrder[]	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

ASCENDING

public static final SortOrder ASCENDING

Ascending order.

DESCENDING

public static final SortOrder DESCENDING

Descending order.

ANY

@Deprecated
public static final SortOrder ANY

Deprecated.

Any order is acceptable.

TIMESTAMP

@Deprecated
public static final SortOrder TIMESTAMP

Deprecated.

Sort by timestamp.

USER

@Deprecated
public static final SortOrder USER

Deprecated.

Sort by user, then by timestamp.

ITEM

@Deprecated
public static final SortOrder ITEM

Deprecated.

Sort by item, then by timestamp.

Method Detail

values

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

Returns:

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

valueOf

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

getEventComparator

@Nullable
public Comparator<Event> getEventComparator()

Get the event comparator for a sort order.

Returns:

An appropriate comparator, or null if the order is unsorted.