gnu.text

Class SourceError

Implemented Interfaces:
org.xml.sax.Locator, SourceLocator

public class SourceError
extends java.lang.Object
implements SourceLocator

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

Field Summary

String
code
If non-null, an error code, as might be specified by a standard.
int
column
The column number of the error, with 1 being the left-most column.
Throwable
fakeException
Provides optional stack trace.
String
filename
The name or URL of the file containing the error.
int
line
The (1-origin) location of the error.
String
message
The actual error message.
SourceError
next
Used to chain to the "next" message.
char
severity
The seriousness of the error - one of 'w' (for warning), 'e' (for error), or 'f' (for fatal error).

Constructor Summary

SourceError(char severity, String filename, int line, int column, String message)
SourceError(char severity, SourceLocator location, String message)
SourceError(LineBufferedReader port, char severity, String message)
Create a new SourceError using the current line/column from a LineBufferedReader.

Method Summary

int
getColumnNumber()
String
getFileName()
int
getLineNumber()
String
getPublicId()
String
getSystemId()
boolean
isStableSourceLocation()
void
print(java.io.PrintWriter out)
void
println(java.io.PrintStream out)
void
println(java.io.PrintWriter out)
String
toString()
Convert the error to a String.

Field Details

code

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

column

public int column
The column number of the error, with 1 being the left-most column. The value 0 means unknown or not applicable (such as the entire line).

fakeException

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

filename

public String filename
The name or URL of the file containing the error.

line

public int line
The (1-origin) location of the error.

message

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

SourceError next
Used to chain to the "next" message.

severity

public char severity
The seriousness of the error - one of 'w' (for warning), 'e' (for error), or 'f' (for fatal error).

Constructor Details

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(LineBufferedReader port,
                   char severity,
                   String message)
Create a new SourceError using the current line/column from a LineBufferedReader.

Method Details

getColumnNumber

public int getColumnNumber()
Specified by:
getColumnNumber in interface SourceLocator

getFileName

public String getFileName()
Specified by:
getFileName in interface SourceLocator

getLineNumber

public int getLineNumber()
Specified by:
getLineNumber in interface SourceLocator

getPublicId

public String getPublicId()
Specified by:
getPublicId in interface SourceLocator

getSystemId

public String getSystemId()
Specified by:
getSystemId in interface SourceLocator

isStableSourceLocation

public boolean isStableSourceLocation()
Specified by:
isStableSourceLocation in interface SourceLocator

print

public void print(java.io.PrintWriter out)

println

public void println(java.io.PrintStream out)

println

public void println(java.io.PrintWriter out)

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.