Package gnu.text

Class SourceError

java.lang.Object

gnu.text.SourceLocator.Simple

gnu.text.SourceError

All Implemented Interfaces:

SourceLocator, SourceLocator, Locator

public class SourceError
extends SourceLocator.Simple

Represents an error message from processing a "source" file.

Nested Class Summary

Nested classes/interfaces inherited from interface gnu.text.SourceLocator

SourceLocator.Simple

Field Summary

Fields

Modifier and Type	Field	Description
String	code	If non-null, an error code, as might be specified by a standard.
Throwable	fakeException	Provides optional stack trace.
String	message	The actual error message.
SourceError	next	Used to chain to the "next" message.
char	severity	The seriousness of the error - one of 'i' (for informational), 'w' (for warning), 'e' (for error), or 'f' (for fatal error).

Fields inherited from class gnu.text.SourceLocator.Simple

filename, position

Constructor Summary

Constructors

Constructor	Description
SourceError(char severity, SourceLocator location, String message)
SourceError(char severity, String filename, int line, int column, String message)
SourceError(gnu.kawa.io.InPort port, char severity, String message)	Create a new SourceError using the current line/column from a InPort.

Method Summary

Modifier and Type	Method	Description
static void	appendEscaped(Appendable out, CharSequence str)
void	appendTo(Appendable out, boolean stripDirectories, String newLine)
void	print(Appendable out)
void	println(Appendable out, boolean stripDirectories)
String	toString()	Convert the error to a String.
String	toString(boolean stripDirectories)	Convert the error to a String.

Methods inherited from class gnu.text.SourceLocator.Simple

getColumnNumber, getEndColumn, getEndLine, getFileName, getLineNumber, getPublicId, getStartColumn, getStartLine, getSystemId, isRepl, isStableSourceLocation, setFile, setLine, setLine, setLine, setLocation

Methods inherited from class java.lang.Object

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

Field Detail

next

public SourceError next

Used to chain to the "next" message.

severity

public char severity

The seriousness of the error - one of 'i' (for informational), 'w' (for warning), 'e' (for error), or 'f' (for fatal error).

code

public String code

If non-null, an error code, as might be specified by a standard.

message

public String message

The actual error message. This is post-localization and -formatting. It can contain multiple lines, separated by '\n'.

fakeException

public Throwable fakeException

Provides optional stack trace. Filled when --debug-error-prints-stack-trace or --debug-warning-prints-stack-trace option is used.

Constructor Detail

SourceError

public SourceError(char severity,
                   String filename,
                   int line,
                   int column,
                   String message)

SourceError

public SourceError(char severity,
                   SourceLocator location,
                   String message)

SourceError

public SourceError(gnu.kawa.io.InPort port,
                   char severity,
                   String message)

Create a new SourceError using the current line/column from a InPort.

Method Detail

toString

public String toString()

Convert the error to a String. The String starts with filename, line and option column, followed by the message. Warning messages are indicated as such.

Overrides:

toString in class Object

toString

public String toString(boolean stripDirectories)

Convert the error to a String. The String starts with filename, line and option column, followed by the message. Warning messages are indicated as such.

appendEscaped

public static void appendEscaped(Appendable out,
                                 CharSequence str)
                          throws IOException

Throws:

IOException

appendTo

public void appendTo(Appendable out,
                     boolean stripDirectories,
                     String newLine)

print

public void print(Appendable out)

println

public void println(Appendable out,
                    boolean stripDirectories)