|
|||||||||
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.task.ObjectFactoryParameter<T>
public class ObjectFactoryParameter<T>
Parameter whose (user-supplied) string values correspond to nicknames
from an ObjectFactory
. The Parameter.objectValue(uk.ac.starlink.task.Environment)
method returns
the corresponding object generated by the factory for that nickname.
Field Summary |
---|
Fields inherited from class uk.ac.starlink.task.Parameter |
---|
BY_NAME |
Constructor Summary | |
---|---|
ObjectFactoryParameter(String name,
ObjectFactory<T> factory)
Constructor. |
Method Summary | |
---|---|
ObjectFactory<T> |
getObjectFactory()
Returns the object factory used by this parameter. |
String |
getUsage()
Returns the usage string for this parameter. |
T |
stringToObject(Environment env,
String sval)
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, 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 ObjectFactoryParameter(String name, ObjectFactory<T> factory)
name
- parameter namefactory
- object factoryMethod Detail |
---|
public ObjectFactory<T> getObjectFactory()
public T stringToObject(Environment env, String sval) throws ParameterValueException
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 resultsval
- non-null, non-empty string value
ParameterValueException
public String getUsage()
Parameter
getUsage
in class Parameter<T>
Parameter.setUsage(java.lang.String)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |