Package uk.ac.starlink.task
Class LongParameter
- java.lang.Object
-
- uk.ac.starlink.task.Parameter<java.lang.Long>
-
- uk.ac.starlink.task.LongParameter
-
public class LongParameter extends Parameter<java.lang.Long>
Parameter representing a long integer value.
-
-
Constructor Summary
Constructors Constructor Description LongParameter(java.lang.String name)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description long
longValue(Environment env)
Returns the value of this parameter as long primitive.void
setMaximum(long max)
Mandates a maximum value for this parameter.void
setMinimum(long min)
Mandates a minimum value for this parameter.java.lang.Long
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
-
stringToObject
public java.lang.Long 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.Long>
- 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
-
longValue
public long longValue(Environment env) throws TaskException
Returns the value of this parameter as long primitive.- Returns:
- long value
- Throws:
java.lang.NullPointerException
- if parameter value is null (only possible if isNullPermitted true)TaskException
-
setMinimum
public void setMinimum(long min)
Mandates a minimum value for this parameter.- Parameters:
min
- the smallest value this parameter may take
-
setMaximum
public void setMaximum(long max)
Mandates a maximum value for this parameter.- Parameters:
max
- the largest value this parameter may take.
-
-