|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.mojo.taglist.tags.TagClass
public class TagClass
Class that define a classification of tags. Each tag class contains 1 or more tags. This allows a user to define one tag "name" for display purposes, while still checking the files for multiple tag rules. Example
Action Items todo ignoreCase
Field Summary | |
---|---|
static int |
NO_MATCH
The int value for no tag match found. |
Constructor Summary | |
---|---|
TagClass(String displayName)
Constructor. |
Method Summary | |
---|---|
void |
addTag(AbsTag tag)
Add a tag to this tag class. |
String |
getDisplayName()
Get the display name of this tag class. |
String |
getLastTagMatchString()
Return the tag string for the last successfully matched tag. |
int |
getLastTagMatchStringLength()
Return the length of the last matched tag. |
TagReport |
getTagReport()
Access the tag report for this tag class. |
int |
tagMatchContains(String currentLine,
Locale locale)
Get the index of the first tag contained from within a string. |
boolean |
tagMatchStartsWith(String currentLine,
Locale locale)
Check if a string starts with a tag from this tag class. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NO_MATCH
Constructor Detail |
---|
public TagClass(String displayName)
displayName
- the string to display as the name for this tag class.Method Detail |
---|
public TagReport getTagReport()
public void addTag(AbsTag tag)
tag
- the tag to add to the tag class.public int tagMatchContains(String currentLine, Locale locale)
currentLine
- the string for the current line being scanned.locale
- the Locale of the currentLine.
public boolean tagMatchStartsWith(String currentLine, Locale locale)
currentLine
- the string for the current line being scanned.locale
- the Locale of the currentLine.
public String getLastTagMatchString()
public int getLastTagMatchStringLength()
public String getDisplayName()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |