public class StringMultiParameter extends Parameter<String[]> implements MultiParameter
| Constructor and Description |
|---|
StringMultiParameter(String name,
char valueSep)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
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 |
objectToString(Environment env,
String[] objVal)
Takes a typed value of this parameter and formats it as a string
which may be used for presentation to the user.
|
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.
|
clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getUsage, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, setUsage, setValue, setValueFromObject, setValueFromString, stringValue, toArray, toStringpublic StringMultiParameter(String name, char valueSep)
name - parameter namevalueSep - value separator characterpublic char getValueSeparator()
MultiParametergetValueSeparator in interface MultiParameterpublic String[] stringsValue(Environment env) throws TaskException
env - execution environmentTaskExceptionpublic String[] stringToObject(Environment env, String stringVal)
ParameterIt 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 valuepublic String objectToString(Environment env, String[] objVal) throws TaskException
ParameterstringToObject should be possible,
but that is not in general required/guaranteed.
The default implementation uses the value's toString method, but subclasses can override this for smarter behaviour.
objectToString in class Parameter<String[]>env - execution environmentobjVal - typed parameter valueTaskExceptionCopyright © 2024 Central Laboratory of the Research Councils. All Rights Reserved.