Package com.algolia.model.search

Enum Class SortRemainingBy

java.lang.Object

java.lang.Enum<SortRemainingBy>

com.algolia.model.search.SortRemainingBy

All Implemented Interfaces:

Serializable, Comparable<SortRemainingBy>, Constable

public enum SortRemainingBy
extends Enum<SortRemainingBy>

Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned.

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
ALPHA
COUNT
HIDDEN

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

COUNT

public static final SortRemainingBy COUNT

ALPHA

public static final SortRemainingBy ALPHA

HIDDEN

public static final SortRemainingBy HIDDEN

Method Details

values

public static SortRemainingBy[] 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 SortRemainingBy 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

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<SortRemainingBy>

fromValue

public static SortRemainingBy fromValue(String value)