Class DefaultParserNotice

    • 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.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Field Detail

      • parser

        private Parser parser
      • 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 interface java.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 interface ParserNotice
        Parameters:
        pos - The position in the document.
        Returns:
        Whether the position is contained. This will always return false if ParserNotice.getOffset() returns -1.
      • equals

        public boolean equals​(java.lang.Object obj)
        Returns whether this parser notice is equal to another one.
        Overrides:
        equals in class java.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 interface ParserNotice
        Returns:
        The color.
      • getLine

        public int getLine()
        Description copied from interface: ParserNotice
        Returns the line number the notice is about.
        Specified by:
        getLine in interface ParserNotice
        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 interface ParserNotice
        Returns:
        The message from the parser.
      • getParser

        public Parser getParser()
        Description copied from interface: ParserNotice
        Returns the parser that created this message.
        Specified by:
        getParser in interface ParserNotice
        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 interface ParserNotice
        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 interface ParserNotice
        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 class java.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 is null, then tool tips will return the same text as getMessage().
        See Also:
        getToolTipText()
      • toString

        public java.lang.String toString()
        Returns a string representation of this parser notice.
        Overrides:
        toString in class java.lang.Object
        Returns:
        This parser notice as a string.