Package com.aspectran.core.util.apon
Interface Parameter
-
- All Known Implementing Classes:
ParameterValue
public interface Parameter
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
arraylize()
Change parameter type to array type.void
clearValue()
Clears the parameter value.int
getArraySize()
Returns the size of the array if the value is an array.Parameters
getContainer()
Returns theParameters
that contains theParameter
.java.lang.String
getName()
Returns the parameter name.java.lang.String
getQualifiedName()
Returns the fully qualified parameter name.java.lang.Object
getValue()
Returns a value as anObject
.java.lang.Boolean
getValueAsBoolean()
Returns a value as aBoolean
.java.lang.Boolean[]
getValueAsBooleanArray()
Returns a value as aBoolean
array.java.util.List<java.lang.Boolean>
getValueAsBooleanList()
Returns a value as aList<Boolean>
.java.lang.Double
getValueAsDouble()
Returns a value as aDouble
.java.lang.Double[]
getValueAsDoubleArray()
Returns a value as aDouble
array.java.util.List<java.lang.Double>
getValueAsDoubleList()
Returns a value as aList<Double>
.java.lang.Float
getValueAsFloat()
Returns a value as aFloat
.java.lang.Float[]
getValueAsFloatArray()
Returns a value as aFloat
array.java.util.List<java.lang.Float>
getValueAsFloatList()
Returns a value as aList<Float>
.java.lang.Integer
getValueAsInt()
Returns a value as anInteger
.java.lang.Integer[]
getValueAsIntArray()
Returns a value as anInteger
array.java.util.List<java.lang.Integer>
getValueAsIntList()
Returns a value as aList<Integer>
.java.lang.Long
getValueAsLong()
Returns a value as aLong
.java.lang.Long[]
getValueAsLongArray()
Returns a value as aLong
array.java.util.List<java.lang.Long>
getValueAsLongList()
Returns a value as aList<Long>
.Parameters
getValueAsParameters()
Returns a value as aParameters
.Parameters[]
getValueAsParametersArray()
Returns a value as aParameters
array.java.util.List<Parameters>
getValueAsParametersList()
Returns a value as aList<Parameters>
.java.lang.String
getValueAsString()
Returns a value as aString
.java.lang.String[]
getValueAsStringArray()
Returns a value as aString
array.java.util.List<java.lang.String>
getValueAsStringList()
Returns a value as aList<String>
.java.util.List<?>
getValueList()
Returns a value as aList
.java.lang.Object[]
getValues()
Returns a value as anObject
array.ValueType
getValueType()
Returns the parameter value type.boolean
hasValue()
Returns whether a non-null value has been assigned.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
isValueTypeFixed()
Returns whether this is a predefined parameter.boolean
isValueTypeHinted()
Returns whether the value type is hinted.<T extends Parameters>
TnewParameters(Parameter identifier)
Creates a new instance ofParameters
with the specified identifierParameter
.void
putValue(java.lang.Object value)
Puts the parameter value.void
setValueType(ValueType valueType)
Sets the parameter value type.void
setValueTypeHinted(boolean valueTypeHinted)
Sets whether the value type is hinted.
-
-
-
Method Detail
-
getContainer
Parameters getContainer()
Returns theParameters
that contains theParameter
.- Returns:
- the
Parameters
-
getName
java.lang.String getName()
Returns the parameter name.- Returns:
- the parameter name
-
getQualifiedName
java.lang.String getQualifiedName()
Returns the fully qualified parameter name.- Returns:
- the qualified name
-
getValueType
ValueType getValueType()
Returns the parameter value type.- Returns:
- the parameter value type
-
setValueType
void setValueType(ValueType valueType)
Sets the parameter value type.- Parameters:
valueType
- the parameter value type
-
isValueTypeFixed
boolean isValueTypeFixed()
Returns whether this is a predefined parameter.- Returns:
true
if this is a predefined parameter, otherwisefalse
-
isValueTypeHinted
boolean isValueTypeHinted()
Returns whether the value type is hinted.- Returns:
- true if the value type is hinted; false otherwise
-
setValueTypeHinted
void setValueTypeHinted(boolean valueTypeHinted)
Sets whether the value type is hinted.- Parameters:
valueTypeHinted
- true if the value type is hinted; false otherwise
-
isArray
boolean isArray()
Returns whether the parameter value is an array.- Returns:
true
if the parameter value is an array, otherwisefalse
-
isBracketed
boolean isBracketed()
Returns whether the value of the array is represented using square brackets.- Returns:
true
if the value of the array is represented using square brackets, otherwisefalse
-
isAssigned
boolean isAssigned()
Returns whether a parameter has been assigned a value. Even if a null is assigned, it is valid.- Returns:
true
if a parameter has been assigned a value, otherwisefalse
-
hasValue
boolean hasValue()
Returns whether a non-null value has been assigned.- Returns:
true
if a non-null value is assigned, otherwisefalse
-
getArraySize
int getArraySize()
Returns the size of the array if the value is an array.- Returns:
- the size of the array
-
getValue
java.lang.Object getValue()
Returns a value as anObject
.- Returns:
- an
Object
-
arraylize
void arraylize()
Change parameter type to array type.
-
putValue
void putValue(java.lang.Object value)
Puts the parameter value.- Parameters:
value
- the parameter value
-
clearValue
void clearValue()
Clears the parameter value.
-
getValues
java.lang.Object[] getValues()
Returns a value as anObject
array.- Returns:
- an array of
Object
-
getValueList
java.util.List<?> getValueList()
Returns a value as aList
.- Returns:
- a
List
-
getValueAsString
java.lang.String getValueAsString()
Returns a value as aString
.- Returns:
- a
String
-
getValueAsStringArray
java.lang.String[] getValueAsStringArray()
Returns a value as aString
array.- Returns:
- a
String
array
-
getValueAsStringList
java.util.List<java.lang.String> getValueAsStringList()
Returns a value as aList<String>
.- Returns:
- a
List<String>
-
getValueAsInt
java.lang.Integer getValueAsInt()
Returns a value as anInteger
.- Returns:
- an
Integer
-
getValueAsIntArray
java.lang.Integer[] getValueAsIntArray()
Returns a value as anInteger
array.- Returns:
- an
Integer
array
-
getValueAsIntList
java.util.List<java.lang.Integer> getValueAsIntList()
Returns a value as aList<Integer>
.- Returns:
- a
List<Integer>
-
getValueAsLong
java.lang.Long getValueAsLong()
Returns a value as aLong
.- Returns:
- a
Long
-
getValueAsLongArray
java.lang.Long[] getValueAsLongArray()
Returns a value as aLong
array.- Returns:
- a
Long
array
-
getValueAsLongList
java.util.List<java.lang.Long> getValueAsLongList()
Returns a value as aList<Long>
.- Returns:
- a
List<Long>
-
getValueAsFloat
java.lang.Float getValueAsFloat()
Returns a value as aFloat
.- Returns:
- a
Float
-
getValueAsFloatArray
java.lang.Float[] getValueAsFloatArray()
Returns a value as aFloat
array.- Returns:
- a
Float
array
-
getValueAsFloatList
java.util.List<java.lang.Float> getValueAsFloatList()
Returns a value as aList<Float>
.- Returns:
- a
List<Float>
-
getValueAsDouble
java.lang.Double getValueAsDouble()
Returns a value as aDouble
.- Returns:
- a
Double
-
getValueAsDoubleArray
java.lang.Double[] getValueAsDoubleArray()
Returns a value as aDouble
array.- Returns:
- a
Double
array
-
getValueAsDoubleList
java.util.List<java.lang.Double> getValueAsDoubleList()
Returns a value as aList<Double>
.- Returns:
- a
List<Double>
-
getValueAsBoolean
java.lang.Boolean getValueAsBoolean()
Returns a value as aBoolean
.- Returns:
- a
Boolean
-
getValueAsBooleanArray
java.lang.Boolean[] getValueAsBooleanArray()
Returns a value as aBoolean
array.- Returns:
- a
Boolean
array
-
getValueAsBooleanList
java.util.List<java.lang.Boolean> getValueAsBooleanList()
Returns a value as aList<Boolean>
.- Returns:
- a
List<Boolean>
-
getValueAsParameters
Parameters getValueAsParameters()
Returns a value as aParameters
.- Returns:
- a
Parameters
-
getValueAsParametersArray
Parameters[] getValueAsParametersArray()
Returns a value as aParameters
array.- Returns:
- a
Parameters
array
-
getValueAsParametersList
java.util.List<Parameters> getValueAsParametersList()
Returns a value as aList<Parameters>
.- Returns:
- a
List<Parameters>
-
newParameters
<T extends Parameters> T newParameters(Parameter identifier)
Creates a new instance ofParameters
with the specified identifierParameter
.- Type Parameters:
T
- the type of the new Parameters object- Parameters:
identifier
- the specified identifierParameter
- Returns:
- a
Parameters
-
-