Parameter (Aspectran Core API Reference (5.1.1))

All Known Implementing Classes:

ParameterValue
```
public interface Parameter
```

Method Summary

All Methods Instance Methods Abstract Methods
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`	`setParameterValueType(ParameterValueType parameterValueType)`	Sets the parameter value type.
`void`	`setValueTypeHinted(boolean valueTypeHinted)`	Sets whether the value type is hinted.

- Method Detail
  - getContainer
```
Parameters getContainer()
```
    Returns the Parameters that contains the Parameter.
    
    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
  - getParameterValueType
```
ParameterValueType getParameterValueType()
```
    Returns the parameter value type.
    
    Returns:
    
    the parameter value type
  - setParameterValueType
```
void setParameterValueType(ParameterValueType parameterValueType)
```
    Sets the parameter value type.
    
    Parameters:
    
    parameterValueType - the parameter value type
  - 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, otherwise false
  - 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, otherwise false
  - isPredefined
```
boolean isPredefined()
```
    Returns whether this is a predefined parameter.
    
    Returns:
    
    true if this is a predefined parameter, otherwise false
  - isAssigned
```
boolean isAssigned()
```
    Returns whether a parameter has been assigned a value.
    
    Returns:
    
    true if a parameter has been assigned a value, otherwise false
  - 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 an Object.
    
    Returns:
    
    an Object
  - 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 an Object array.
    
    Returns:
    
    an array of Object
  - getValueList
```
java.util.List<?> getValueList()
```
    Returns a value as a List.
    
    Returns:
    
    a List
  - getValueAsString
```
java.lang.String getValueAsString()
```
    Returns a value as a String.
    
    Returns:
    
    a String
  - getValueAsStringArray
```
java.lang.String[] getValueAsStringArray()
```
    Returns a value as a String array.
    
    Returns:
    
    a String array
  - getValueAsStringList
```
java.util.List<java.lang.String> getValueAsStringList()
```
    Returns a value as a List<String>.
    
    Returns:
    
    a List<String>
  - getValueAsInt
```
java.lang.Integer getValueAsInt()
```
    Returns a value as an Integer.
    
    Returns:
    
    an Integer
  - getValueAsIntArray
```
java.lang.Integer[] getValueAsIntArray()
```
    Returns a value as an Integer array.
    
    Returns:
    
    an Integer array
  - getValueAsIntList
```
java.util.List<java.lang.Integer> getValueAsIntList()
```
    Returns a value as a List<Integer>.
    
    Returns:
    
    a List<Integer>
  - getValueAsLong
```
java.lang.Long getValueAsLong()
```
    Returns a value as a Long.
    
    Returns:
    
    a Long
  - getValueAsLongArray
```
java.lang.Long[] getValueAsLongArray()
```
    Returns a value as a Long array.
    
    Returns:
    
    a Long array
  - getValueAsLongList
```
java.util.List<java.lang.Long> getValueAsLongList()
```
    Returns a value as a List<Long>.
    
    Returns:
    
    a List<Long>
  - getValueAsFloat
```
java.lang.Float getValueAsFloat()
```
    Returns a value as a Float.
    
    Returns:
    
    a Float
  - getValueAsFloatArray
```
java.lang.Float[] getValueAsFloatArray()
```
    Returns a value as a Float array.
    
    Returns:
    
    a Float array
  - getValueAsFloatList
```
java.util.List<java.lang.Float> getValueAsFloatList()
```
    Returns a value as a List<Float>.
    
    Returns:
    
    a List<Float>
  - getValueAsDouble
```
java.lang.Double getValueAsDouble()
```
    Returns a value as a Double.
    
    Returns:
    
    a Double
  - getValueAsDoubleArray
```
java.lang.Double[] getValueAsDoubleArray()
```
    Returns a value as a Double array.
    
    Returns:
    
    a Double array
  - getValueAsDoubleList
```
java.util.List<java.lang.Double> getValueAsDoubleList()
```
    Returns a value as a List<Double>.
    
    Returns:
    
    a List<Double>
  - getValueAsBoolean
```
java.lang.Boolean getValueAsBoolean()
```
    Returns a value as a Boolean.
    
    Returns:
    
    a Boolean
  - getValueAsBooleanArray
```
java.lang.Boolean[] getValueAsBooleanArray()
```
    Returns a value as a Boolean array.
    
    Returns:
    
    a Boolean array
  - getValueAsBooleanList
```
java.util.List<java.lang.Boolean> getValueAsBooleanList()
```
    Returns a value as a List<Boolean>.
    
    Returns:
    
    a List<Boolean>
  - getValueAsParameters
```
Parameters getValueAsParameters()
```
    Returns a value as a Parameters.
    
    Returns:
    
    a Parameters
  - getValueAsParametersArray
```
Parameters[] getValueAsParametersArray()
```
    Returns a value as a Parameters array.
    
    Returns:
    
    a Parameters array
  - getValueAsParametersList
```
java.util.List<Parameters> getValueAsParametersList()
```
    Returns a value as a List<Parameters>.
    
    Returns:
    
    a List<Parameters>
  - newParameters
```
Parameters newParameters(Parameter identifier)
```
    Creates a new instance of Parameters with the specified identifier Parameter.
    
    Parameters:
    
    identifier - the specified identifier Parameter
    
    Returns:
    
    a Parameters

Interface Parameter

Method Summary

Method Detail

getContainer

getName

getQualifiedName

getParameterValueType

setParameterValueType

isValueTypeHinted

setValueTypeHinted

isArray

isBracketed

isPredefined

isAssigned

getArraySize

getValue

putValue

clearValue

getValues

getValueList

getValueAsString

getValueAsStringArray

getValueAsStringList

getValueAsInt

getValueAsIntArray

getValueAsIntList

getValueAsLong

getValueAsLongArray

getValueAsLongList

getValueAsFloat

getValueAsFloatArray

getValueAsFloatList

getValueAsDouble

getValueAsDoubleArray

getValueAsDoubleList

getValueAsBoolean

getValueAsBooleanArray

getValueAsBooleanList

getValueAsParameters

getValueAsParametersArray

getValueAsParametersList

newParameters