Class DefaultParseResult
java.lang.Object
org.fife.ui.rsyntaxtextarea.parser.DefaultParseResult
- All Implemented Interfaces:
ParseResult
A basic implementation of
ParseResult
. Most, if not all,
Parser
s can return instances of this class.- Version:
- 1.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Exception
private int
private int
private List
<ParserNotice> private Parser
private long
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addNotice
(ParserNotice notice) Adds a parser notice.void
Clears any parser notices in this result.getError()
Returns an error that occurred while parsing the document, if any.int
Returns the first line parsed.int
Returns the first line parsed.Returns the notices for the parsed section.Returns the parser that generated these notices.long
Returns the amount of time this parser took to parse the specified range of text.void
Sets the error that occurred when last parsing the document, if any.void
setParsedLines
(int first, int last) Sets the line range parsed.void
setParseTime
(long time) Sets the amount of time it took for this parser to parse the document.
-
Field Details
-
parser
-
firstLineParsed
private int firstLineParsed -
lastLineParsed
private int lastLineParsed -
notices
-
parseTime
private long parseTime -
error
-
-
Constructor Details
-
DefaultParseResult
-
-
Method Details
-
addNotice
Adds a parser notice.- Parameters:
notice
- The new notice.- See Also:
-
clearNotices
public void clearNotices()Clears any parser notices in this result.- See Also:
-
getError
Description copied from interface:ParseResult
Returns an error that occurred while parsing the document, if any.- Specified by:
getError
in interfaceParseResult
- Returns:
- The error, or
null
if the document was successfully parsed.
-
getFirstLineParsed
public int getFirstLineParsed()Description copied from interface:ParseResult
Returns the first line parsed. All parser implementations should currently set this to0
and parse the entire document.- Specified by:
getFirstLineParsed
in interfaceParseResult
- Returns:
- The first line parsed.
- See Also:
-
getLastLineParsed
public int getLastLineParsed()Description copied from interface:ParseResult
Returns the first line parsed. All parser implementations should currently set this to the document's line count and parse the entire document.- Specified by:
getLastLineParsed
in interfaceParseResult
- Returns:
- The last line parsed.
- See Also:
-
getNotices
Description copied from interface:ParseResult
Returns the notices for the parsed section.- Specified by:
getNotices
in interfaceParseResult
- Returns:
- A list of
ParserNotice
s.
-
getParser
Description copied from interface:ParseResult
Returns the parser that generated these notices.- Specified by:
getParser
in interfaceParseResult
- Returns:
- The parser.
-
getParseTime
public long getParseTime()Description copied from interface:ParseResult
Returns the amount of time this parser took to parse the specified range of text. This is an optional operation; parsers are permitted to return0
for this value.- Specified by:
getParseTime
in interfaceParseResult
- Returns:
- The parse time, in milliseconds, or
0
if the parse time was not recorded.
-
setError
Sets the error that occurred when last parsing the document, if any.- Parameters:
e
- The error that occurred, ornull
if no error occurred.
-
setParsedLines
public void setParsedLines(int first, int last) Sets the line range parsed.- Parameters:
first
- The first line parsed, inclusive.last
- The last line parsed, inclusive.- See Also:
-
setParseTime
public void setParseTime(long time) Sets the amount of time it took for this parser to parse the document.- Parameters:
time
- The amount of time, in milliseconds.- See Also:
-