|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<Double>
uk.ac.starlink.task.DoubleParameter
public class DoubleParameter
Parameter representing a double precision number.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
DoubleParameter(String name)
Constructor. |
Method Summary | |
---|---|
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,
String stringval)
As a special case, setting the value of this parameter with a null or empty string will result in a NaN value. |
Double |
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, stringValue, toArray, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DoubleParameter(String name)
name
- parameter nameMethod Detail |
---|
public double doubleValue(Environment env) throws TaskException
env
- execution environment
TaskException
public void setDoubleDefault(double dflt)
dflt
- new default valuepublic void setMinimum(double min, boolean inclusive)
min
- minimum valueinclusive
- true iff min
itself is permittedpublic void setMaximum(double max, boolean inclusive)
max
- maximum valueinclusive
- true iff max
itself is permittedpublic Double stringToObject(Environment env, String stringval) throws TaskException
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<Double>
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
TaskException
public void setValueFromString(Environment env, String stringval) throws TaskException
setValueFromString
in class Parameter<Double>
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
TaskException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |