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 its own custom
ErrorListener
, the default ErrorListener
is used which reports all warnings and errors to System.err
and does not throw any Exception
s.
Applications are strongly encouraged to register and use
ErrorListener
s that insure proper behavior for warnings and
errors.
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(TransformerException exception)
.
Transformer
s may use this mechanism to report XML parsing
errors as well as transformation errors.
Modifier and Type | Method and Description |
---|---|
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.
|
void warning(TransformerException exception) throws TransformerException
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.
exception
- The warning information encapsulated in a
transformer exception.TransformerException
- if the application
chooses to discontinue the transformation.TransformerException
void error(TransformerException exception) throws TransformerException
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.
exception
- The error information encapsulated in a
transformer exception.TransformerException
- if the application
chooses to discontinue the transformation.TransformerException
void fatalError(TransformerException exception) throws TransformerException
Receive notification of a non-recoverable error.
The processor may choose to continue, but will not normally proceed to a successful completion.
The method should throw an exception if it is unable to process the error, or if it wishes execution to terminate immediately. The processor will not necessarily honor this request.
exception
- The error information encapsulated in a
TransformerException
.TransformerException
- if the application
chooses to discontinue the transformation.TransformerException
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2023, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.