Package com.vaadin.flow.data.provider

Enum Class SortDirection

java.lang.Object

java.lang.Enum<SortDirection>

com.vaadin.flow.data.provider.SortDirection

All Implemented Interfaces:

Serializable, Comparable<SortDirection>, Constable

public enum SortDirection
extends Enum<SortDirection>

Describes sorting direction.

Since:

1.0

Author:

Vaadin Ltd

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
ASCENDING	Ascending (e.g.
DESCENDING	Descending (e.g.

Method Summary

Modifier and Type	Method	Description
SortDirection	getOpposite()	Get the sort direction that is the direct opposite to this one.
static SortDirection	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortDirection[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ASCENDING

public static final SortDirection ASCENDING

Ascending (e.g. A-Z, 1..9) sort order

DESCENDING

public static final SortDirection DESCENDING

Descending (e.g. Z-A, 9..1) sort order

Method Details

values

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

getOpposite

public SortDirection getOpposite()

Get the sort direction that is the direct opposite to this one.

Returns:

a sort direction value