Package de.captaingoldfish.scim.sdk.common.constants.enums

Enum SortOrder

java.lang.Object

java.lang.Enum<SortOrder>

de.captaingoldfish.scim.sdk.common.constants.enums.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SortOrder>, java.lang.constant.Constable

public enum SortOrder
extends Enum<SortOrder>

author Pascal Knueppel
created at: 18.10.2019 - 17:35

gives the valid types for sort ordering

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
DESCENDING

Method Summary

Modifier and Type	Method	Description
static SortOrder	getByValue(String sortOrder)	tries to get the correct sortOrder value by the given value
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, 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 SortOrder ASCENDING

DESCENDING

public static final SortOrder DESCENDING

Method Details

values

public static SortOrder[] values()

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

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

getByValue

public static SortOrder getByValue(String sortOrder)

tries to get the correct sortOrder value by the given value

Parameters:

sortOrder - the value that should be match to one of the defined enums

Returns:

null or the sortOrder value

Throws:

BadRequestException - if the sortOrder value is not null and does not match to one of the defined enums