|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.task.Parameter<T>
uk.ac.starlink.ttools.plot2.task.ConfigParameter<T>
public class ConfigParameter<T>
Typed parameter subclass intended to get the value for a ConfigKey.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
ConfigParameter(ConfigKey<T> key)
Constructs an un-suffixed config parameter. |
Method Summary | ||
---|---|---|
static
|
createSuffixedParameter(ConfigKey<T> key,
String layerSuffix,
boolean fullDetail)
Returns a config parameter with a given suffix. |
|
String |
objectToString(Environment env,
T objval)
Takes a typed value of this parameter and formats it as a string which may be used for presentation to the user. |
|
T |
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, 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 ConfigParameter(ConfigKey<T> key)
key
- config keyMethod Detail |
---|
public T stringToObject(Environment env, String stringval) throws TaskException
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<T>
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
TaskException
public String objectToString(Environment env, T objval)
Parameter
stringToObject
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<T>
env
- execution environmentobjval
- typed parameter value
public static <T> ConfigParameter<T> createSuffixedParameter(ConfigKey<T> key, String layerSuffix, boolean fullDetail)
key
- config keylayerSuffix
- suffix part of namefullDetail
- if true, adds additional description
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |