public class BooleanParameter extends Parameter<java.lang.Boolean>
| Constructor and Description |
|---|
BooleanParameter(java.lang.String name)
Constructs a new boolean parameter.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
booleanValue(Environment env)
Returns the value of this parameter as a boolean.
|
void |
setBooleanDefault(boolean dflt)
Sets the default as a boolean value.
|
java.lang.Boolean |
stringToObject(Environment env,
java.lang.String stringval)
Takes a non-blank string, as supplied by the execution environment,
and turns it into a typed value for this parameter.
|
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectToString, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toStringpublic BooleanParameter(java.lang.String name)
name - parameter namepublic boolean booleanValue(Environment env) throws TaskException
env - execution environmentjava.lang.NullPointerException - if the value is null, only possible
if isNullPermitted is true (not by default)TaskExceptionpublic void setBooleanDefault(boolean dflt)
dflt - default valuepublic java.lang.Boolean stringToObject(Environment env, java.lang.String stringval) throws ParameterValueException
ParameterIt is an error to supply a null or empty string value.
If this method fails (throws a ParameterValueException)
and if allowClassnameValue is set, then a subsequent
attempt will be made to interpret the stringVal
as the classname of a suitable class with a no-arg constructor.
stringToObject in class Parameter<java.lang.Boolean>env - execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the resultstringval - non-null, non-empty string valueParameterValueExceptionCopyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.