public class TaskTagParser extends AbstractParser
TODO
",
"FIXME
", etc. in source code comments.Modifier and Type | Class and Description |
---|---|
static class |
TaskTagParser.TaskNotice
A parser notice that signifies a task.
|
Constructor and Description |
---|
TaskTagParser()
Creates a new task parser.
|
Modifier and Type | Method and Description |
---|---|
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.
|
getHyperlinkListener, getImageBase, isEnabled, setEnabled, setHyperlinkListener
public TaskTagParser()
TODO
",
"FIXME
", and "HACK
".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()