org.fife.ui.rsyntaxtextarea
Class ParserNotice

java.lang.Object
  org.fife.ui.rsyntaxtextarea.ParserNotice

public class ParserNotice
extends Object

A notice (e.g., a warning or error) from a parser.

Version:

0.1

Author:

Robert Futrell

Constructor Summary

ParserNotice(String message, int offset, int length)
Constructor.

ParserNotice(String message, int offset, int length, int line, int column)
Constructor.

Method Summary

boolean	containsPosition(int pos) Returns whether this parser notice contains the specified location in the document.
int	getColumn() Returns the character offset into the line of the parser notice, if any.
int	getLength() Returns the length of the code the message is concerned with.
int	getLine() Returns the line number the notice is about, if any.
String	getMessage() Returns the message from the parser.
int	getOffset() Returns the offset of the code the message is concerned with.
String	toString() Returns a string representation of this parser notice.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ParserNotice

public ParserNotice(String message,
                    int offset,
                    int length)

Constructor.

Parameters:

message - The message.

offset - The offset in the input stream of the code the message is concerned with.

length - The length of the code the message is concerned with.

ParserNotice

public ParserNotice(String message,
                    int offset,
                    int length,
                    int line,
                    int column)

Constructor.

Parameters:

message - The message.

offset - The offset in the input stream of the code the message is concerned with.

length - The length of the code the message is concerned with.

line - The line number of the notice, -1 if none.

column - The character-offset into the line of the notice, -1 if none.

Method Detail

containsPosition

public boolean containsPosition(int pos)

Returns whether this parser notice contains the specified location in the document.

Parameters:

pos - The position in the document.

Returns:

Whether the position is contained.

getColumn

public int getColumn()

Returns the character offset into the line of the parser notice, if any.

Returns:

The column.

getLength

public int getLength()

Returns the length of the code the message is concerned with.

Returns:

The length of the code the message is concerned with.

getLine

public int getLine()

Returns the line number the notice is about, if any.

Returns:

The line number.

getMessage

public String getMessage()

Returns the message from the parser.

Returns:

The message from the parser.

getOffset

public int getOffset()

Returns the offset of the code the message is concerned with.

Returns:

The offset.

toString

public String toString()

Returns a string representation of this parser notice.

Overrides:

toString in class Object

Returns:

This parser notice as a string.