StringMultiParameter (Starjava TTOOLS API)

java.lang.Object
- uk.ac.starlink.task.Parameter<java.lang.String[]>
- - uk.ac.starlink.ttools.task.StringMultiParameter

All Implemented Interfaces:

uk.ac.starlink.task.MultiParameter
```
public class StringMultiParameter
extends uk.ac.starlink.task.Parameter<java.lang.String[]>
implements uk.ac.starlink.task.MultiParameter
```
Convenience parameter subclass for getting a sequence of string values.

Since:

13 Oct 2008

Author:

Mark Taylor

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

Constructor Summary

Constructors
Constructor Description

StringMultiParameter(java.lang.String name, char valueSep)
Constructor.

Constructors
Constructor	Description
`StringMultiParameter(java.lang.String name, char valueSep)`	Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`char`	`getValueSeparator()`
`java.lang.String`	`objectToString(uk.ac.starlink.task.Environment env, java.lang.String[] objVal)`
`java.lang.String[]`	`stringsValue(uk.ac.starlink.task.Environment env)`	Returns the values of this parameter as an array.
`java.lang.String[]`	`stringToObject(uk.ac.starlink.task.Environment env, java.lang.String stringVal)`

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
  - StringMultiParameter
```
public StringMultiParameter(java.lang.String name,
                            char valueSep)
```
    Constructor.
    
    Parameters:
    
    name - parameter name
    
    valueSep - value separator character
- Method Detail
  - getValueSeparator
```
public char getValueSeparator()
```
    Specified by:
    
    getValueSeparator in interface uk.ac.starlink.task.MultiParameter
  - stringsValue
```
public java.lang.String[] stringsValue(uk.ac.starlink.task.Environment env)
                                throws uk.ac.starlink.task.TaskException
```
    Returns the values of this parameter as an array. If the value is null, an empty array is returned.
    
    Parameters:
    
    env - execution environment
    
    Returns:
    
    array of individual values
    
    Throws:
    
    uk.ac.starlink.task.TaskException
  - stringToObject
```
public java.lang.String[] stringToObject(uk.ac.starlink.task.Environment env,
                                         java.lang.String stringVal)
```
    Specified by:
    
    stringToObject in class uk.ac.starlink.task.Parameter<java.lang.String[]>
  - objectToString
```
public java.lang.String objectToString(uk.ac.starlink.task.Environment env,
                                       java.lang.String[] objVal)
                                throws uk.ac.starlink.task.TaskException
```
    Overrides:
    
    objectToString in class uk.ac.starlink.task.Parameter<java.lang.String[]>
    
    Throws:
    
    uk.ac.starlink.task.TaskException

Class StringMultiParameter

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

StringMultiParameter

Method Detail

getValueSeparator

stringsValue

stringToObject

objectToString