Package uk.ac.starlink.task

Class OutputStreamParameter

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

  • Constructor Details

    • OutputStreamParameter

      public OutputStreamParameter(String name)
      Constructor.
      Parameters:
      name - parameter name

  • Method Details

    • stringToObject

      public uk.ac.starlink.util.Destination stringToObject(Environment env, 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