public interface ParameterDefinition
ParameterProvider
.
The parameter name is unique within the provider.
Parameters are modified through the provider.
A ParameterDefinition
instance may be a snapshot of a parameter
definition at the time it was obtained from the provider and need not reflect
subsequent modifications.
ParameterProvider
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
getFalseFlag()
Returns the false indicator for this flag parameter.
|
java.lang.Object |
getLowerBound()
Returns a lower bound on the valid values of this parameter.
|
java.lang.String |
getParameterLabel()
Returns a label for this parameter.
|
java.lang.String |
getParameterName()
Returns the name of this parameter.
|
ParameterStorage |
getParameterStorage()
Returns the storage type of this parameter.
|
ParameterType |
getParameterType()
Returns the measure of this parameter.
|
java.lang.Object |
getParameterValue()
Returns the value of this parameter.
|
java.lang.Object[] |
getSetValues()
Returns the valid values of this parameter.
|
java.lang.Object |
getTrueFlag()
Returns the true indicator for this flag parameter.
|
java.lang.Object |
getUpperBound()
Returns an upper bound on the valid values of this parameter.
|
boolean |
isValidValue(java.lang.Object value)
Returns
true if the specified value is valid for this parameter. |
java.lang.String getParameterName()
java.lang.String getParameterLabel()
java.lang.Object getParameterValue()
ParameterStorage getParameterStorage()
ParameterType getParameterType()
java.lang.Object getLowerBound()
null
if the parameter type is other than
ParameterType.RANGE
or if no lower bound has been declared for the range.java.lang.Object getUpperBound()
null
if the parameter type is other than
ParameterType.RANGE
or if no upper bound has been declared for the range.java.lang.Object[] getSetValues()
null
if the parameter type is other than
ParameterType.SET
or if no values have been declared for the set.java.lang.Object getTrueFlag()
null
if the parameter type is other than
ParameterType.FLAG
or if no true value has been declared for the flag.java.lang.Object getFalseFlag()
null
if the parameter type is other than
ParameterType.FLAG
or if no false value has been declared for the flag.boolean isValidValue(java.lang.Object value)
true
if the specified value is valid for this parameter.
The value must be compatible with the parameter storage type and with the
parameter values when they are specified.value
- the valuetrue
if the value is valid for the parameterCopyright © 2014 Integral Solutions Ltd. All Rights Reserved.