|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.codehaus.mojo.taglist.tags.AbsTag
public abstract class AbsTag
The abstract base class for tags. This class defines the required functions that each type of tag must implement. The goal here is to allow different types of tags to be created by the user, but the call processing for each tag can be generic. For example, a generic tag might search files for an exact string match of the tag, but a regex tag will use regular expressions in its searching. Either way, the processing classes call each tag with the same function and get the same results.
Field Summary | |
---|---|
protected String |
tagString
The tag string for this tag. |
Constructor Summary | |
---|---|
protected |
AbsTag(String tag)
Constructor. |
Method Summary | |
---|---|
abstract int |
contains(String currentLine,
Locale locale)
Check to see if the string contains this tag. |
abstract int |
getLastTagMatchLength()
Return the length of the last matched tag. |
abstract boolean |
startsWith(String currentLine,
Locale locale)
Check to see if the string starts with this tag. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected String tagString
Constructor Detail |
---|
protected AbsTag(String tag)
tag
- the tag string to be used for this tag.Method Detail |
---|
public abstract int contains(String currentLine, Locale locale)
currentLine
- the string for the current line being scanned.locale
- the Locale of the currentLine.
public abstract boolean startsWith(String currentLine, Locale locale)
currentLine
- the string for the current line being scanned.locale
- the Locale of the currentLine.
public abstract int getLastTagMatchLength()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |