gnu.text

Class SourceMessages

public class SourceMessages extends Object implements SourceLocator

A collection of (zero or more) SourceErrors. Has a "current line number" which clients can use as the default line number, or clients can explicitly provide a line number. Does not handle localization of messages.
Field Summary
static booleandebugStackTraceOnError
If true, print out stack trace with any error.
static booleandebugStackTraceOnWarning
If true, print out stack trace with any warning.
booleansortMessages
True if we should sort messages by line number.
Method Summary
booleancheckErrors(PrintWriter out, int max)
Checks if an error was seen; if so, prints and clears the messages.
booleancheckErrors(PrintStream out, int max)
Checks if an error was seen; if so, prints and clears the messages.
voidclear()
Clear the contained errors and warnings.
voidclearErrors()
Clear the error count (only).
voiderror(SourceError error)
Link in an error.
voiderror(char severity, String filename, int line, int column, String message)
Record a new error.
voiderror(char severity, SourceLocator location, String message)
voiderror(char severity, String filename, int line, int column, String message, String code)
voiderror(char severity, SourceLocator location, String message, String code)
voiderror(char severity, String message)
Record a new error at the current default source file location.
voiderror(char severity, String message, String code)
intgetColumnNumber()
The default column number to use for a new error.
intgetErrorCount()
Get the number of errors (not counting warnings).
SourceErrorgetErrors()
StringgetFileName()
The default filename to use for a new error.
intgetLineNumber()
The default line number to use for a new error.
StringgetPublicId()
StringgetSystemId()
booleanisStableSourceLocation()
voidprintAll(PrintStream out, int max)
Print all the error messages to a PrintStream.
voidprintAll(PrintWriter out, int max)
Print all the error messages to a PrintWriter.
booleanseenErrors()
Return true iff errors (not warnings) have been seen.
booleanseenErrorsOrWarnings()
voidsetColumn(int column)
Set the default column number to use for a new error.
voidsetFile(String filename)
Set the default filename to use for a new error.
voidsetLine(int line)
Set the default line number to use for a new error.
voidsetLine(String filename, int line, int column)
Set the default filename, line and column to use for a new error.
voidsetLocation(SourceLocator locator)
Copies the current position of locator.
voidsetSourceLocator(SourceLocator locator)
Links our location to the one give.
StringtoString(int max)
Convert this to a String containing the recorded errors.

Field Detail

debugStackTraceOnError

public static boolean debugStackTraceOnError
If true, print out stack trace with any error.

debugStackTraceOnWarning

public static boolean debugStackTraceOnWarning
If true, print out stack trace with any warning.

sortMessages

public boolean sortMessages
True if we should sort messages by line number.

Method Detail

checkErrors

public boolean checkErrors(PrintWriter out, int max)
Checks if an error was seen; if so, prints and clears the messages.

Parameters: out where to write the error message to max maximum number of messages to print (can be 0)

checkErrors

public boolean checkErrors(PrintStream out, int max)
Checks if an error was seen; if so, prints and clears the messages.

Parameters: out where to write the error message to max maximum number of messages to print (can be 0)

clear

public void clear()
Clear the contained errors and warnings.

clearErrors

public void clearErrors()
Clear the error count (only).

error

public void error(SourceError error)
Link in an error.

error

public void error(char severity, String filename, int line, int column, String message)
Record a new error.

Parameters: severity is the seriousness of the error - one of 'w' (for warning), 'e' (for error), or 'f' (for fatal error) filename the name or URL of the file containing the error line the (1-origin) line number or 0 if unknown column the (1-origin) column number or 0 if unknown message the error message

error

public void error(char severity, SourceLocator location, String message)

error

public void error(char severity, String filename, int line, int column, String message, String code)

error

public void error(char severity, SourceLocator location, String message, String code)

error

public void error(char severity, String message)
Record a new error at the current default source file location.

Parameters: severity is the seriousness of the error - one of 'w' (for warning), 'e' (for error), or 'f' (for fatal error) message the error message

error

public void error(char severity, String message, String code)

getColumnNumber

public final int getColumnNumber()
The default column number to use for a new error.

getErrorCount

public int getErrorCount()
Get the number of errors (not counting warnings).

getErrors

public SourceError getErrors()

getFileName

public final String getFileName()
The default filename to use for a new error.

getLineNumber

public final int getLineNumber()
The default line number to use for a new error.

getPublicId

public String getPublicId()

getSystemId

public String getSystemId()

isStableSourceLocation

public boolean isStableSourceLocation()

printAll

public void printAll(PrintStream out, int max)
Print all the error messages to a PrintStream.

printAll

public void printAll(PrintWriter out, int max)
Print all the error messages to a PrintWriter.

seenErrors

public boolean seenErrors()
Return true iff errors (not warnings) have been seen.

seenErrorsOrWarnings

public boolean seenErrorsOrWarnings()

setColumn

public void setColumn(int column)
Set the default column number to use for a new error.

setFile

public void setFile(String filename)
Set the default filename to use for a new error.

setLine

public void setLine(int line)
Set the default line number to use for a new error.

setLine

public void setLine(String filename, int line, int column)
Set the default filename, line and column to use for a new error.

setLocation

public final void setLocation(SourceLocator locator)
Copies the current position of locator.

setSourceLocator

public final void setSourceLocator(SourceLocator locator)
Links our location to the one give.

toString

public String toString(int max)
Convert this to a String containing the recorded errors.

Parameters: max the maximum number of error error to list

Returns: a String with one '\n'-terminated line per recorded error