ErrorListener (Java 2 Platform Ent. Ed. v1.4) - Java Platform, Enterprise Edition v1.4 API Specifications

Overview

Package

Class

Tree

Deprecated

Index

Help

Java^TM 2 Platform
Ent. Ed. v1.4

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.transform
Interface ErrorListener

public interface ErrorListener

To provide customized error handling, implement this interface and use the setErrorListener method to register an instance of the implmentation with the Transformer. The Transformer then reports all errors and warnings through this interface.

If an application does not register an ErrorListener, errors are reported to System.err.

For transformation errors, a Transformer must use this interface instead of throwing an exception: it is up to the application to decide whether to throw an exception for different types of errors and warnings. Note however that the Transformer is not required to continue with the transformation after a call to fatalError.

Transformers may use this mechanism to report XML parsing errors as well as transformation errors.

Method Summary

void error(TransformerException exception)
          Receive notification of a recoverable error.

void fatalError(TransformerException exception)
          Receive notification of a non-recoverable error.

void warning(TransformerException exception)
          Receive notification of a warning.

Method Detail

warning

public void warning(TransformerException exception)
             throws TransformerException

Receive notification of a warning.

Transformer can use this method to report conditions that are not errors or fatal errors. The default behaviour is to take no action.

After invoking this method, the Transformer must continue with the transformation. It should still be possible for the application to process the document through to the end.

Parameters:: exception - The warning information encapsulated in a transformer exception.
Throws:: TransformerException - if the application chooses to discontinue the transformation.
See Also:: TransformerException

error

public void error(TransformerException exception)
           throws TransformerException

Receive notification of a recoverable error.

The transformer must continue to try and provide normal transformation after invoking this method. It should still be possible for the application to process the document through to the end if no other errors are encountered.

Parameters:: exception - The error information encapsulated in a transformer exception.
Throws:: TransformerException - if the application chooses to discontinue the transformation.
See Also:: TransformerException

fatalError

public void fatalError(TransformerException exception)
                throws TransformerException

Receive notification of a non-recoverable error.

Parameters:: exception - The error information encapsulated in a transformer exception.
Throws:: TransformerException - if the application chooses to discontinue the transformation.
See Also:: TransformerException