com.liferay.faces.util.config

Interface ConfigParam<T>

All Known Implementing Classes:

WebConfigParam

@ProviderType
public interface ConfigParam<T>

This is a generic interface that defines the contract for getting configuration param values.

Author:

Neil Griffin

Method Summary

Modifier and Type	Method and Description
String	getAlternateName() Returns the alternate name of the config param (or null if there is not an alternate name).
boolean	getBooleanValue(T config) Returns the boolean value of the config param.
String	getConfiguredValue(T config) Returns the value of the config param that was specified in the configuration file.
boolean	getDefaultBooleanValue() Returns the default boolean value of the config param.
int	getDefaultIntegerValue() Returns the default int value of the config param.
long	getDefaultLongValue() Returns the default long value of the config param.
String	getDefaultStringValue() Returns the default String value of the config param.
int	getIntegerValue(T config) Returns the int value of the config param.
long	getLongValue(T config) Returns the long value of the config param.
String	getName() Returns the name of the config param.
String	getStringValue(T config) Returns the String value of the config param.
boolean	isConfigured(T config) Flag indicating whether or not the config param was specified in the configuration file.

Method Detail

getAlternateName

String getAlternateName()

Returns the alternate name of the config param (or null if there is not an alternate name).

getBooleanValue

boolean getBooleanValue(T config)

Returns the boolean value of the config param. If not specified in the config file, then the value of getDefaultBooleanValue() is returned.

getConfiguredValue

String getConfiguredValue(T config)

Returns the value of the config param that was specified in the configuration file.

getDefaultBooleanValue

boolean getDefaultBooleanValue()

Returns the default boolean value of the config param.

getDefaultIntegerValue

int getDefaultIntegerValue()

Returns the default int value of the config param.

getDefaultLongValue

long getDefaultLongValue()

Returns the default long value of the config param.

getDefaultStringValue

String getDefaultStringValue()

Returns the default String value of the config param.

getIntegerValue

int getIntegerValue(T config)

Returns the int value of the config param. If not specified in the config file, then the value of getDefaultIntegerValue() is returned.

getLongValue

long getLongValue(T config)

Returns the long value of the config param. If not specified in the config file, then the value of getDefaultLongValue() is returned.

getName

String getName()

Returns the name of the config param.

getStringValue

String getStringValue(T config)

Returns the String value of the config param. If not specified in the config file, then the value of getDefaultStringValue() is returned.

isConfigured

boolean isConfigured(T config)

Flag indicating whether or not the config param was specified in the configuration file.