Class DefaultParserNotice
- java.lang.Object
-
- org.fife.ui.rsyntaxtextarea.parser.DefaultParserNotice
-
- All Implemented Interfaces:
java.lang.Comparable<ParserNotice>
,ParserNotice
- Direct Known Subclasses:
TaskTagParser.TaskNotice
public class DefaultParserNotice extends java.lang.Object implements ParserNotice
Base implementation of a parser notice. MostParser
implementations can return instances of this in their parse result.- Version:
- 1.0
- See Also:
Parser
,ParseResult
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.fife.ui.rsyntaxtextarea.parser.ParserNotice
ParserNotice.Level
-
-
Field Summary
Fields Modifier and Type Field Description private java.awt.Color
color
private static java.awt.Color[]
DEFAULT_COLORS
private int
length
private ParserNotice.Level
level
private int
line
private java.lang.String
message
private int
offset
private Parser
parser
private boolean
showInEditor
private java.lang.String
toolTipText
-
Constructor Summary
Constructors Constructor Description DefaultParserNotice(Parser parser, java.lang.String msg, int line)
Constructor.DefaultParserNotice(Parser parser, java.lang.String message, int line, int offset, int length)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
compareTo(ParserNotice other)
Compares this parser notice to another.boolean
containsPosition(int pos)
Returns whether this parser notice contains the specified location in the document.boolean
equals(java.lang.Object obj)
Returns whether this parser notice is equal to another one.java.awt.Color
getColor()
Returns the color to use when painting this notice.boolean
getKnowsOffsetAndLength()
Returns whether this parser notice has offset and length information (as opposed to just what line number to mark).int
getLength()
Returns the length of the code the message is concerned with.ParserNotice.Level
getLevel()
Returns the level of this notice.int
getLine()
Returns the line number the notice is about.java.lang.String
getMessage()
Returns the message from the parser.int
getOffset()
Returns the offset of the code the message is concerned with.Parser
getParser()
Returns the parser that created this message.boolean
getShowInEditor()
Whether a squiggle underline should be drawn in the editor for this notice.java.lang.String
getToolTipText()
Returns the tool tip text to display for this notice.int
hashCode()
Returns the hash code for this notice.void
setColor(java.awt.Color color)
Sets the color to use when painting this notice.void
setLevel(ParserNotice.Level level)
Sets the level of this notice.void
setShowInEditor(boolean show)
Sets whether a squiggle underline should be drawn in the editor for this notice.void
setToolTipText(java.lang.String text)
Sets the tool tip text to display for this notice.java.lang.String
toString()
Returns a string representation of this parser notice.
-
-
-
Field Detail
-
parser
private Parser parser
-
level
private ParserNotice.Level level
-
line
private int line
-
offset
private int offset
-
length
private int length
-
showInEditor
private boolean showInEditor
-
color
private java.awt.Color color
-
message
private java.lang.String message
-
toolTipText
private java.lang.String toolTipText
-
DEFAULT_COLORS
private static final java.awt.Color[] DEFAULT_COLORS
-
-
Constructor Detail
-
DefaultParserNotice
public DefaultParserNotice(Parser parser, java.lang.String msg, int line)
Constructor.- Parameters:
parser
- The parser that created this notice.msg
- The text of the message.line
- The line number for the message.
-
DefaultParserNotice
public DefaultParserNotice(Parser parser, java.lang.String message, int line, int offset, int length)
Constructor.- Parameters:
parser
- The parser that created this notice.message
- The message.line
- The line number corresponding to the message.offset
- The offset in the input stream of the code the message is concerned with, or-1
if unknown.length
- The length of the code the message is concerned with, or-1
if unknown.
-
-
Method Detail
-
compareTo
public int compareTo(ParserNotice other)
Compares this parser notice to another.- Specified by:
compareTo
in interfacejava.lang.Comparable<ParserNotice>
- Parameters:
other
- Another parser notice.- Returns:
- How the two parser notices should be sorted relative to one another.
-
containsPosition
public boolean containsPosition(int pos)
Description copied from interface:ParserNotice
Returns whether this parser notice contains the specified location in the document.- Specified by:
containsPosition
in interfaceParserNotice
- Parameters:
pos
- The position in the document.- Returns:
- Whether the position is contained. This will always return
false
ifParserNotice.getOffset()
returns-1
.
-
equals
public boolean equals(java.lang.Object obj)
Returns whether this parser notice is equal to another one.- Overrides:
equals
in classjava.lang.Object
- Parameters:
obj
- Another parser notice.- Returns:
- Whether the two notices are equal.
-
getColor
public java.awt.Color getColor()
Description copied from interface:ParserNotice
Returns the color to use when painting this notice.- Specified by:
getColor
in interfaceParserNotice
- Returns:
- The color.
-
getKnowsOffsetAndLength
public boolean getKnowsOffsetAndLength()
Description copied from interface:ParserNotice
Returns whether this parser notice has offset and length information (as opposed to just what line number to mark).- Specified by:
getKnowsOffsetAndLength
in interfaceParserNotice
- Returns:
- Whether the offset and length of the notice are specified.
- See Also:
ParserNotice.getLine()
,ParserNotice.getOffset()
,ParserNotice.getLength()
-
getLength
public int getLength()
Description copied from interface:ParserNotice
Returns the length of the code the message is concerned with.- Specified by:
getLength
in interfaceParserNotice
- Returns:
- The length of the code the message is concerned with, or
-1
if unknown. - See Also:
ParserNotice.getOffset()
,ParserNotice.getLine()
-
getLevel
public ParserNotice.Level getLevel()
Description copied from interface:ParserNotice
Returns the level of this notice.- Specified by:
getLevel
in interfaceParserNotice
- Returns:
- A value from the
ParserNotice.Level
enumeration.
-
getLine
public int getLine()
Description copied from interface:ParserNotice
Returns the line number the notice is about.- Specified by:
getLine
in interfaceParserNotice
- Returns:
- The line number.
-
getMessage
public java.lang.String getMessage()
Description copied from interface:ParserNotice
Returns the message from the parser.- Specified by:
getMessage
in interfaceParserNotice
- Returns:
- The message from the parser.
-
getOffset
public int getOffset()
Description copied from interface:ParserNotice
Returns the offset of the code the message is concerned with.- Specified by:
getOffset
in interfaceParserNotice
- Returns:
- The offset, or
-1
if unknown. - See Also:
ParserNotice.getLength()
,ParserNotice.getLine()
-
getParser
public Parser getParser()
Description copied from interface:ParserNotice
Returns the parser that created this message.- Specified by:
getParser
in interfaceParserNotice
- Returns:
- The parser.
-
getShowInEditor
public boolean getShowInEditor()
Description copied from interface:ParserNotice
Whether a squiggle underline should be drawn in the editor for this notice.- Specified by:
getShowInEditor
in interfaceParserNotice
- Returns:
- Whether a squiggle underline should be drawn.
-
getToolTipText
public java.lang.String getToolTipText()
Description copied from interface:ParserNotice
Returns the tool tip text to display for this notice.- Specified by:
getToolTipText
in interfaceParserNotice
- Returns:
- The tool tip text. If none has been explicitly set, this
method returns the same text as
ParserNotice.getMessage()
.
-
hashCode
public int hashCode()
Returns the hash code for this notice.- Overrides:
hashCode
in classjava.lang.Object
- Returns:
- The hash code.
-
setColor
public void setColor(java.awt.Color color)
Sets the color to use when painting this notice.- Parameters:
color
- The color to use.- See Also:
getColor()
-
setLevel
public void setLevel(ParserNotice.Level level)
Sets the level of this notice.- Parameters:
level
- The new level.- See Also:
getLevel()
-
setShowInEditor
public void setShowInEditor(boolean show)
Sets whether a squiggle underline should be drawn in the editor for this notice.- Parameters:
show
- Whether to draw a squiggle underline.- See Also:
getShowInEditor()
-
setToolTipText
public void setToolTipText(java.lang.String text)
Sets the tool tip text to display for this notice.- Parameters:
text
- The new tool tip text. This can be HTML. If this isnull
, then tool tips will return the same text asgetMessage()
.- See Also:
getToolTipText()
-
toString
public java.lang.String toString()
Returns a string representation of this parser notice.- Overrides:
toString
in classjava.lang.Object
- Returns:
- This parser notice as a string.
-
-