Class TaskTagParser
- java.lang.Object
-
- org.fife.ui.rsyntaxtextarea.parser.AbstractParser
-
- org.fife.ui.rsyntaxtextarea.parser.TaskTagParser
-
- All Implemented Interfaces:
Parser
public class TaskTagParser extends AbstractParser
Parser that identifies "task tags," such as "TODO
", "FIXME
", etc. in source code comments.- Version:
- 1.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TaskTagParser.TaskNotice
A parser notice that signifies a task.
-
Field Summary
Fields Modifier and Type Field Description private static java.awt.Color
COLOR
private static java.lang.String
DEFAULT_TASK_PATTERN
private DefaultParseResult
result
private java.util.regex.Pattern
taskPattern
-
Constructor Summary
Constructors Constructor Description TaskTagParser()
Creates a new task parser.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.-
Methods inherited from class org.fife.ui.rsyntaxtextarea.parser.AbstractParser
getHyperlinkListener, getImageBase, isEnabled, setEnabled, setHyperlinkListener
-
-
-
-
Field Detail
-
result
private DefaultParseResult result
-
DEFAULT_TASK_PATTERN
private static final java.lang.String DEFAULT_TASK_PATTERN
- See Also:
- Constant Field Values
-
taskPattern
private java.util.regex.Pattern taskPattern
-
COLOR
private static final java.awt.Color COLOR
-
-
Method Detail
-
getTaskPattern
public java.lang.String getTaskPattern()
Returns the regular expression used to search for tasks.- Returns:
- The regular expression. This may be
null
if no regular expression was specified (or an empty string was specified). - See Also:
setTaskPattern(String)
-
parse
public ParseResult parse(RSyntaxDocument doc, java.lang.String style)
Description copied from interface:Parser
Parses input from the specified document.- Parameters:
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 asSyntaxConstants.SYNTAX_STYLE_JAVA
.- Returns:
- An object describing the section of the document parsed and the
results. This is guaranteed to be non-
null
.
-
setTaskPattern
public void setTaskPattern(java.lang.String pattern)
Sets the pattern of task identifiers. You will usually want this to be a list of words "or'ed" together, such as "TODO|FIXME|HACK|REMIND
".- Parameters:
pattern
- The pattern. A value ofnull
or an empty string effectively disables task parsing.- Throws:
java.util.regex.PatternSyntaxException
- Ifpattern
is an invalid regular expression.- See Also:
getTaskPattern()
-
-