uk.ac.starlink.ttools.task
Class XmlEncodingParameter

java.lang.Object
  extended by uk.ac.starlink.task.Parameter<Charset>
      extended by uk.ac.starlink.ttools.task.XmlEncodingParameter
All Implemented Interfaces:
ExtraParameter

public class XmlEncodingParameter
extends Parameter<Charset>
implements ExtraParameter

Parameter which describes one of the available XML encodings (UTF-8 etc).

Since:
16 Aug 2005
Author:
Mark Taylor

Field Summary
 
Fields inherited from class uk.ac.starlink.task.Parameter
BY_NAME
 
Constructor Summary
XmlEncodingParameter(String name)
           
 
Method Summary
 String getExtraUsage(TableEnvironment env)
          Returns an extended usage message.
 Charset 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, 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

XmlEncodingParameter

public XmlEncodingParameter(String name)
Method Detail

getExtraUsage

public String getExtraUsage(TableEnvironment env)
Description copied from interface: ExtraParameter
Returns an extended usage message. This should not repeat the content of the normal usage message. It should be preformatted, that is it should contain newlines to keep the line length down to less than 80 characters.

Specified by:
getExtraUsage in interface ExtraParameter
Parameters:
env - execution envrionment
Returns:
extended usage message

stringToObject

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


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