uk.ac.starlink.ttools.task
Class XmlEncodingParameter

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

public class XmlEncodingParameter
extends uk.ac.starlink.task.Parameter
implements ExtraParameter

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

Since:
16 Aug 2005
Author:
Mark Taylor

Constructor Summary
XmlEncodingParameter(String name)
           
 
Method Summary
 Charset charsetValue(uk.ac.starlink.task.Environment env)
          Returns the value of this parameter as a Charset object.
 String getExtraUsage(TableEnvironment env)
          Returns an extended usage message.
 void setValueFromString(uk.ac.starlink.task.Environment env, String sval)
           
 
Methods inherited from class uk.ac.starlink.task.Parameter
checkGotValue, clearValue, getDefault, getDescription, getName, getPosition, getPreferExplicit, getPrompt, getUsage, isNullPermitted, setDefault, setDescription, setDescription, setGotValue, setName, setNullPermitted, setPosition, setPreferExplicit, setPrompt, setStringValue, setUsage, stringValue, 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

charsetValue

public Charset charsetValue(uk.ac.starlink.task.Environment env)
                     throws uk.ac.starlink.task.TaskException
Returns the value of this parameter as a Charset object.

Parameters:
env - execution environment
Returns:
charset representing the XML encoding
Throws:
uk.ac.starlink.task.TaskException

setValueFromString

public void setValueFromString(uk.ac.starlink.task.Environment env,
                               String sval)
                        throws uk.ac.starlink.task.TaskException
Overrides:
setValueFromString in class uk.ac.starlink.task.Parameter
Throws:
uk.ac.starlink.task.TaskException


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