uk.ac.starlink.ttools.task

Class CombinerParameter

java.lang.Object

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

uk.ac.starlink.task.AbstractChoiceParameter<T,T>

uk.ac.starlink.task.ChoiceParameter<Combiner>

uk.ac.starlink.ttools.task.CombinerParameter

public class CombinerParameter
extends ChoiceParameter<Combiner>

Parameter for specifying Combiner values. As well as the static options defined in the Combiner class, the "Q.nnn" syntax for specifying arbitrary quantiles is supported.

Since:

16 May 2024

Author:

Mark Taylor

Field Summary

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

BY_NAME

Constructor Summary

Constructors

Constructor and Description
CombinerParameter(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getOptionsDescription() Returns an XML element listing the possible options for this parameter with their descriptions.
Combiner	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.ChoiceParameter

getUsage, objectToString, setDefaultOption, setUsage

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

addOption, addOption, choiceToString, clearOptions, getName, getOption, getOptionNames, getOptions, getOptionValueList, stringifyOption, stringToChoice

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

clearValue, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getStringDefault, getValueClass, isNullPermitted, objectValue, setDescription, setDescription, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringDefault, 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

CombinerParameter

public CombinerParameter(String name)

Constructor.

Parameters:

name - parameter name

Method Detail

stringToObject

public Combiner 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.

Overrides:

stringToObject in class ChoiceParameter<Combiner>

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

getOptionsDescription

public String getOptionsDescription()

Returns an XML element listing the possible options for this parameter with their descriptions.

Returns:

options description in as a <ul> element