uk.ac.starlink.ttools.task

Class OutputReporterParameter

java.lang.Object

uk.ac.starlink.task.Parameter<OutputReporter>

uk.ac.starlink.ttools.task.OutputReporterParameter

public class OutputReporterParameter
extends Parameter<OutputReporter>

Parameter for selecting an OutputReporter for use with taplint.

Since:

23 Oct 2016

Author:

Mark Taylor

Field Summary

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

BY_NAME

Constructor Summary

Constructors

Constructor and Description
OutputReporterParameter(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
Parameter<?>[]	getReporterParameters() Returns an array of parameters associated with this one.
String	objectToString(Environment env, OutputReporter orval) Takes a typed value of this parameter and formats it as a string which may be used for presentation to the user.
OutputReporter	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, 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

OutputReporterParameter

public OutputReporterParameter(String name)

Constructor.

Parameters:

name - parameter name

Method Detail

getReporterParameters

public Parameter<?>[] getReporterParameters()

Returns an array of parameters associated with this one. Their values are used in conjunction with the value of this parameter to define the selected OutputReporter instance. Note that not all of these paramters may be applicable to every value for this parameter. But there is probably a fair amount of overlap.

Returns:

list of associated parameters

objectToString

public String objectToString(Environment env,
                             OutputReporter orval)

Description copied from class: Parameter

Takes a typed value of this parameter and formats it as a string which may be used for presentation to the user. Ideally, round-tripping between this method and stringToObject should be possible, but that is not in general required/guaranteed.

The default implementation uses the value's toString method, but subclasses can override this for smarter behaviour.

Overrides:

objectToString in class Parameter<OutputReporter>

Parameters:

env - execution environment

orval - typed parameter value

Returns:

string value for presentation

stringToObject

public OutputReporter 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<OutputReporter>

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