|
jlscp v0.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Parameter<T>
Defines the generic properties that every parameter should have.
Method Summary | |
---|---|
T |
getDefault()
Gets the default value for this parameter. |
java.lang.String[] |
getDependances()
Gets a String array with parameter's names this parameter depends on. |
java.lang.String |
getDescription()
Gets the description of this parameter. |
java.lang.String |
getName()
Gets the name of this parameter. |
T[] |
getPossibilities()
Gets a list of possible values for this parameter. |
java.lang.Number |
getRangeMax()
Gets the upper limit of the allowed value range for this parameter. |
java.lang.Number |
getRangeMin()
Gets the lower limit of the allowed value range for this parameter. |
java.lang.String |
getStringValue()
Gets a character string representation of the parameter's value. |
ParameterType |
getType()
Gets the type of this parameter. |
T |
getValue()
Gets the current value of this parameter. |
boolean |
hasDependances()
Checks if this parameter depends on some other parameter(s). |
boolean |
hasPossibilities()
Determines whether this parameter has a list of possible values. |
boolean |
hasRangeMax()
Determines whether this parameter has an upper limit. |
boolean |
hasRangeMin()
Determines whether this parameter has a lower limit. |
boolean |
isFixed()
Defines if this parameter can be altered. |
boolean |
isMandatory()
Defines if this parameter must be given when the device is to be created. |
boolean |
isMultiplicity()
Defines if this parameter allows only one value or list of values. |
void |
parseValue(java.lang.String s)
Parses the specified character string and sets the value of this parameter with the parsed result. |
void |
setName(java.lang.String name)
Sets the name of this parameter. |
void |
setValue(T val)
Sets the current value of this parameter. |
Method Detail |
---|
java.lang.String getName()
void setName(java.lang.String name)
name
- A String
instance containing the new name for this parameter.void parseValue(java.lang.String s) throws LscpException
s
- A character string containing the value to be parsed.
LscpException
- If the parsing failed.java.lang.String getStringValue()
java.lang.String getDescription()
ParameterType getType()
T getValue()
void setValue(T val)
val
- The new value for this parameter.T getDefault()
boolean isFixed()
true
if the parameter is readonly and false
if the parameter can be altered.boolean isMultiplicity()
false
if this parameter allows only one value and true
if allows a list of values.boolean isMandatory()
true
if this parameter must be given when the device
is to be created and false
otherwise.boolean hasDependances()
true
if this parameter depends on some other parameter(s)
and false
otherwise.java.lang.String[] getDependances()
String
array with parameter's names this parameter depends on.
String
array with parameter's names this parameter depends on
or null
if this parameter has no dependances.boolean hasRangeMin()
true
if this parameter has a lower limit,
false
otherwise.java.lang.Number getRangeMin()
null
if the parameter doesn't have lower limit.boolean hasRangeMax()
true
if this parameter has an upper limit,
false
otherwise.java.lang.Number getRangeMax()
null
if the parameter doesn't have upper limit.boolean hasPossibilities()
true
if this parameter has a list of possible values,
false
otherwise.T[] getPossibilities()
|
jlscp v0.8 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |