|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<String[]>
uk.ac.starlink.ttools.task.StringMultiParameter
public class StringMultiParameter
Convenience parameter subclass for getting a sequence of string values.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
StringMultiParameter(String name,
char valueSep)
Constructor. |
Method Summary | |
---|---|
char |
getValueSeparator()
Returns a character which is to be used as the separator between values found in adjacent occurrences of the parameter in the execution environment. |
String[] |
stringsValue(Environment env)
Returns the values of this parameter as an array. |
String[] |
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 StringMultiParameter(String name, char valueSep)
name
- parameter namevalueSep
- value separator characterMethod Detail |
---|
public char getValueSeparator()
MultiParameter
getValueSeparator
in interface MultiParameter
public String[] stringsValue(Environment env) throws TaskException
env
- execution environment
TaskException
public String[] stringToObject(Environment env, String stringVal)
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<String[]>
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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |