Package africa.absa.inception.security

Enum UserSortBy

java.lang.Object

java.lang.Enum<UserSortBy>

africa.absa.inception.security.UserSortBy

All Implemented Interfaces:

Serializable, Comparable<UserSortBy>

public enum UserSortBy
extends Enum<UserSortBy>

The UserSortBy enumeration defines the possible methods used to sort a list of users.

Author:

Marcus Portmann

Enum Constant Summary

Enum Constants

Enum Constant	Description
NAME	Sort by name.
PREFERRED_NAME	Sort by preferred name.
USERNAME	Sort by username.

Method Summary

Modifier and Type	Method	Description
String	code()	Returns the code for the method used to sort a list of users.
String	description()	Returns the description for the method used to sort a list of users.
static UserSortBy	fromCode(String code)	Returns the method used to sort a list of users given by the specified code value.
String	toString()	Return the string representation of the method used to sort a list of users enumeration value.
static UserSortBy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UserSortBy[]	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

NAME

public static final UserSortBy NAME

Sort by name.

PREFERRED_NAME

public static final UserSortBy PREFERRED_NAME

Sort by preferred name.

USERNAME

public static final UserSortBy USERNAME

Sort by username.

Method Detail

values

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

Returns:

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

valueOf

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

fromCode

public static UserSortBy fromCode(String code)

Returns the method used to sort a list of users given by the specified code value.

Parameters:

code - the code for the method used to sort a list of users

Returns:

the method used to sort a list of users given by the specified code value

code

public String code()

Returns the code for the method used to sort a list of users.

Returns:

the code for the method used to sort a list of users

description

public String description()

Returns the description for the method used to sort a list of users.

Returns:

the description for the method used to sort a list of users

toString

public String toString()

Return the string representation of the method used to sort a list of users enumeration value.

Overrides:

toString in class Enum<UserSortBy>

Returns:

the string representation of the method used to sort a list of users enumeration value