|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.fife.ui.rsyntaxtextarea.parser.AbstractParser org.fife.ui.rsyntaxtextarea.parser.TaskTagParser
public class TaskTagParser
Parser that identifies "task tags," such as "TODO
",
"FIXME
", etc. in source code comments.
Nested Class Summary | |
---|---|
static class |
TaskTagParser.TaskNotice
A parser notice that signifies a task. |
Constructor Summary | |
---|---|
TaskTagParser()
Creates a new task parser. |
Method Summary | |
---|---|
java.lang.String |
getTaskPattern()
Returns the regular expression used to search for tasks. |
ParseResult |
parse(RSyntaxDocument doc,
java.lang.String style)
Parses input from the specified document. |
void |
setTaskPattern(java.lang.String pattern)
Sets the pattern of task identifiers. |
Methods inherited from class org.fife.ui.rsyntaxtextarea.parser.AbstractParser |
---|
getHyperlinkListener, getImageBase, isEnabled, setEnabled, setHyperlinkListener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TaskTagParser()
TODO
",
"FIXME
", and "HACK
".
Method Detail |
---|
public java.lang.String getTaskPattern()
null
if no
regular expression was specified (or an empty string was
specified).setTaskPattern(String)
public ParseResult parse(RSyntaxDocument doc, java.lang.String style)
Parser
doc
- The document to parse. This document is in a read lock,
so it cannot be modified while parsing is occurring.style
- The language being rendered, such as
SyntaxConstants.SYNTAX_STYLE_JAVA
.
null
.public void setTaskPattern(java.lang.String pattern) throws java.util.regex.PatternSyntaxException
TODO|FIXME|HACK|REMIND
".
pattern
- The pattern. A value of null
or an
empty string effectively disables task parsing.
java.util.regex.PatternSyntaxException
- If pattern
is an invalid
regular expression.getTaskPattern()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |