|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NamedParams
Interface to implement named parameters.
Method Summary | |
---|---|
void |
activateParameters()
Activate the currently set parameters |
void |
addParameterDefinition(String key,
String defValue,
String description)
Add a parameter definition to this set. |
void |
clearParameters()
Clear all parameters |
void |
copyParametersFrom(NamedParams params)
Copy params to these named parameters (clearing out first). |
void |
eraseParameters()
Clear the values. |
String |
getParameterDefault(String key)
Get the default value of a parameter. |
String |
getParameterDescription(String key)
Get the description of a parameter. |
String |
getParameterValue(String key)
Get the value of a parameter. |
String[] |
listParameters()
List the parameters. |
void |
setParameterValue(String key,
String value)
Set the value of a parameter. |
Method Detail |
---|
void addParameterDefinition(String key, String defValue, String description) throws DuplicateParamException
key
- Name of the parameter.defValue
- default value.description
- Description of the parameter.
DuplicateParamException
- Upon duplicate parameter definitionsvoid setParameterValue(String key, String value) throws UnknownParamException
key
- key to set value ofvalue
- value to set it to.
UnknownParamException
- Parameter 'key' is unknown.String getParameterValue(String key) throws UnknownParamException
key
- Key to get value for.
UnknownParamException
- Parameter 'key' is unknown.String getParameterDescription(String key) throws UnknownParamException
key
- Key to get value for.
UnknownParamException
- Parameter 'key' is unknown.String getParameterDefault(String key) throws UnknownParamException
key
- Key to get value for.
UnknownParamException
- Parameter 'key' is unknown.String[] listParameters()
void eraseParameters()
void copyParametersFrom(NamedParams params)
params
- the parameters to copy from.void activateParameters()
void clearParameters()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |