OutputStreamParameter (Starjava Task API)

java.lang.Object
- uk.ac.starlink.task.Parameter<uk.ac.starlink.util.Destination>
- - uk.ac.starlink.task.OutputStreamParameter

public class OutputStreamParameter
extends Parameter<uk.ac.starlink.util.Destination>

Parameter for selecting an output stream to write to.

Since:: 9 May 2006
Author:: Mark Taylor

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

Constructor Summary

Constructors
Constructor Description

OutputStreamParameter(java.lang.String name)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`uk.ac.starlink.util.Destination`	`stringToObject(Environment env, java.lang.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
  - OutputStreamParameter
```
public OutputStreamParameter(java.lang.String name)
```
    Constructor.
    
    Parameters:
    
    name - parameter name
- Method Detail
  - stringToObject
```
public uk.ac.starlink.util.Destination stringToObject(Environment env,
                                                      java.lang.String sval)
                                               throws ParameterValueException
```
    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<uk.ac.starlink.util.Destination>
    
    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:
    
    ParameterValueException