Package com.authlete.common.types

Enum UserIdentificationHintType

java.lang.Object

java.lang.Enum<UserIdentificationHintType>

com.authlete.common.types.UserIdentificationHintType

All Implemented Interfaces:

Serializable, Comparable<UserIdentificationHintType>

public enum UserIdentificationHintType
extends Enum<UserIdentificationHintType>

Types of hints for end-user identification.

Since:

2.32

Enum Constant Summary

Enum Constants

Enum Constant	Description
ID_TOKEN_HINT	"id_token_hint"; An ID token previously issued to the client.
LOGIN_HINT	"login_hint"; An arbitrary string whose interpretation varies depending on contexts.
LOGIN_HINT_TOKEN	"login_hint_token"; A token whose format is deployment or profile specific.

Method Summary

Modifier and Type	Method	Description
static UserIdentificationHintType	getByValue(short value)	Find an instance of this enum by a value.
short	getValue()	Get the integer representation of this enum instance.
static UserIdentificationHintType	parse(String hintType)	Convert String to HintType.
static UserIdentificationHintType[]	toArray(int bits)
static int	toBits(EnumSet<UserIdentificationHintType> set)
static EnumSet<UserIdentificationHintType>	toSet(int bits)
static EnumSet<UserIdentificationHintType>	toSet(UserIdentificationHintType[] array)
String	toString()
static UserIdentificationHintType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UserIdentificationHintType[]	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

ID_TOKEN_HINT

public static final UserIdentificationHintType ID_TOKEN_HINT

"id_token_hint"; An ID token previously issued to the client.

LOGIN_HINT

public static final UserIdentificationHintType LOGIN_HINT

"login_hint"; An arbitrary string whose interpretation varies depending on contexts.

LOGIN_HINT_TOKEN

public static final UserIdentificationHintType LOGIN_HINT_TOKEN

"login_hint_token"; A token whose format is deployment or profile specific.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public short getValue()

Get the integer representation of this enum instance.

toString

public String toString()

Overrides:

toString in class Enum<UserIdentificationHintType>

getByValue

public static UserIdentificationHintType getByValue(short value)

Find an instance of this enum by a value.

Parameters:

value - The integer representation of the instance to find.

Returns:

An instance of this enum, or null if not found.

parse

public static UserIdentificationHintType parse(String hintType)

Convert String to HintType.

Parameters:

hintType - A hint type. For example, "id_token_hint".

Returns:

HintType instance, or null.

toBits

public static int toBits(EnumSet<UserIdentificationHintType> set)

toArray

public static UserIdentificationHintType[] toArray(int bits)

toSet

public static EnumSet<UserIdentificationHintType> toSet(int bits)

toSet

public static EnumSet<UserIdentificationHintType> toSet(UserIdentificationHintType[] array)