public class Tag extends java.lang.Object implements java.io.Serializable, RevisionHandler
Tag
simply associates a numeric ID with a String description.Constructor and Description |
---|
Tag()
Creates a new default Tag
|
Tag(int ident,
java.lang.String readable)
Creates a new
Tag instance. |
Tag(int ident,
java.lang.String identStr,
java.lang.String readable)
Creates a new
Tag instance. |
Tag(int ident,
java.lang.String identStr,
java.lang.String readable,
boolean upperCase) |
Modifier and Type | Method and Description |
---|---|
int |
getID()
Gets the numeric ID of the Tag.
|
java.lang.String |
getIDStr()
Gets the string ID of the Tag.
|
java.lang.String |
getReadable()
Gets the string description of the Tag.
|
java.lang.String |
getRevision()
Returns the revision string.
|
void |
setID(int id)
Sets the numeric ID of the Tag.
|
void |
setIDStr(java.lang.String str)
Sets the string ID of the Tag.
|
void |
setReadable(java.lang.String r)
Sets the string description of the Tag.
|
static java.lang.String |
toOptionList(Tag[] tags)
returns a list that can be used in the listOption methods to list all
the available ID strings, e.g.: <0|1|2> or <what|ever>
|
static java.lang.String |
toOptionSynopsis(Tag[] tags)
returns a string that can be used in the listOption methods to list all
the available options, i.e., "\t\tID = Text\n" for each option
|
java.lang.String |
toString()
returns the IDStr
|
public Tag()
public Tag(int ident, java.lang.String readable)
Tag
instance.ident
- the ID for the new Tag.readable
- the description for the new Tag.public Tag(int ident, java.lang.String identStr, java.lang.String readable)
Tag
instance.ident
- the ID for the new Tag.identStr
- the ID string for the new Tag (case-insensitive).readable
- the description for the new Tag.public Tag(int ident, java.lang.String identStr, java.lang.String readable, boolean upperCase)
public int getID()
public void setID(int id)
id
- the ID of the Tag.public java.lang.String getIDStr()
public void setIDStr(java.lang.String str)
str
- the string ID of the Tag.public java.lang.String getReadable()
public void setReadable(java.lang.String r)
r
- the description of the Tag.public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.String toOptionList(Tag[] tags)
tags
- the tags to create the list forpublic static java.lang.String toOptionSynopsis(Tag[] tags)
tags
- the tags to create the string forpublic java.lang.String getRevision()
getRevision
in interface RevisionHandler