// $Id: ErrorListener.java,v 1.2 2003/09/19 10:10:13 jsuttor Exp $ /* * @(#)ErrorListener.java 1.12 04/07/26 * * Copyright 2004 Sun Microsystems, Inc. All rights reserved. * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms. */ package javax.xml.transform; /** *
To provide customized error handling, implement this interface and
* use the setErrorListener
method to register an instance of the
* implmentation with the {@link javax.xml.transform.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 {@link #fatalError(TransformerException exception)}.
Transformer
s may use this mechanism to report XML parsing
* errors as well as transformation errors.
{@link javax.xml.transform.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.
* * @param exception The warning information encapsulated in a * transformer exception. * * @throws javax.xml.transform.TransformerException if the application * chooses to discontinue the transformation. * * @see javax.xml.transform.TransformerException */ public abstract void warning(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.
* * @param exception The error information encapsulated in a * transformer exception. * * @throws javax.xml.transform.TransformerException if the application * chooses to discontinue the transformation. * * @see javax.xml.transform.TransformerException */ public abstract void error(TransformerException exception) throws TransformerException; /** *Receive notification of a non-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, but there is no guarantee that the output will be
* useable.
TransformerException
.
*
* @throws javax.xml.transform.TransformerException if the application
* chooses to discontinue the transformation.
*
* @see javax.xml.transform.TransformerException
*/
public abstract void fatalError(TransformerException exception)
throws TransformerException;
}