Class LongParameter
-
Field Summary
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionlonglongValue(Environment env) Returns the value of this parameter as long primitive.voidsetMaximum(long max) Mandates a maximum value for this parameter.voidsetMinimum(long min) Mandates a minimum value for this parameter.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 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
-
Constructor Details
-
LongParameter
-
-
Method Details
-
stringToObject
Description copied from class:ParameterTakes 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
allowClassnameValueis set, then a subsequent attempt will be made to interpret thestringValas the classname of a suitable class with a no-arg constructor.- Specified by:
stringToObjectin classParameter<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
Returns the value of this parameter as long primitive.- Returns:
- long value
- Throws:
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.
-