public class ConnectionParameter extends Parameter<Connection>
| Constructor and Description |
|---|
ConnectionParameter(String name)
Constructor.
|
| Modifier and Type | Method and Description |
|---|---|
Parameter<?>[] |
getAssociatedParameters()
Returns parameters associated with this.
|
String |
objectToString(Environment env,
Connection connection)
Takes a typed value of this parameter and formats it as a string
which may be used for presentation to the user.
|
Connection |
stringToObject(Environment env,
String stringValue)
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 ConnectionParameter(String name)
name - parameter namepublic Parameter<?>[] getAssociatedParameters()
public Connection stringToObject(Environment env, String stringValue) throws TaskException
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<Connection>env - execution environment; in most cases this is not required
but for some purposes environment-specific characteristics
may influence the resultstringValue - non-null, non-empty string valueTaskExceptionpublic String objectToString(Environment env, Connection connection)
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<Connection>env - execution environmentconnection - typed parameter valueCopyright © 2025 Central Laboratory of the Research Councils. All Rights Reserved.