public class ConfigMeta
extends java.lang.Object
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 | Description |
---|---|
ConfigMeta(java.lang.String shortName,
java.lang.String longName) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
ConfigMeta |
appendXmlDescription(java.lang.String[] moreXml) |
Convenience method to add additional lines to the existing XML
documentation string.
|
static java.lang.String |
capitalise(java.lang.String word) |
Uppercases the first letter of a string.
|
java.lang.String |
getLongName() |
Returns a potentially more descriptive name suitable for use in a GUI.
|
java.lang.String |
getShortDescription() |
Returns a short description string.
|
java.lang.String |
getShortName() |
Returns the basic one-word name, not case-sensitive, for use in
command-line interfaces.
|
java.lang.String |
getStringUsage() |
Returns a usage string which should some clue how to specify this
key from a string.
|
java.lang.String |
getXmlDescription() |
Returns an XML string suitable for insertion into a user document.
|
ConfigMeta |
setShortDescription(java.lang.String shortDescription) |
Sets a short description string.
|
ConfigMeta |
setStringUsage(java.lang.String usage) |
Sets a usage string which should give some clue how to specify this
key from a string.
|
ConfigMeta |
setXmlDescription(java.lang.String xmlDescription) |
Sets a documentation string.
|
ConfigMeta |
setXmlDescription(java.lang.String[] lines) |
Convenience method to set the XML description from an array of text
lines.
|
public ConfigMeta(java.lang.String shortName, java.lang.String longName)
shortName
- basic name, no spaces, not case-sensitive,
to be used in command-line interfacelongName
- name for use in GUIpublic java.lang.String getShortName()
public java.lang.String getLongName()
public java.lang.String getStringUsage()
Examples might be something like "true|false
"
or "<RRGGBB>
".
public java.lang.String getShortDescription()
public java.lang.String getXmlDescription()
public ConfigMeta setStringUsage(java.lang.String usage)
Examples might be something like "true|false
"
or "<RRGGBB>
".
usage
- usage stringpublic ConfigMeta setShortDescription(java.lang.String shortDescription)
shortDescription
- one-line descriptionpublic ConfigMeta setXmlDescription(java.lang.String xmlDescription)
Permissible elements include p, ul, li, dl, dt, dd, em, code, strong. Lists go inside paragraphs.
public ConfigMeta setXmlDescription(java.lang.String[] lines)
setXmlDescription
is called on the result of joining the lines with newline characters.lines
- lines of documentation stringpublic ConfigMeta appendXmlDescription(java.lang.String[] moreXml)
moreXml
- additinoal lines of documentation stringpublic static java.lang.String capitalise(java.lang.String word)
word
- wordCopyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.