Package uk.ac.starlink.task
Class BooleanParameter
- java.lang.Object
-
- uk.ac.starlink.task.Parameter<java.lang.Boolean>
-
- uk.ac.starlink.task.BooleanParameter
-
public class BooleanParameter extends Parameter<java.lang.Boolean>
Parameter value representing a boolean value. Permissible string values are true, false, yes and no (case insensitive).- Since:
- 9 Aug 2005
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description BooleanParameter(java.lang.String name)
Constructs a new boolean parameter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class uk.ac.starlink.task.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, toString
-
-
-
-
Method Detail
-
booleanValue
public boolean booleanValue(Environment env) throws TaskException
Returns the value of this parameter as a boolean.- Parameters:
env
- execution environment- Returns:
- boolean value
- Throws:
java.lang.NullPointerException
- if the value is null, only possible if isNullPermitted is true (not by default)TaskException
-
setBooleanDefault
public void setBooleanDefault(boolean dflt)
Sets the default as a boolean value.- Parameters:
dflt
- default value
-
stringToObject
public java.lang.Boolean stringToObject(Environment env, java.lang.String stringval) throws ParameterValueException
Description copied from class:Parameter
Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter. This method also performs validation, so if the string value is unacceptable in any way, a ParameterValueException should be thrown.It 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 thestringVal
as the classname of a suitable class with a no-arg constructor.- Specified by:
stringToObject
in classParameter<java.lang.Boolean>
- Parameters:
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 value- Returns:
- typed value
- Throws:
ParameterValueException
-
-