uk.ac.starlink.ttools.task
Class TableFactoryParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter<StarTableFactory>
      extended by uk.ac.starlink.ttools.task.TableFactoryParameter

public class TableFactoryParameter
extends Parameter<StarTableFactory>

Parameter whose value is a StarTableFactory.

Author:
Mark Taylor

Field Summary
 
Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME
 
Constructor Summary
TableFactoryParameter(String name)
          Constructor.
 
Method Summary
static StarTableFactory createTableFactory(String sval)
          Decodes a string value which represents a particular prescription for resolving table names to table data, returning a functioning StarTableFactory object which embodies this behaviour.
 StarTableFactory 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, 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

TableFactoryParameter

public TableFactoryParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

stringToObject

public StarTableFactory stringToObject(Environment env,
                                       String sval)
                                throws TaskException
Description copied from class: Parameter
Takes a non-blank string, as supplied by the execution environment, and turns it into a typed value for this parameter. This method also performs validation, so if the string value is unacceptable in any way, a ParameterValueException should be thrown.

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.

Specified by:
stringToObject in class Parameter<StarTableFactory>
Parameters:
env - execution environment; in most cases this is not required but for some purposes environment-specific characteristics may influence the result
sval - non-null, non-empty string value
Returns:
typed value
Throws:
TaskException

createTableFactory

public static StarTableFactory createTableFactory(String sval)
                                           throws UsageException
Decodes a string value which represents a particular prescription for resolving table names to table data, returning a functioning StarTableFactory object which embodies this behaviour.

Parameters:
sval - string representation of behaviour
Returns:
table factory
Throws:
UsageException - if the string value cannot be decoded


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.