Package com.aspectran.core.util.apon

Class ParameterValue

java.lang.Object

com.aspectran.core.util.apon.ParameterValue

All Implemented Interfaces:

Parameter

public class ParameterValue
extends java.lang.Object
implements Parameter

Constructor Summary

Constructors

Modifier	Constructor	Description
	ParameterValue(java.lang.String name, ParameterValueType parameterValueType)
	ParameterValue(java.lang.String name, ParameterValueType parameterValueType, boolean array)
	ParameterValue(java.lang.String name, ParameterValueType parameterValueType, boolean array, boolean noBracket)
protected	ParameterValue(java.lang.String name, ParameterValueType parameterValueType, boolean array, boolean noBracket, boolean predefined)
	ParameterValue(java.lang.String name, java.lang.Class<? extends AbstractParameters> parametersClass)
	ParameterValue(java.lang.String name, java.lang.Class<? extends AbstractParameters> parametersClass, boolean array)
	ParameterValue(java.lang.String name, java.lang.Class<? extends AbstractParameters> parametersClass, boolean array, boolean noBracket)
protected	ParameterValue(java.lang.String name, java.lang.Class<? extends AbstractParameters> parametersClass, boolean array, boolean noBracket, boolean predefined)

Method Summary

Modifier and Type	Method	Description
void	clearValue()	Clears the parameter value.
int	getArraySize()	Returns the size of the array if the value is an array.
Parameters	getContainer()	Returns the Parameters that contains the Parameter.
java.lang.String	getName()	Returns the parameter name.
ParameterValueType	getParameterValueType()	Returns the parameter value type.
java.lang.String	getQualifiedName()	Returns the fully qualified parameter name.
java.lang.Object	getValue()	Returns a value as an Object.
java.lang.Boolean	getValueAsBoolean()	Returns a value as a Boolean.
java.lang.Boolean[]	getValueAsBooleanArray()	Returns a value as a Boolean array.
java.util.List<java.lang.Boolean>	getValueAsBooleanList()	Returns a value as a List<Boolean>.
java.lang.Double	getValueAsDouble()	Returns a value as a Double.
java.lang.Double[]	getValueAsDoubleArray()	Returns a value as a Double array.
java.util.List<java.lang.Double>	getValueAsDoubleList()	Returns a value as a List<Double>.
java.lang.Float	getValueAsFloat()	Returns a value as a Float.
java.lang.Float[]	getValueAsFloatArray()	Returns a value as a Float array.
java.util.List<java.lang.Float>	getValueAsFloatList()	Returns a value as a List<Float>.
java.lang.Integer	getValueAsInt()	Returns a value as an Integer.
java.lang.Integer[]	getValueAsIntArray()	Returns a value as an Integer array.
java.util.List<java.lang.Integer>	getValueAsIntList()	Returns a value as a List<Integer>.
java.lang.Long	getValueAsLong()	Returns a value as a Long.
java.lang.Long[]	getValueAsLongArray()	Returns a value as a Long array.
java.util.List<java.lang.Long>	getValueAsLongList()	Returns a value as a List<Long>.
Parameters	getValueAsParameters()	Returns a value as a Parameters.
Parameters[]	getValueAsParametersArray()	Returns a value as a Parameters array.
java.util.List<Parameters>	getValueAsParametersList()	Returns a value as a List<Parameters>.
java.lang.String	getValueAsString()	Returns a value as a String.
java.lang.String[]	getValueAsStringArray()	Returns a value as a String array.
java.util.List<java.lang.String>	getValueAsStringList()	Returns a value as a List<String>.
java.util.List<?>	getValueList()	Returns a value as a List.
java.lang.Object[]	getValues()	Returns a value as an Object array.
boolean	isArray()	Returns whether the parameter value is an array.
boolean	isAssigned()	Returns whether a parameter has been assigned a value.
boolean	isBracketed()	Returns whether the value of the array is represented using square brackets.
boolean	isPredefined()	Returns whether this is a predefined parameter.
boolean	isValueTypeHinted()	Returns whether the value type is hinted.
Parameters	newParameters(Parameter identifier)	Creates a new instance of Parameters with the specified identifier Parameter.
void	putValue(java.lang.Object value)	Puts the parameter value.
void	setBracketed(boolean bracketed)
void	setContainer(Parameters container)
void	setParameterValueType(ParameterValueType parameterValueType)	Sets the parameter value type.
void	setValueTypeHinted(boolean valueTypeHinted)	Sets whether the value type is hinted.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ParameterValue

public ParameterValue(java.lang.String name,
                      ParameterValueType parameterValueType)

ParameterValue

public ParameterValue(java.lang.String name,
                      ParameterValueType parameterValueType,
                      boolean array)

ParameterValue

public ParameterValue(java.lang.String name,
                      ParameterValueType parameterValueType,
                      boolean array,
                      boolean noBracket)

ParameterValue

protected ParameterValue(java.lang.String name,
                         ParameterValueType parameterValueType,
                         boolean array,
                         boolean noBracket,
                         boolean predefined)

ParameterValue

public ParameterValue(java.lang.String name,
                      java.lang.Class<? extends AbstractParameters> parametersClass)

ParameterValue

public ParameterValue(java.lang.String name,
                      java.lang.Class<? extends AbstractParameters> parametersClass,
                      boolean array)

ParameterValue

public ParameterValue(java.lang.String name,
                      java.lang.Class<? extends AbstractParameters> parametersClass,
                      boolean array,
                      boolean noBracket)

ParameterValue

protected ParameterValue(java.lang.String name,
                         java.lang.Class<? extends AbstractParameters> parametersClass,
                         boolean array,
                         boolean noBracket,
                         boolean predefined)

Method Detail

getContainer

public Parameters getContainer()

Description copied from interface: Parameter

Returns the Parameters that contains the Parameter.

Specified by:

getContainer in interface Parameter

Returns:

the Parameters

setContainer

public void setContainer(Parameters container)

getName

public java.lang.String getName()

Description copied from interface: Parameter

Returns the parameter name.

Specified by:

getName in interface Parameter

Returns:

the parameter name

getQualifiedName

public java.lang.String getQualifiedName()

Description copied from interface: Parameter

Returns the fully qualified parameter name.

Specified by:

getQualifiedName in interface Parameter

Returns:

the qualified name

getParameterValueType

public ParameterValueType getParameterValueType()

Description copied from interface: Parameter

Returns the parameter value type.

Specified by:

getParameterValueType in interface Parameter

Returns:

the parameter value type

setParameterValueType

public void setParameterValueType(ParameterValueType parameterValueType)

Description copied from interface: Parameter

Sets the parameter value type.

Specified by:

setParameterValueType in interface Parameter

Parameters:

parameterValueType - the parameter value type

isValueTypeHinted

public boolean isValueTypeHinted()

Description copied from interface: Parameter

Returns whether the value type is hinted.

Specified by:

isValueTypeHinted in interface Parameter

Returns:

true if the value type is hinted; false otherwise

setValueTypeHinted

public void setValueTypeHinted(boolean valueTypeHinted)

Description copied from interface: Parameter

Sets whether the value type is hinted.

Specified by:

setValueTypeHinted in interface Parameter

Parameters:

valueTypeHinted - true if the value type is hinted; false otherwise

isArray

public boolean isArray()

Description copied from interface: Parameter

Returns whether the parameter value is an array.

Specified by:

isArray in interface Parameter

Returns:

true if the parameter value is an array, otherwise false

isBracketed

public boolean isBracketed()

Description copied from interface: Parameter

Returns whether the value of the array is represented using square brackets.

Specified by:

isBracketed in interface Parameter

Returns:

true if the value of the array is represented using square brackets, otherwise false

setBracketed

public void setBracketed(boolean bracketed)

isPredefined

public boolean isPredefined()

Description copied from interface: Parameter

Returns whether this is a predefined parameter.

Specified by:

isPredefined in interface Parameter

Returns:

true if this is a predefined parameter, otherwise false

isAssigned

public boolean isAssigned()

Description copied from interface: Parameter

Returns whether a parameter has been assigned a value.

Specified by:

isAssigned in interface Parameter

Returns:

true if a parameter has been assigned a value, otherwise false

getArraySize

public int getArraySize()

Description copied from interface: Parameter

Returns the size of the array if the value is an array.

Specified by:

getArraySize in interface Parameter

Returns:

the size of the array

putValue

public void putValue(java.lang.Object value)

Description copied from interface: Parameter

Puts the parameter value.

Specified by:

putValue in interface Parameter

Parameters:

value - the parameter value

clearValue

public void clearValue()

Description copied from interface: Parameter

Clears the parameter value.

Specified by:

clearValue in interface Parameter

getValue

public java.lang.Object getValue()

Description copied from interface: Parameter

Returns a value as an Object.

Specified by:

getValue in interface Parameter

Returns:

an Object

getValueList

public java.util.List<?> getValueList()

Description copied from interface: Parameter

Returns a value as a List.

Specified by:

getValueList in interface Parameter

Returns:

a List

getValues

public java.lang.Object[] getValues()

Description copied from interface: Parameter

Returns a value as an Object array.

Specified by:

getValues in interface Parameter

Returns:

an array of Object

getValueAsString

public java.lang.String getValueAsString()

Description copied from interface: Parameter

Returns a value as a String.

Specified by:

getValueAsString in interface Parameter

Returns:

a String

getValueAsStringArray

public java.lang.String[] getValueAsStringArray()

Description copied from interface: Parameter

Returns a value as a String array.

Specified by:

getValueAsStringArray in interface Parameter

Returns:

a String array

getValueAsStringList

public java.util.List<java.lang.String> getValueAsStringList()

Description copied from interface: Parameter

Returns a value as a List<String>.

Specified by:

getValueAsStringList in interface Parameter

Returns:

a List<String>

getValueAsInt

public java.lang.Integer getValueAsInt()

Description copied from interface: Parameter

Returns a value as an Integer.

Specified by:

getValueAsInt in interface Parameter

Returns:

an Integer

getValueAsIntArray

public java.lang.Integer[] getValueAsIntArray()

Description copied from interface: Parameter

Returns a value as an Integer array.

Specified by:

getValueAsIntArray in interface Parameter

Returns:

an Integer array

getValueAsIntList

public java.util.List<java.lang.Integer> getValueAsIntList()

Description copied from interface: Parameter

Returns a value as a List<Integer>.

Specified by:

getValueAsIntList in interface Parameter

Returns:

a List<Integer>

getValueAsLong

public java.lang.Long getValueAsLong()

Description copied from interface: Parameter

Returns a value as a Long.

Specified by:

getValueAsLong in interface Parameter

Returns:

a Long

getValueAsLongArray

public java.lang.Long[] getValueAsLongArray()

Description copied from interface: Parameter

Returns a value as a Long array.

Specified by:

getValueAsLongArray in interface Parameter

Returns:

a Long array

getValueAsLongList

public java.util.List<java.lang.Long> getValueAsLongList()

Description copied from interface: Parameter

Returns a value as a List<Long>.

Specified by:

getValueAsLongList in interface Parameter

Returns:

a List<Long>

getValueAsFloat

public java.lang.Float getValueAsFloat()

Description copied from interface: Parameter

Returns a value as a Float.

Specified by:

getValueAsFloat in interface Parameter

Returns:

a Float

getValueAsFloatArray

public java.lang.Float[] getValueAsFloatArray()

Description copied from interface: Parameter

Returns a value as a Float array.

Specified by:

getValueAsFloatArray in interface Parameter

Returns:

a Float array

getValueAsFloatList

public java.util.List<java.lang.Float> getValueAsFloatList()

Description copied from interface: Parameter

Returns a value as a List<Float>.

Specified by:

getValueAsFloatList in interface Parameter

Returns:

a List<Float>

getValueAsDouble

public java.lang.Double getValueAsDouble()

Description copied from interface: Parameter

Returns a value as a Double.

Specified by:

getValueAsDouble in interface Parameter

Returns:

a Double

getValueAsDoubleArray

public java.lang.Double[] getValueAsDoubleArray()

Description copied from interface: Parameter

Returns a value as a Double array.

Specified by:

getValueAsDoubleArray in interface Parameter

Returns:

a Double array

getValueAsDoubleList

public java.util.List<java.lang.Double> getValueAsDoubleList()

Description copied from interface: Parameter

Returns a value as a List<Double>.

Specified by:

getValueAsDoubleList in interface Parameter

Returns:

a List<Double>

getValueAsBoolean

public java.lang.Boolean getValueAsBoolean()

Description copied from interface: Parameter

Returns a value as a Boolean.

Specified by:

getValueAsBoolean in interface Parameter

Returns:

a Boolean

getValueAsBooleanArray

public java.lang.Boolean[] getValueAsBooleanArray()

Description copied from interface: Parameter

Returns a value as a Boolean array.

Specified by:

getValueAsBooleanArray in interface Parameter

Returns:

a Boolean array

getValueAsBooleanList

public java.util.List<java.lang.Boolean> getValueAsBooleanList()

Description copied from interface: Parameter

Returns a value as a List<Boolean>.

Specified by:

getValueAsBooleanList in interface Parameter

Returns:

a List<Boolean>

getValueAsParameters

public Parameters getValueAsParameters()

Description copied from interface: Parameter

Returns a value as a Parameters.

Specified by:

getValueAsParameters in interface Parameter

Returns:

a Parameters

getValueAsParametersArray

public Parameters[] getValueAsParametersArray()

Description copied from interface: Parameter

Returns a value as a Parameters array.

Specified by:

getValueAsParametersArray in interface Parameter

Returns:

a Parameters array

getValueAsParametersList

public java.util.List<Parameters> getValueAsParametersList()

Description copied from interface: Parameter

Returns a value as a List<Parameters>.

Specified by:

getValueAsParametersList in interface Parameter

Returns:

a List<Parameters>

newParameters

public Parameters newParameters(Parameter identifier)

Description copied from interface: Parameter

Creates a new instance of Parameters with the specified identifier Parameter.

Specified by:

newParameters in interface Parameter

Parameters:

identifier - the specified identifier Parameter

Returns:

a Parameters

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object