Package uk.ac.starlink.ttools.task
Class XmlEncodingParameter
- java.lang.Object
-
- uk.ac.starlink.task.Parameter<java.nio.charset.Charset>
-
- uk.ac.starlink.ttools.task.XmlEncodingParameter
-
- All Implemented Interfaces:
ExtraParameter
public class XmlEncodingParameter extends uk.ac.starlink.task.Parameter<java.nio.charset.Charset> implements ExtraParameter
Parameter which describes one of the available XML encodings (UTF-8 etc).- Since:
- 16 Aug 2005
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description XmlEncodingParameter(java.lang.String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getExtraUsage(TableEnvironment env)
Returns an extended usage message.java.nio.charset.Charset
stringToObject(uk.ac.starlink.task.Environment env, java.lang.String sval)
-
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
-
-
-
-
Method Detail
-
getExtraUsage
public java.lang.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 interfaceExtraParameter
- Parameters:
env
- execution envrionment- Returns:
- extended usage message
-
stringToObject
public java.nio.charset.Charset stringToObject(uk.ac.starlink.task.Environment env, java.lang.String sval) throws uk.ac.starlink.task.TaskException
- Specified by:
stringToObject
in classuk.ac.starlink.task.Parameter<java.nio.charset.Charset>
- Throws:
uk.ac.starlink.task.TaskException
-
-