|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<Boolean>
uk.ac.starlink.task.BooleanParameter
public class BooleanParameter
Parameter value representing a boolean value. Permissible string values are true, false, yes and no (case insensitive).
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
BooleanParameter(String name)
Constructs a new boolean parameter. |
Method Summary | |
---|---|
boolean |
booleanValue(Environment env)
Returns the value of this parameter as a boolean. |
void |
setBooleanDefault(boolean dflt)
Sets the default as a boolean value. |
Boolean |
stringToObject(Environment env,
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 |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public BooleanParameter(String name)
name
- parameter nameMethod Detail |
---|
public boolean booleanValue(Environment env) throws TaskException
env
- execution environment
NullPointerException
- if the value is null, only possible
if isNullPermitted is true (not by default)
TaskException
public void setBooleanDefault(boolean dflt)
dflt
- default valuepublic Boolean stringToObject(Environment env, String stringval) throws ParameterValueException
Parameter
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 the stringVal
as the classname of a suitable class with a no-arg constructor.
stringToObject
in class Parameter<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 value
ParameterValueException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |