io.sphere.sdk.search

Enum SearchSortDirection

java.lang.Object

java.lang.Enum<SearchSortDirection>

io.sphere.sdk.search.SearchSortDirection

All Implemented Interfaces:

Serializable, Comparable<SearchSortDirection>

public enum SearchSortDirection
extends Enum<SearchSortDirection>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ASC On multi-valued attributes, when the sort direction is ascending, the minimum value is used.
ASC_MAX Changes the default behaviour of the ascending sort by using the maximum value instead.
DESC On multi-valued attributes, when the direction is descending, the maximum value is used.
DESC_MIN Changes the default behaviour of the descending sort by using the minimum value instead.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASC

public static final SearchSortDirection ASC

On multi-valued attributes, when the sort direction is ascending, the minimum value is used.

DESC

public static final SearchSortDirection DESC

On multi-valued attributes, when the direction is descending, the maximum value is used.

ASC_MAX

public static final SearchSortDirection ASC_MAX

Changes the default behaviour of the ascending sort by using the maximum value instead. USE ONLY ON MULTI-VALUED ATTRIBUTES, such as those at product variant level!

DESC_MIN

public static final SearchSortDirection DESC_MIN

Changes the default behaviour of the descending sort by using the minimum value instead. USE ONLY ON MULTI-VALUED ATTRIBUTES, such as those at product variant level!

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<SearchSortDirection>