| java.lang.Object
 org.apache.xml.utils.ListingErrorHandler
| ListingErrorHandler | | public class ListingErrorHandler implements ErrorHandler,ErrorListener(Code) | | 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.
author:
shane_curcuru@us.ibm.com
version:
$Id: ListingErrorHandler.java,v 1.9 2005/01/24 04:04:40 mcnamara Exp $ |
| Field Summary | |
| protected PrintWriter | m_pw
| | protected boolean | throwOnError
If we should throw exception on errors; default:true. | | protected boolean | throwOnFatalError
If we should throw exception on fatalErrors; default:true. | | protected boolean | throwOnWarning
If we should throw exception on warnings; default:false. |
| Method Summary | |
| public void | error(SAXParseException exception)
Receive notification of a recoverable error.
This corresponds to the definition of "error" in section 1.2
of the W3C XML 1.0 Recommendation. | | public void | error(TransformerException exception)
Receive notification of a recoverable error.
The transformer must continue to try and provide normal transformation
after invoking this method. | | public void | fatalError(SAXParseException exception)
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. | | public void | fatalError(TransformerException exception)
Receive notification of a non-recoverable error.
The transformer must continue to try and provide normal transformation
after invoking this method. | | protected static String | getSourceLine(String sourceUrl, int lineNum)
Return the specific source line that caused the exception,
if possible to load it; allow exceptions to be thrown. | | public boolean | getThrowOnError()
User-settable behavior: when to re-throw exceptions. | | public boolean | getThrowOnFatalError()
User-settable behavior: when to re-throw exceptions. | | public boolean | getThrowOnWarning()
User-settable behavior: when to re-throw exceptions. | | public static void | logExceptionLocation(PrintWriter pw, Throwable exception)
Print out location information about the exception. | | public static void | logSourceLine(PrintWriter pw, SourceLocator locator)
Print out the specific source line that caused the exception,
if possible to load it. | | public void | setThrowOnError(boolean b)
User-settable behavior: when to re-throw exceptions. | | public void | setThrowOnFatalError(boolean b)
User-settable behavior: when to re-throw exceptions. | | public void | setThrowOnWarning(boolean b)
User-settable behavior: when to re-throw exceptions. | | public void | warning(SAXParseException exception)
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. | | public void | warning(TransformerException exception)
Receive notification of a warning.
javax.xml.transform.Transformer can use this method to report
conditions that are not errors or fatal errors. |
| throwOnError | | protected boolean throwOnError(Code) | | If we should throw exception on errors; default:true.
|
| throwOnFatalError | | protected boolean throwOnFatalError(Code) | | If we should throw exception on fatalErrors; default:true.
|
| throwOnWarning | | protected boolean throwOnWarning(Code) | | If we should throw exception on warnings; default:false.
|
| ListingErrorHandler | | public ListingErrorHandler(PrintWriter pw)(Code) | | Constructor ListingErrorHandler; user-supplied PrintWriter.
|
| ListingErrorHandler | | public ListingErrorHandler()(Code) | | Constructor ListingErrorHandler; uses System.err.
|
| error | | public void error(SAXParseException exception) throws SAXException(Code) | | 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.
Parameters:
exception - The error information encapsulated in aSAX parse exception.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception; only if setThrowOnErroris true.
See Also: org.xml.sax.SAXParseException
See Also: |
| fatalError | | public void fatalError(SAXParseException exception) throws SAXException(Code) | | 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.
Parameters:
exception - The error information encapsulated in aSAX parse exception.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception; only if setThrowOnFatalError is true.
See Also: org.xml.sax.SAXParseException |
| fatalError | | public void fatalError(TransformerException exception) throws TransformerException(Code) | | 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.
Parameters:
exception - The error information encapsulated in atransformer exception.
throws:
javax.xml.transform.TransformerException - only if setThrowOnError is true.
See Also: javax.xml.transform.TransformerException |
| getSourceLine | | protected static String getSourceLine(String sourceUrl, int lineNum) throws Exception(Code) | | Return the specific source line that caused the exception,
if possible to load it; allow exceptions to be thrown.
author:
shane_curcuru@us.ibm.com |
| getThrowOnError | | public boolean getThrowOnError()(Code) | | User-settable behavior: when to re-throw exceptions.
if we throw an exception on errors |
| getThrowOnFatalError | | public boolean getThrowOnFatalError()(Code) | | User-settable behavior: when to re-throw exceptions.
if we throw an exception on fatalErrors |
| getThrowOnWarning | | public boolean getThrowOnWarning()(Code) | | User-settable behavior: when to re-throw exceptions.
if we throw an exception on warnings |
| logExceptionLocation | | public static void logExceptionLocation(PrintWriter pw, Throwable exception)(Code) | | Print out location information about the exception.
Cribbed from DefaultErrorHandler.printLocation()
Parameters:
pw - PrintWriter to send output to
Parameters:
exception - TransformerException or SAXParseExceptionto log information about |
| logSourceLine | | public static void logSourceLine(PrintWriter pw, SourceLocator locator)(Code) | | Print out the specific source line that caused the exception,
if possible to load it.
Parameters:
pw - PrintWriter to send output to
Parameters:
locator - Xalan wrapper for either a JAXP or a SAX source location object |
| setThrowOnError | | public void setThrowOnError(boolean b)(Code) | | 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!
Parameters:
b - if we should throw an exception on errors |
| setThrowOnFatalError | | public void setThrowOnFatalError(boolean b)(Code) | | 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.
Parameters:
b - if we should throw an exception on fatalErrors |
| setThrowOnWarning | | public void setThrowOnWarning(boolean b)(Code) | | 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.
Parameters:
b - if we should throw an exception on warnings |
| warning | | public void warning(SAXParseException exception) throws SAXException(Code) | | 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.
Parameters:
exception - The warning information encapsulated in aSAX parse exception.
exception:
org.xml.sax.SAXException - Any SAX exception, possiblywrapping another exception; only if setThrowOnWarning is true.
See Also: org.xml.sax.SAXParseException
See Also: |
|
|