Package uk.ac.starlink.task
Class DoubleParameter
- java.lang.Object
-
- uk.ac.starlink.task.Parameter<java.lang.Double>
-
- uk.ac.starlink.task.DoubleParameter
-
public class DoubleParameter extends Parameter<java.lang.Double>
Parameter representing a double precision number.- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description DoubleParameter(java.lang.String name)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double
doubleValue(Environment env)
Returns the value of this parameter as a double.void
setDoubleDefault(double dflt)
Sets the default value as a floating point value.void
setMaximum(double max, boolean inclusive)
Sets the maximum acceptable value for this parameter.void
setMinimum(double min, boolean inclusive)
Sets the minimum acceptable value for this parameter.void
setValueFromString(Environment env, java.lang.String stringval)
As a special case, setting the value of this parameter with a null or empty string will result in a NaN value.java.lang.Double
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, stringValue, toArray, toString
-
-
-
-
Method Detail
-
doubleValue
public double doubleValue(Environment env) throws TaskException
Returns the value of this parameter as a double. A null string value, if permitted, will give a NaN result.- Parameters:
env
- execution environment- Returns:
- double value
- Throws:
TaskException
-
setDoubleDefault
public void setDoubleDefault(double dflt)
Sets the default value as a floating point value.- Parameters:
dflt
- new default value
-
setMinimum
public void setMinimum(double min, boolean inclusive)
Sets the minimum acceptable value for this parameter.- Parameters:
min
- minimum valueinclusive
- true iffmin
itself is permitted
-
setMaximum
public void setMaximum(double max, boolean inclusive)
Sets the maximum acceptable value for this parameter.- Parameters:
max
- maximum valueinclusive
- true iffmax
itself is permitted
-
stringToObject
public java.lang.Double stringToObject(Environment env, java.lang.String stringval) throws TaskException
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.Double>
- 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:
TaskException
-
setValueFromString
public void setValueFromString(Environment env, java.lang.String stringval) throws TaskException
As a special case, setting the value of this parameter with a null or empty string will result in a NaN value.- Overrides:
setValueFromString
in classParameter<java.lang.Double>
- Parameters:
env
- execution environment; in most cases this is not required but for some purposes environment-specific characteristics may influence the resultstringval
- string representation of value- Throws:
TaskException
-
-