io.lettuce.core.search.aggregateutils

Enum SortDirection

java.lang.Object

java.lang.Enum<SortDirection>

io.lettuce.core.search.aggregateutils.SortDirection

All Implemented Interfaces:

Serializable, Comparable<SortDirection>

@Experimental
public enum SortDirection
extends Enum<SortDirection>

Sort direction enumeration for SORTBY operations in FT.HYBRID and FT.AGGREGATE commands.

Since:

7.5

Author:

Aleksandar Todorov

See Also:

SortBy, SortProperty

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC Ascending sort order.
DESC Descending sort order.

Method Summary

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

Ascending sort order.

DESC

public static final SortDirection DESC

Descending sort order.

Method Detail

values

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

Returns:

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

valueOf

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