org.apache.xml.utils
Class ListingErrorHandler
java.lang.Object
org.apache.xml.utils.ListingErrorHandler
- ErrorHandler, ErrorListener
public class ListingErrorHandler
extends java.lang.Object
implements ErrorHandler, ErrorListener
Sample implementation of similar SAX ErrorHandler and JAXP ErrorListener.
This implementation is suitable for various use cases, and
provides some basic configuration API's as well to control
when we re-throw errors, etc.
$Id: ListingErrorHandler.java 468655 2006-10-28 07:12:06Z minchau $
void | error(SAXParseException exception) - Receive notification of a recoverable error.
|
void | error(TransformerException exception) - Receive notification of a recoverable error.
|
void | fatalError(SAXParseException exception) - Receive notification of a non-recoverable error.
|
void | fatalError(TransformerException exception) - Receive notification of a non-recoverable error.
|
boolean | getThrowOnError() - User-settable behavior: when to re-throw exceptions.
|
boolean | getThrowOnFatalError() - User-settable behavior: when to re-throw exceptions.
|
boolean | getThrowOnWarning() - User-settable behavior: when to re-throw exceptions.
|
static void | logExceptionLocation(PrintWriter pw, Throwable exception) - Print out location information about the exception.
|
static void | logSourceLine(PrintWriter pw, SourceLocator locator) - Print out the specific source line that caused the exception,
if possible to load it.
|
void | setThrowOnError(boolean b) - User-settable behavior: when to re-throw exceptions.
|
void | setThrowOnFatalError(boolean b) - User-settable behavior: when to re-throw exceptions.
|
void | setThrowOnWarning(boolean b) - User-settable behavior: when to re-throw exceptions.
|
void | warning(SAXParseException exception) - Receive notification of a warning.
|
void | warning(TransformerException exception) - Receive notification of a warning.
|
ListingErrorHandler
public ListingErrorHandler()
Constructor ListingErrorHandler; uses System.err.
ListingErrorHandler
public ListingErrorHandler(PrintWriter pw)
Constructor ListingErrorHandler; user-supplied PrintWriter.
error
public void error(SAXParseException exception)
throws SAXException
Receive notification of a recoverable error.
This corresponds to the definition of "error" in section 1.2
of the W3C XML 1.0 Recommendation. For example, a validating
parser would use this callback to report the violation of a
validity constraint. The default behaviour is to take no
action.
The SAX parser must continue to provide normal parsing events
after invoking this method: it should still be possible for the
application to process the document through to the end. If the
application cannot do so, then the parser should report a fatal
error even if the XML 1.0 recommendation does not require it to
do so.
Filters may use this method to report other, non-XML errors
as well.
exception
- The error information encapsulated in a
SAX parse exception.
org.xml.sax.SAXParseException
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.
exception
- The error information encapsulated in a
transformer exception.
javax.xml.transform.TransformerException
fatalError
public void fatalError(SAXParseException exception)
throws SAXException
Receive notification of a non-recoverable error.
This corresponds to the definition of "fatal error" in
section 1.2 of the W3C XML 1.0 Recommendation. For example, a
parser would use this callback to report the violation of a
well-formedness constraint.
The application must assume that the document is unusable
after the parser has invoked this method, and should continue
(if at all) only for the sake of collecting addition error
messages: in fact, SAX parsers are free to stop reporting any
other events once this method has been invoked.
exception
- The error information encapsulated in a
SAX parse exception.
org.xml.sax.SAXParseException
fatalError
public void fatalError(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.
exception
- The error information encapsulated in a
transformer exception.
javax.xml.transform.TransformerException
getThrowOnError
public boolean getThrowOnError()
User-settable behavior: when to re-throw exceptions.
- if we throw an exception on errors
getThrowOnFatalError
public boolean getThrowOnFatalError()
User-settable behavior: when to re-throw exceptions.
- if we throw an exception on fatalErrors
getThrowOnWarning
public boolean getThrowOnWarning()
User-settable behavior: when to re-throw exceptions.
- if we throw an exception on warnings
logExceptionLocation
public static void logExceptionLocation(PrintWriter pw,
Throwable exception)
Print out location information about the exception.
Cribbed from DefaultErrorHandler.printLocation()
pw
- PrintWriter to send output toexception
- TransformerException or SAXParseException
to log information about
logSourceLine
public static void logSourceLine(PrintWriter pw,
SourceLocator locator)
Print out the specific source line that caused the exception,
if possible to load it.
pw
- PrintWriter to send output tolocator
- Xalan wrapper for either a JAXP or a SAX
source location object
setThrowOnError
public void setThrowOnError(boolean b)
User-settable behavior: when to re-throw exceptions.
This allows per-instance configuration of
ListingErrorHandlers. You can ask us to either throw
an exception when we're called for various warning /
error / fatalErrors, or simply log them and continue.
Note that the behavior of many parsers/transformers
after an error is not necessarily defined!
b
- if we should throw an exception on errors
setThrowOnFatalError
public void setThrowOnFatalError(boolean b)
User-settable behavior: when to re-throw exceptions.
This allows per-instance configuration of
ListingErrorHandlers. You can ask us to either throw
an exception when we're called for various warning /
error / fatalErrors, or simply log them and continue.
Note that the behavior of many parsers/transformers
after a fatalError is not necessarily defined, most
products will probably barf if you continue.
b
- if we should throw an exception on fatalErrors
setThrowOnWarning
public void setThrowOnWarning(boolean b)
User-settable behavior: when to re-throw exceptions.
This allows per-instance configuration of
ListingErrorHandlers. You can ask us to either throw
an exception when we're called for various warning /
error / fatalErrors, or simply log them and continue.
b
- if we should throw an exception on warnings
warning
public void warning(SAXParseException exception)
throws SAXException
Receive notification of a warning.
SAX parsers will use this method to report conditions that
are not errors or fatal errors as defined by the XML 1.0
recommendation. The default behaviour is to take no action.
The SAX parser must continue to provide normal parsing events
after invoking this method: it should still be possible for the
application to process the document through to the end.
Filters may use this method to report other, non-XML warnings
as well.
exception
- The warning information encapsulated in a
SAX parse exception.
org.xml.sax.SAXParseException
warning
public void warning(TransformerException exception)
throws TransformerException
Receive notification of a warning.
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.
exception
- The warning information encapsulated in a
transformer exception.
javax.xml.transform.TransformerException
Copyright © 2006 Apache XML Project. All Rights Reserved.