uk.ac.starlink.ttools.plot2.task
Class InsetsParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter<Insets>
      extended by uk.ac.starlink.ttools.plot2.task.InsetsParameter

public class InsetsParameter
extends Parameter<Insets>

Parameter for receiving an Insets specification. The string representation is as 4 integers separated by columns.

Since:
5 Sep 2013
Author:
Mark Taylor

Field Summary
 
Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME
 
Constructor Summary
InsetsParameter(String name)
          Constructor.
 
Method Summary
 Insets insetsValue(Environment env)
          Acquires the value of this parameter as an Insets object.
 Insets 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, 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

InsetsParameter

public InsetsParameter(String name)
Constructor.

Parameters:
name - parameter name
Method Detail

insetsValue

public Insets insetsValue(Environment env)
                   throws TaskException
Acquires the value of this parameter as an Insets object.

Parameters:
env - execution environment
Returns:
insets
Throws:
TaskException

stringToObject

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


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.