com.nimbusds.openid.connect.sdk

Enum Display

java.lang.Object

java.lang.Enum<Display>

com.nimbusds.openid.connect.sdk.Display

All Implemented Interfaces:

Serializable, Comparable<Display>

public enum Display
extends Enum<Display>

Enumeration of the display types for authentication and consent UIs.

Related specifications:

• OpenID Connect Core 1.0, section 3.1.2.1.

Enum Constant Summary

Enum Constants

Enum Constant and Description
PAGE Full user-agent page view (default).
POPUP Popup user-agent window.
TOUCH Device that leverages a touch interface.
WAP Feature phone.

Method Summary

Methods

Modifier and Type	Method and Description
static Display	getDefault() Gets the default display type.
static Display	parse(String s) Parses a display type.
String	toString() Returns the string identifier of this display type.
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

Full user-agent page view (default).

POPUP

public static final Display POPUP

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

Device that leverages a touch interface. The authorisation server may attempt to detect the touch device and further customise the interface.

WAP

public static final Display WAP

Feature phone.

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

getDefault

public static Display getDefault()

Gets the default display type.

Returns:

The default display type (PAGE).

toString

public String toString()

Returns the string identifier of this display type.

Overrides:

toString in class Enum<Display>

Returns:

The string identifier.

parse

public static Display parse(String s)
                     throws ParseException

Parses a display type.

Parameters:

s - The string to parse. If the string is null or empty the getDefault() display type will be returned.

Returns:

The display type.

Throws:

ParseException - If the parsed string doesn't match a display type.