org.fife.ui.rsyntaxtextarea.parser.ParserNotice Maven / Gradle / Ivy
/*
* 09/23/2005
*
* ParserNotice.java - A notice (i.e, and error or warning) from a parser.
*
* This library is distributed under a modified BSD license. See the included
* RSyntaxTextArea.License.txt file for details.
*/
package org.fife.ui.rsyntaxtextarea.parser;
import java.awt.Color;
/**
* A notice (e.g., a warning or error) from a parser.
*
* Since different parsers have different levels of precision when it comes
* to identifying errors in code, this class supports marking parser notices
* on either a per-line basis or arbitrary regions of a document. For any
* ParserNotice, {@link #getLine()} is guaranteed to return the
* (primary) line containing the notice, but {@link #getOffset()} and
* {@link #getLength()} are allowed to return -1 if that
* particular notice isn't mapped to a specific region of code. Applications
* can check whether an instance of this class only has line-level information
* with the
*
* @author Robert Futrell
* @version 1.0
* @see DefaultParserNotice
*/
public interface ParserNotice extends Comparable {
/**
* Returns whether this parser notice contains the specified location
* in the document.
*
* @param pos The position in the document.
* @return Whether the position is contained. This will always return
* false if {@link #getOffset()} returns
* -1.
*/
public boolean containsPosition(int pos);
/**
* Returns the color to use when painting this notice.
*
* @return The color.
*/
public Color getColor();
/**
* Returns the length of the code the message is concerned with.
*
* @return The length of the code the message is concerned with, or
* -1 if unknown.
* @see #getOffset()
* @see #getLine()
*/
public int getLength();
/**
* Returns the level of this notice.
*
* @return A value from the {@link Level} enumeration.
*/
public Level getLevel();
/**
* Returns the line number the notice is about.
*
* @return The line number.
*/
public int getLine();
/**
* Returns whether this parser notice has offset and length information
* (as opposed to just what line number to mark).
*
* @return Whether the offset and length of the notice are specified.
* @see #getLine()
* @see #getOffset()
* @see #getLength()
*/
public boolean getKnowsOffsetAndLength();
/**
* Returns the message from the parser.
*
* @return The message from the parser.
*/
public String getMessage();
/**
* Returns the offset of the code the message is concerned with.
*
* @return The offset, or -1 if unknown.
* @see #getLength()
* @see #getLine()
*/
public int getOffset();
/**
* Returns the parser that created this message.
*
* @return The parser.
*/
public Parser getParser();
/**
* Whether a squiggle underline should be drawn in the editor for this
* notice.
*
* @return Whether a squiggle underline should be drawn.
*/
public boolean getShowInEditor();
/**
* Returns the tool tip text to display for this notice.
*
* @return The tool tip text. If none has been explicitly set, this
* method returns the same text as {@link #getMessage()}.
*/
public String getToolTipText();
/**
* Denotes the severity of a parser notice.
*/
public static enum Level {
/**
* Indicates an informational notice.
*/
INFO(2),
/**
* Indicates a warning notice.
*/
WARNING(1),
/**
* Indicates an error notice.
*/
ERROR(0);
private int value;
private Level(int value) {
this.value = value;
}
/**
* Returns the value of this notice level, as an integer.
*
* @return A numeric value for this notice level.
*/
public int getNumericValue() {
return value;
}
/**
* Returns whether this level is as sever as, or worse than, another
* level.
*
* @param other The other level.
* @return Whether this level is equal to or more severe.
*/
public boolean isEqualToOrWorseThan(Level other) {
return value<=other.getNumericValue();
}
}
}