|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.config.ConfigMeta
public class ConfigMeta
Contains metadata about configuration items.
A number of the setter methods return this object, to facilitate declarations where method invocations are chained so that the configured metadata object can be returned in a single expression rather than multiple statements (cf StringBuffer).
Constructor Summary | |
---|---|
ConfigMeta(String shortName,
String longName)
Constructor. |
Method Summary | |
---|---|
ConfigMeta |
appendXmlDescription(String[] moreXml)
Convenience method to add additional lines to the existing XML documentation string. |
static String |
capitalise(String word)
Uppercases the first letter of a string. |
String |
getLongName()
Returns a potentially more descriptive name suitable for use in a GUI. |
String |
getShortDescription()
Returns a short description string. |
String |
getShortName()
Returns the basic one-word name, not case-sensitive, for use in command-line interfaces. |
String |
getStringUsage()
Returns a usage string which should some clue how to specify this key from a string. |
String |
getXmlDescription()
Returns an XML string suitable for insertion into a user document. |
ConfigMeta |
setShortDescription(String shortDescription)
Sets a short description string. |
ConfigMeta |
setStringUsage(String usage)
Sets a usage string which should give some clue how to specify this key from a string. |
ConfigMeta |
setXmlDescription(String xmlDescription)
Sets a documentation string. |
ConfigMeta |
setXmlDescription(String[] lines)
Convenience method to set the XML description from an array of text lines. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ConfigMeta(String shortName, String longName)
shortName
- basic name, no spaces, not case-sensitive,
to be used in command-line interfacelongName
- name for use in GUIMethod Detail |
---|
public String getShortName()
public String getLongName()
public String getStringUsage()
Examples might be something like "true|false
"
or "<RRGGBB>
".
public String getShortDescription()
public String getXmlDescription()
public ConfigMeta setStringUsage(String usage)
Examples might be something like "true|false
"
or "<RRGGBB>
".
usage
- usage string
public ConfigMeta setShortDescription(String shortDescription)
shortDescription
- one-line description
public ConfigMeta setXmlDescription(String xmlDescription)
Permissible elements include p, ul, li, dl, dt, dd, em, code, strong. Lists go inside paragraphs.
public ConfigMeta setXmlDescription(String[] lines)
setXmlDescription
is called on the result of joining the lines with newline characters.
lines
- lines of documentation string
public ConfigMeta appendXmlDescription(String[] moreXml)
moreXml
- additinoal lines of documentation string
public static String capitalise(String word)
word
- word
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |