Package org.jboss.resteasy.core.se

Enum ConfigurationOption

java.lang.Object

java.lang.Enum<ConfigurationOption>

org.jboss.resteasy.core.se.ConfigurationOption

All Implemented Interfaces:

Serializable, Comparable<ConfigurationOption>

public enum ConfigurationOption
extends Enum<ConfigurationOption>

Configurations options for configuring an SeBootstrap.Instance.

Author:

James R. Perkins

Enum Constant Summary

Enum Constants

Enum Constant	Description
EMBEDDED_SERVER
HOST
JANDEX_CLASS_PATH_FILTER
JANDEX_INDEX
PORT
PROTOCOL
REGISTER_BUILT_INS
ROOT_PATH
SSL_CLIENT_AUTHENTICATION
SSL_CONTEXT

Method Summary

Modifier and Type	Method	Description
<T> T	defaultValue()	The default value.
<T> Class<? extends T>	expectedType()	The expected type.
<T> T	getValue(jakarta.ws.rs.SeBootstrap.Configuration configuration)	Resolves the value from the configuration
String	key()	The key for the property.
static ConfigurationOption	of(String key)
String	toString()
void	validate(Object value)	Validates the value can be assigned to this configuration option.
static ConfigurationOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ConfigurationOption[]	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

PROTOCOL

public static final ConfigurationOption PROTOCOL

HOST

public static final ConfigurationOption HOST

PORT

public static final ConfigurationOption PORT

ROOT_PATH

public static final ConfigurationOption ROOT_PATH

SSL_CONTEXT

public static final ConfigurationOption SSL_CONTEXT

SSL_CLIENT_AUTHENTICATION

public static final ConfigurationOption SSL_CLIENT_AUTHENTICATION

EMBEDDED_SERVER

public static final ConfigurationOption EMBEDDED_SERVER

JANDEX_INDEX

public static final ConfigurationOption JANDEX_INDEX

JANDEX_CLASS_PATH_FILTER

public static final ConfigurationOption JANDEX_CLASS_PATH_FILTER

REGISTER_BUILT_INS

public static final ConfigurationOption REGISTER_BUILT_INS

Method Detail

values

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

Returns:

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

valueOf

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

of

public static ConfigurationOption of(String key)

getValue

public <T> T getValue(jakarta.ws.rs.SeBootstrap.Configuration configuration)

Resolves the value from the configuration

Type Parameters:

T - the type for the value

Parameters:

configuration - the configuration the value is resolved from

Returns:

the value or the default value which may be null

key

public String key()

The key for the property.

Returns:

the key for the property

defaultValue

public <T> T defaultValue()

The default value.

Type Parameters:

T - the type of the value

Returns:

the default value

expectedType

public <T> Class<? extends T> expectedType()

The expected type.

Type Parameters:

T - the type of the value

Returns:

the expected type

validate

public void validate(Object value)

Validates the value can be assigned to this configuration option.

Parameters:

value - the value to validate

Throws:

IllegalArgumentException - if the value cannot be assigned to this configuration option

toString

public String toString()

Overrides:

toString in class Enum<ConfigurationOption>