Package com.aspectran.core.util.apon

Class AbstractParameters

java.lang.Object

com.aspectran.core.util.apon.AbstractParameters

All Implemented Interfaces:

Parameters

Direct Known Subclasses:

ActionParameters, AdviceActionParameters, AdviceParameters, AppendParameters, ArrayParameters, AspectParameters, AspectranConfig, AspectranParameters, BeanParameters, ChooseWhenParameters, ContentParameters, ContentsParameters, ContextAutoReloadConfig, ContextConfig, ContextProfilesConfig, DaemonConfig, DaemonPollerConfig, DispatchParameters, EmbedConfig, EntryParameters, EnvironmentParameters, ExceptionParameters, ExceptionThrownParameters, ExposalsConfig, FilterParameters, ForwardParameters, ItemHolderParameters, ItemParameters, JoinpointParameters, PointcutParameters, PointcutQualifierParameters, RedirectParameters, RequestParameters, ResponseParameters, RootParameters, ScheduledJobParameters, ScheduleParameters, SchedulerConfig, SchedulerParameters, SessionFileStoreConfig, SessionManagerConfig, SettingParameters, SettingsParameters, ShellConfig, TemplateParameters, TransformParameters, TransletParameters, TriggerExpressionParameters, TriggerParameters, TypeAliasesParameters, TypeAliasParameters, VariableParameters, WebConfig

public abstract class AbstractParameters
extends java.lang.Object
implements Parameters

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractParameters(ParameterKey[] parameterKeys)

Method Summary

