public class InputMeta
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 and Description |
---|
InputMeta(java.lang.String shortName,
java.lang.String longName)
Constructor.
|
Modifier and Type | Method and Description |
---|---|
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 |
getValueUsage()
Returns a a short usage fragment that describes the form of the
data values represented by this coordinate.
|
java.lang.String |
getXmlDescription()
Returns an XML string suitable for insertion into a user document.
|
InputMeta |
setShortDescription(java.lang.String shortDescription)
Sets a short description string.
|
InputMeta |
setValueUsage(java.lang.String usage)
Sets a usage string which should give some clue how to specify this
key from a string.
|
InputMeta |
setXmlDescription(java.lang.String xmlDescription)
Sets a documentation string.
|
InputMeta |
setXmlDescription(java.lang.String[] lines)
Convenience method to set the XML description from an array of text
lines.
|
public InputMeta(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 getValueUsage()
Examples might be something like "deg
"
or "boolean
";
public java.lang.String getShortDescription()
public java.lang.String getXmlDescription()
public InputMeta setValueUsage(java.lang.String usage)
Examples might be something like "float
"
or "boolean
";
usage
- usage stringpublic InputMeta setShortDescription(java.lang.String shortDescription)
shortDescription
- one-line descriptionpublic InputMeta setXmlDescription(java.lang.String xmlDescription)
Permissible elements include p, ul, li, dl, dt, dd, em, code, strong. Lists go inside paragraphs.
public InputMeta setXmlDescription(java.lang.String[] lines)
setXmlDescription
is called on the result of joining the lines with newline characters.lines
- lines of documentation stringCopyright © 2017 Central Laboratory of the Research Councils. All Rights Reserved.