uk.ac.starlink.ttools.plot2.task

Class PaddingParameter

java.lang.Object

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

uk.ac.starlink.ttools.plot2.task.PaddingParameter

public class PaddingParameter
extends Parameter<Padding>

Parameter for receiving a Padding specification. The string representation is 4 integers separated by commas; any of the places may be blank. The sequence of values (top,left,bottom,right) follows that of Insets.

Since:

9 Dec 2016

Author:

Mark Taylor

Field Summary

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

BY_NAME

Constructor Summary

Constructors

Constructor and Description
PaddingParameter(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
String	objectToString(Environment env, Padding padding) Takes a typed value of this parameter and formats it as a string which may be used for presentation to the user.
Padding	stringToObject(Environment env, String stringval) 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

PaddingParameter

public PaddingParameter(String name)

Constructor.

Parameters:

name - parameter name

Method Detail

stringToObject

public Padding stringToObject(Environment env,
                              String stringval)
                       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<Padding>

Parameters:

env - execution environment; in most cases this is not required but for some purposes environment-specific characteristics may influence the result

stringval - non-null, non-empty string value

Returns:

typed value

Throws:

TaskException

objectToString

public String objectToString(Environment env,
                             Padding padding)

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<Padding>

Parameters:

env - execution environment

padding - typed parameter value

Returns:

string value for presentation