|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<Long>
uk.ac.starlink.task.LongParameter
public class LongParameter
Parameter representing a long integer value.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
LongParameter(String name)
Constructor. |
Method Summary | |
---|---|
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. |
Long |
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 LongParameter(String name)
name
- parameter nameMethod Detail |
---|
public Long 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<Long>
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
public long longValue(Environment env) throws TaskException
NullPointerException
- if parameter value is null
(only possible if isNullPermitted true)
TaskException
public void setMinimum(long min)
min
- the smallest value this parameter may takepublic void setMaximum(long max)
max
- the largest value this parameter may take.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |