Package com.authlete.common.types

Enum Display

java.lang.Object

java.lang.Enum<Display>

com.authlete.common.types.Display

All Implemented Interfaces:

Serializable, Comparable<Display>

public enum Display
extends Enum<Display>

Values for display.

Author:

Takahiko Kawasaki

See Also:

OpenID Connect Core 1.0, 3.1.2.1. Authentication Request

Enum Constant Summary

Enum Constants

Enum Constant	Description
PAGE	"page" (1).
POPUP	"popup" (2).
TOUCH	"touch" (3).
WAP	"wap" (4).

Method Summary

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

PAGE

public static final Display PAGE

"page" (1).

The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.

POPUP

public static final Display POPUP

"popup" (2).

The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.

TOUCH

public static final Display TOUCH

"touch" (3).

The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.

WAP

public static final Display WAP

"wap" (4).

The Authorization Server SHOULD display the authentication and consent UI consistent with a "feature phone" type display.

Method Detail

values

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

Returns:

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

valueOf

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

getByValue

public static Display 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 Display parse(String display)

Convert String to Display.

Parameters:

display - A value of display parameter. For example, "page".

Returns:

Display instance, or null.

toBits

public static int toBits(EnumSet<Display> set)

toArray

public static Display[] toArray(int bits)

toSet

public static EnumSet<Display> toSet(int bits)

toSet

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