InputTablesParameter (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.task.Parameter<T>
- - uk.ac.starlink.ttools.task.AbstractInputTableParameter<TableProducer[]>
  - - uk.ac.starlink.ttools.task.InputTablesParameter

All Implemented Interfaces:

uk.ac.starlink.task.MultiParameter
```
public class InputTablesParameter
extends AbstractInputTableParameter<TableProducer[]>
implements uk.ac.starlink.task.MultiParameter
```
Parameter for specifying an indeterminate number of input tables. All use the same format specifier and streaming flag.

Since:

15 Sep 2006

Author:

Mark Taylor

Field Summary
- Fields inherited from class uk.ac.starlink.task.Parameter
  BY_NAME

Constructor Summary

Constructors
Constructor Description

InputTablesParameter(java.lang.String name)
Constructor.

Constructors
Constructor	Description
`InputTablesParameter(java.lang.String name)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`uk.ac.starlink.task.BooleanParameter`	`getMultiParameter()`	Returns the parameter which determines whether just the first or all tables in a multi-table container file will be used.
`char`	`getValueSeparator()`
`java.lang.String`	`objectToString(uk.ac.starlink.task.Environment env, TableProducer[] tables)`	Sets the value of this parameter from an array of TableProducers.
`TableProducer[]`	`stringToObject(uk.ac.starlink.task.Environment env, java.lang.String sval)`	The `toString` method of the returned elements can be used to refer to them in user-directed messages.

Methods inherited from class uk.ac.starlink.ttools.task.AbstractInputTableParameter
getFormatParameter, getLocationFormList, getStreamParameter, makeTable, makeTables, setTableDescription

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Constructor Detail
  - InputTablesParameter
```
public InputTablesParameter(java.lang.String name)
```
    Constructor.
    
    Parameters:
    
    name - parameter name
- Method Detail
  - getMultiParameter
```
public uk.ac.starlink.task.BooleanParameter getMultiParameter()
```
    Returns the parameter which determines whether just the first or all tables in a multi-table container file will be used.
    
    Returns:
    
    multi-table parameter
  - getValueSeparator
```
public char getValueSeparator()
```
    Specified by:
    
    getValueSeparator in interface uk.ac.starlink.task.MultiParameter
  - stringToObject
```
public TableProducer[] stringToObject(uk.ac.starlink.task.Environment env,
                                      java.lang.String sval)
                               throws uk.ac.starlink.task.TaskException
```
    The toString method of the returned elements can be used to refer to them in user-directed messages.
    
    Specified by:
    
    stringToObject in class uk.ac.starlink.task.Parameter<TableProducer[]>
    
    Throws:
    
    uk.ac.starlink.task.TaskException
  - objectToString
```
public java.lang.String objectToString(uk.ac.starlink.task.Environment env,
                                       TableProducer[] tables)
```
    Sets the value of this parameter from an array of TableProducers. The toString method of each element should be suitable for use in user-directed messges.
    
    Overrides:
    
    objectToString in class uk.ac.starlink.task.Parameter<TableProducer[]>

Class InputTablesParameter

Field Summary

Fields inherited from class uk.ac.starlink.task.Parameter

Constructor Summary

Method Summary

Methods inherited from class uk.ac.starlink.ttools.task.AbstractInputTableParameter

Methods inherited from class java.lang.Object

Methods inherited from class uk.ac.starlink.task.Parameter

Constructor Detail

InputTablesParameter

Method Detail

getMultiParameter

getValueSeparator

stringToObject

objectToString