Module jakarta.faces

Package com.sun.faces.context

Enum Class ContextParam

java.lang.Object

java.lang.Enum<ContextParam>

com.sun.faces.context.ContextParam

All Implemented Interfaces:

Serializable, Comparable<ContextParam>, Constable

public enum ContextParam
extends Enum<ContextParam>

The enumeration of all our context-param entries.

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
EnableDistributable	Enable distributable code.
SendPoweredByHeader	Send the "X-Powered-By" header.
WebsocketEndpointPort	The websocket endpoint port (default 0 means the code will take the port from the request)

Method Summary

Modifier and Type	Method	Description
Object	getDefaultValue()	Get the default value.
<T> T	getDefaultValue(Class<T> clazz)	Get the default value.
String	getName()	Get the name.
Class	getType()	Get the type.
static ContextParam	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ContextParam[]	values()	Returns an array containing the constants of this enum class, 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

EnableDistributable

public static final ContextParam EnableDistributable

Enable distributable code.

SendPoweredByHeader

public static final ContextParam SendPoweredByHeader

Send the "X-Powered-By" header.

WebsocketEndpointPort

public static final ContextParam WebsocketEndpointPort

The websocket endpoint port (default 0 means the code will take the port from the request)

Method Details

values

public static ContextParam[] values()

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

Returns:

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

valueOf

public static ContextParam valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getDefaultValue

public Object getDefaultValue()

Get the default value.

Returns:

the default value.

getDefaultValue

public <T> T getDefaultValue(Class<T> clazz)

Get the default value.

Type Parameters:

T - the type.

Parameters:

clazz - the class.

Returns:

the default value.

getName

public String getName()

Get the name.

Returns:

the name.

getType

public Class getType()

Get the type.

Returns:

the type.