Modifier and Type	Method	Description
void	clearValue(ParameterKey parameterKey)
void	clearValue(java.lang.String name)
java.lang.String	describe()
java.lang.String	describe(boolean details)
java.lang.String	getActualName()	Returns its real name.
java.lang.Boolean	getBoolean(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
boolean	getBoolean(ParameterKey parameterKey, boolean defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Boolean	getBoolean(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
boolean	getBoolean(java.lang.String name, boolean defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Boolean[]	getBooleanArray(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Boolean[]	getBooleanArray(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Boolean>	getBooleanList(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Boolean>	getBooleanList(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Double	getDouble(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
double	getDouble(ParameterKey parameterKey, double defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Double	getDouble(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
double	getDouble(java.lang.String name, double defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Double[]	getDoubleArray(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Double[]	getDoubleArray(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Double>	getDoubleList(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Double>	getDoubleList(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Float	getFloat(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
float	getFloat(ParameterKey parameterKey, float defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Float	getFloat(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
float	getFloat(java.lang.String name, float defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Float[]	getFloatArray(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Float[]	getFloatArray(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Float>	getFloatList(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Float>	getFloatList(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Integer	getInt(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
int	getInt(ParameterKey parameterKey, int defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Integer	getInt(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
int	getInt(java.lang.String name, int defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Integer[]	getIntArray(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Integer[]	getIntArray(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Integer>	getIntList(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Integer>	getIntList(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Long	getLong(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
long	getLong(ParameterKey parameterKey, long defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Long	getLong(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
long	getLong(java.lang.String name, long defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.Long[]	getLongArray(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Long[]	getLongArray(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Long>	getLongList(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.Long>	getLongList(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
Parameter	getParameter(ParameterKey parameterKey)	Returns the Parameter corresponding to the specified parameter definition.
Parameter	getParameter(java.lang.String name)	Returns the Parameter with the specified name.
java.lang.String[]	getParameterNames()	Returns all the parameter names associated with this Parameters.
java.util.Set<java.lang.String>	getParameterNameSet()	Returns all the parameter names associated with this Parameters.
<T extends Parameters> T	getParameters(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
<T extends Parameters> T	getParameters(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
<T extends Parameters> T[]	getParametersArray(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
<T extends Parameters> T[]	getParametersArray(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
<T extends Parameters> java.util.List<T>	getParametersList(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
<T extends Parameters> java.util.List<T>	getParametersList(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
ParameterValue	getParameterValue(java.lang.String name)
java.util.Map<java.lang.String,ParameterValue>	getParameterValueMap()	Returns a map of the ParameterValues.
Parameter	getParent()	Returns the parent of the proprietor of this Parameters.
Parameter	getProprietor()	Returns the owner of this Parameters.
java.lang.String	getQualifiedName()	Returns the qualified name.
java.lang.String	getString(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.String	getString(ParameterKey parameterKey, java.lang.String defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.String	getString(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.String	getString(java.lang.String name, java.lang.String defaultValue)	Return the value for the specified parameter, or defaultValue if the parameter does not exist.
java.lang.String[]	getStringArray(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.String[]	getStringArray(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.String>	getStringList(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.util.List<java.lang.String>	getStringList(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Object	getValue(ParameterKey parameterKey)	Return the value for the specified parameter, or null if the parameter does not exist.
java.lang.Object	getValue(java.lang.String name)	Return the value for the specified parameter, or null if the parameter does not exist.
boolean	hasParameter(ParameterKey parameterKey)	Returns whether the specified parameter exists.
boolean	hasParameter(java.lang.String name)	Returns whether this parameter exists.
boolean	hasValue(ParameterKey parameterKey)	Returns whether a non-null value is assigned to the specified parameter.
boolean	hasValue(java.lang.String name)	Returns whether a non-null value is assigned to the specified parameter.
boolean	isAssigned(ParameterKey parameterKey)	Returns whether a value is assigned to the specified parameter.
boolean	isAssigned(java.lang.String name)	Returns whether a value is assigned to the specified parameter.
boolean	isStructureFixed()	Returns whether the parameter can be added after the parameters instance is created.
<T extends Parameters> T	newParameters(ParameterKey parameterKey)
<T extends Parameters> T	newParameters(java.lang.String name)
ParameterValue	newParameterValue(java.lang.String name, ValueType valueType)
ParameterValue	newParameterValue(java.lang.String name, ValueType valueType, boolean array)
void	putAll(Parameters parameters)
void	putValue(ParameterKey parameterKey, java.lang.Object value)	Put a value into the Parameter with the specified parameter definition.
void	putValue(java.lang.String name, java.lang.Object value)	Put a value into the Parameter with the specified name.
void	putValueNonNull(ParameterKey parameterKey, java.lang.Object value)	Put a value of the parameter corresponding to the given parameter definition.
void	putValueNonNull(java.lang.String name, java.lang.Object value)	Put a value of the parameter corresponding to the given name.
void	readFrom(java.lang.String apon)
void	setActualName(java.lang.String actualName)	Specifies the actual name of this Parameters.
void	setProprietor(Parameter proprietor)	Specifies the owner of this Parameters.
java.lang.String	toString()
<T extends Parameters> T	touchParameters(ParameterKey parameterKey)
<T extends Parameters> T	touchParameters(java.lang.String name)
void	updateContainer(Parameters container)	Updates the holder of the subparameters belonging to this parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractParameters

protected AbstractParameters(ParameterKey[] parameterKeys)

Method Detail

isStructureFixed

public boolean isStructureFixed()

Description copied from interface: Parameters

Returns whether the parameter can be added after the parameters instance is created.

Specified by:

isStructureFixed in interface Parameters

Returns:

true if the parameter can be added after the parameters instance is created, otherwise false

getProprietor

public Parameter getProprietor()

Description copied from interface: Parameters

Returns the owner of this Parameters.

Specified by:

getProprietor in interface Parameters

Returns:

the owner of this Parameters

setProprietor

public void setProprietor(Parameter proprietor)

Description copied from interface: Parameters

Specifies the owner of this Parameters.

Specified by:

setProprietor in interface Parameters

Parameters:

proprietor - the owner of this Parameters

getParent

public Parameter getParent()

Description copied from interface: Parameters

Returns the parent of the proprietor of this Parameters.

 proprietor --> container --> proprietor == parent
 

Specified by:

getParent in interface Parameters

Returns:

a Parameter

getActualName

public java.lang.String getActualName()

Description copied from interface: Parameters

Returns its real name. If no name is given, it returns the name given by the owner.

Specified by:

getActualName in interface Parameters

Returns:

the actual name of this Parameters

setActualName

public void setActualName(java.lang.String actualName)

Description copied from interface: Parameters

Specifies the actual name of this Parameters.

Specified by:

setActualName in interface Parameters

Parameters:

actualName - the actual name of this Parameters

getQualifiedName

public java.lang.String getQualifiedName()

Description copied from interface: Parameters

Returns the qualified name.

Specified by:

getQualifiedName in interface Parameters

Returns:

the qualified name

getParameterValue

public ParameterValue getParameterValue(java.lang.String name)

Specified by:

getParameterValue in interface Parameters

getParameterValueMap

public java.util.Map<java.lang.String,ParameterValue> getParameterValueMap()

Description copied from interface: Parameters

Returns a map of the ParameterValues.

Specified by:

getParameterValueMap in interface Parameters

Returns:

a map of the ParameterValues

getParameterNames

public java.lang.String[] getParameterNames()

Description copied from interface: Parameters

Returns all the parameter names associated with this Parameters.

Specified by:

getParameterNames in interface Parameters

Returns:

an array of all parameter names associated with this Parameters

getParameterNameSet

public java.util.Set<java.lang.String> getParameterNameSet()

Description copied from interface: Parameters

Returns all the parameter names associated with this Parameters.

Specified by:

getParameterNameSet in interface Parameters

Returns:

the Set with all parameter names associated with this Parameters

hasParameter

public boolean hasParameter(java.lang.String name)

Description copied from interface: Parameters

Returns whether this parameter exists.

Specified by:

hasParameter in interface Parameters

Parameters:

name - the name of the parameter to check

Returns:

true if the specified parameter exists; false otherwise

hasParameter

public boolean hasParameter(ParameterKey parameterKey)

Description copied from interface: Parameters

Returns whether the specified parameter exists.

Specified by:

hasParameter in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

true if the specified parameter exists; false otherwise

isAssigned

public boolean isAssigned(java.lang.String name)

Description copied from interface: Parameters

Returns whether a value is assigned to the specified parameter. Even if a null is assigned, it is valid.

Specified by:

isAssigned in interface Parameters

Parameters:

name - the name of the parameter to check

Returns:

true if a parameter is assigned a value; false otherwise

isAssigned

public boolean isAssigned(ParameterKey parameterKey)

Description copied from interface: Parameters

Returns whether a value is assigned to the specified parameter. Even if a null is assigned, it is valid.

Specified by:

isAssigned in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

true if a parameter is assigned a value; false otherwise

hasValue

public boolean hasValue(java.lang.String name)

Description copied from interface: Parameters

Returns whether a non-null value is assigned to the specified parameter.

Specified by:

hasValue in interface Parameters

Parameters:

name - the name of the parameter to check

Returns:

true if a non-null value is assigned a value; false otherwise

hasValue

public boolean hasValue(ParameterKey parameterKey)

Description copied from interface: Parameters

Returns whether a non-null value is assigned to the specified parameter.

Specified by:

hasValue in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

true if a non-null value is assigned a value; false otherwise

getParameter

public Parameter getParameter(java.lang.String name)

Description copied from interface: Parameters

Returns the Parameter with the specified name.

Specified by:

getParameter in interface Parameters

Parameters:

name - the parameter name

Returns:

the Parameter with the specified name, or null if it does not exist

getParameter

public Parameter getParameter(ParameterKey parameterKey)

Description copied from interface: Parameters

Returns the Parameter corresponding to the specified parameter definition.

Specified by:

getParameter in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the Parameter corresponding to the specified parameter definition, or null if it does not exist

getValue

public java.lang.Object getValue(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getValue in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getValue

public java.lang.Object getValue(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getValue in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

putAll

public void putAll(Parameters parameters)

Specified by:

putAll in interface Parameters

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value)

Description copied from interface: Parameters

Put a value into the Parameter with the specified name.

Specified by:

putValue in interface Parameters

Parameters:

name - the parameter name

value - the value of parameter

putValue

public void putValue(ParameterKey parameterKey,
                     java.lang.Object value)

Description copied from interface: Parameters

Put a value into the Parameter with the specified parameter definition.

Specified by:

putValue in interface Parameters

Parameters:

parameterKey - the parameter definition

value - the value of parameter

putValueNonNull

public void putValueNonNull(java.lang.String name,
                            java.lang.Object value)

Description copied from interface: Parameters

Put a value of the parameter corresponding to the given name. If the value is null, ignore it.

Specified by:

putValueNonNull in interface Parameters

Parameters:

name - the parameter name

value - the value of parameter

putValueNonNull

public void putValueNonNull(ParameterKey parameterKey,
                            java.lang.Object value)

Description copied from interface: Parameters

Put a value of the parameter corresponding to the given parameter definition. If the value is null, ignore it.

Specified by:

putValueNonNull in interface Parameters

Parameters:

parameterKey - the parameter definition

value - the value of parameter

clearValue

public void clearValue(java.lang.String name)

Specified by:

clearValue in interface Parameters

clearValue

public void clearValue(ParameterKey parameterKey)

Specified by:

clearValue in interface Parameters

getString

public java.lang.String getString(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getString in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getString

public java.lang.String getString(java.lang.String name,
                                  java.lang.String defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getString in interface Parameters

Parameters:

name - the parameter name

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getString

public java.lang.String getString(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getString in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getString

public java.lang.String getString(ParameterKey parameterKey,
                                  java.lang.String defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getString in interface Parameters

Parameters:

parameterKey - the parameter definition

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getStringArray

public java.lang.String[] getStringArray(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getStringArray in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getStringArray

public java.lang.String[] getStringArray(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getStringArray in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getStringList in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getStringList

public java.util.List<java.lang.String> getStringList(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getStringList in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getInt

public java.lang.Integer getInt(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getInt in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getInt

public int getInt(java.lang.String name,
                  int defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getInt in interface Parameters

Parameters:

name - the parameter name

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getIntArray

public java.lang.Integer[] getIntArray(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getIntArray in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getInt

public java.lang.Integer getInt(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getInt in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getInt

public int getInt(ParameterKey parameterKey,
                  int defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getInt in interface Parameters

Parameters:

parameterKey - the parameter definition

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getIntArray

public java.lang.Integer[] getIntArray(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getIntArray in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getIntList

public java.util.List<java.lang.Integer> getIntList(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getIntList in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getIntList

public java.util.List<java.lang.Integer> getIntList(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getIntList in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getLong

public java.lang.Long getLong(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getLong in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getLong

public long getLong(java.lang.String name,
                    long defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getLong in interface Parameters

Parameters:

name - the parameter name

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getLong

public java.lang.Long getLong(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getLong in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getLong

public long getLong(ParameterKey parameterKey,
                    long defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getLong in interface Parameters

Parameters:

parameterKey - the parameter definition

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getLongArray

public java.lang.Long[] getLongArray(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getLongArray in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getLongArray

public java.lang.Long[] getLongArray(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getLongArray in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getLongList

public java.util.List<java.lang.Long> getLongList(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getLongList in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getLongList

public java.util.List<java.lang.Long> getLongList(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getLongList in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getFloat

public java.lang.Float getFloat(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getFloat in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getFloat

public float getFloat(java.lang.String name,
                      float defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getFloat in interface Parameters

Parameters:

name - the parameter name

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getFloat

public java.lang.Float getFloat(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getFloat in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getFloat

public float getFloat(ParameterKey parameterKey,
                      float defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getFloat in interface Parameters

Parameters:

parameterKey - the parameter definition

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getFloatArray

public java.lang.Float[] getFloatArray(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getFloatArray in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getFloatArray

public java.lang.Float[] getFloatArray(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getFloatArray in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getFloatList

public java.util.List<java.lang.Float> getFloatList(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getFloatList in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getFloatList

public java.util.List<java.lang.Float> getFloatList(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getFloatList in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getDouble

public java.lang.Double getDouble(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getDouble in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getDouble

public double getDouble(java.lang.String name,
                        double defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getDouble in interface Parameters

Parameters:

name - the parameter name

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getDouble

public java.lang.Double getDouble(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getDouble in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getDouble

public double getDouble(ParameterKey parameterKey,
                        double defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getDouble in interface Parameters

Parameters:

parameterKey - the parameter definition

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getDoubleArray

public java.lang.Double[] getDoubleArray(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getDoubleArray in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getDoubleArray

public java.lang.Double[] getDoubleArray(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getDoubleArray in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getDoubleList

public java.util.List<java.lang.Double> getDoubleList(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getDoubleList in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getDoubleList

public java.util.List<java.lang.Double> getDoubleList(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getDoubleList in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getBoolean in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getBoolean

public boolean getBoolean(java.lang.String name,
                          boolean defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getBoolean in interface Parameters

Parameters:

name - the parameter name

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getBoolean

public java.lang.Boolean getBoolean(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getBoolean in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getBoolean

public boolean getBoolean(ParameterKey parameterKey,
                          boolean defaultValue)

Description copied from interface: Parameters

Return the value for the specified parameter, or defaultValue if the parameter does not exist.

Specified by:

getBoolean in interface Parameters

Parameters:

parameterKey - the parameter definition

defaultValue - the default value to return if no value is found

Returns:

the value for the specified parameter, or defaultValue

getBooleanArray

public java.lang.Boolean[] getBooleanArray(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getBooleanArray in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getBooleanArray

public java.lang.Boolean[] getBooleanArray(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getBooleanArray in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getBooleanList

public java.util.List<java.lang.Boolean> getBooleanList(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getBooleanList in interface Parameters

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getBooleanList

public java.util.List<java.lang.Boolean> getBooleanList(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getBooleanList in interface Parameters

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getParameters

public <T extends Parameters> T getParameters(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getParameters in interface Parameters

Type Parameters:

T - the type parameter

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getParameters

public <T extends Parameters> T getParameters(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getParameters in interface Parameters

Type Parameters:

T - the type parameter

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getParametersArray

public <T extends Parameters> T[] getParametersArray(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getParametersArray in interface Parameters

Type Parameters:

T - the type parameter

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getParametersArray

public <T extends Parameters> T[] getParametersArray(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getParametersArray in interface Parameters

Type Parameters:

T - the type parameter

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

getParametersList

public <T extends Parameters> java.util.List<T> getParametersList(java.lang.String name)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getParametersList in interface Parameters

Type Parameters:

T - the type parameter

Parameters:

name - the parameter name

Returns:

the value for the specified parameter, or null

getParametersList

public <T extends Parameters> java.util.List<T> getParametersList(ParameterKey parameterKey)

Description copied from interface: Parameters

Return the value for the specified parameter, or null if the parameter does not exist.

Specified by:

getParametersList in interface Parameters

Type Parameters:

T - the type parameter

Parameters:

parameterKey - the parameter definition

Returns:

the value for the specified parameter, or null

newParameterValue

public ParameterValue newParameterValue(java.lang.String name,
                                        ValueType valueType)

Specified by:

newParameterValue in interface Parameters

newParameterValue

public ParameterValue newParameterValue(java.lang.String name,
                                        ValueType valueType,
                                        boolean array)

Specified by:

newParameterValue in interface Parameters

newParameters

public <T extends Parameters> T newParameters(java.lang.String name)

Specified by:

newParameters in interface Parameters

newParameters

public <T extends Parameters> T newParameters(ParameterKey parameterKey)

Specified by:

newParameters in interface Parameters

touchParameters

public <T extends Parameters> T touchParameters(java.lang.String name)

Specified by:

touchParameters in interface Parameters

touchParameters

public <T extends Parameters> T touchParameters(ParameterKey parameterKey)

Specified by:

touchParameters in interface Parameters

updateContainer

public void updateContainer(Parameters container)

Description copied from interface: Parameters

Updates the holder of the subparameters belonging to this parameter.

Specified by:

updateContainer in interface Parameters

readFrom

public void readFrom(java.lang.String apon)
              throws java.io.IOException

Specified by:

readFrom in interface Parameters

Throws:

java.io.IOException

describe

public java.lang.String describe()

Specified by:

describe in interface Parameters

describe

public java.lang.String describe(boolean details)

Specified by:

describe in interface Parameters

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object