uk.ac.sheffield.jast

Class Logging

java.lang.Object

uk.ac.sheffield.jast.Logging

Direct Known Subclasses:

BasicBuilder, BasicReader, BasicScanner, BasicWriter, XMLParser

public abstract class Logging
extends java.lang.Object

Logging is an abstract ancestor of all file-streaming objects that report error messages. Logging is the parent of BasicReader and BasicWriter, and through these, the ancestor of XMLReader, XMLWriter, ASTReader, ASTWriter and XMLParser. It provides the common protocol for reporting syntax errors, semantic errors and character encoding errors. It expects subclasses to provide information about the line number, the state of the stream, and the XML building-context of errors.

Version:

2.5

Author:

Anthony J H Simons

Constructor Summary

Constructors

Constructor and Description
Logging()

Method Summary

Modifier and Type	Method and Description
protected void	encodingError(java.lang.String message) Reports an encoding error, when an XML file is read with the wrong character encoding.
protected abstract boolean	endOfStream() Reports whether the end of the input or output stream has been reached.
protected abstract java.lang.String	getContext() Returns the XML context in which any kind of error was detected.
protected abstract int	getLineNumber() Returns the current line number reached during reading or writing.
protected void	semanticError(java.lang.String message) Reports model-building error, when the model constraints are violated.
protected void	syntaxError(java.lang.String message) Reports an XML syntax error, when badly-formed XML syntax is detected.

Methods inherited from class java.lang.Object

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

Constructor Detail

Logging

public Logging()

Method Detail

encodingError

protected void encodingError(java.lang.String message)
                      throws java.io.UnsupportedEncodingException

Reports an encoding error, when an XML file is read with the wrong character encoding. Prepends further diagnostic information about the line number and the XML document context to the error message.

Parameters:

message - the error message.

Throws:

java.io.UnsupportedEncodingException - always.

syntaxError

protected void syntaxError(java.lang.String message)
                    throws SyntaxError,
                           java.io.EOFException

Reports an XML syntax error, when badly-formed XML syntax is detected. Prepends further diagnostic information about the line number and the XML document context to the error message.

Parameters:

message - the error message.

Throws:

java.io.EOFException - if the end of the stream was reached prematurely.

SyntaxError - if a syntax error was detected before the end of the stream.

semanticError

protected void semanticError(java.lang.String message)
                      throws SemanticError

Reports model-building error, when the model constraints are violated. Prepends further diagnostic information about the line number and the XML document context to the error message.

Parameters:

message - the error message.

Throws:

SemanticError - always.

getContext

protected abstract java.lang.String getContext()

Returns the XML context in which any kind of error was detected.

Returns:

the context, in the style of XPath.

getLineNumber

protected abstract int getLineNumber()

Returns the current line number reached during reading or writing.

Returns:

the current line number.

endOfStream

protected abstract boolean endOfStream()

Reports whether the end of the input or output stream has been reached.

Returns:

true, if the end of the stream has been reached.