public class ListingErrorHandler extends Object implements ErrorHandler, 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.
Modifier and Type | Field and Description |
---|---|
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.
|
Constructor and Description |
---|
ListingErrorHandler()
Constructor ListingErrorHandler; uses System.err.
|
ListingErrorHandler(PrintWriter pw)
Constructor ListingErrorHandler; user-supplied PrintWriter.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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.
|
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.
|
protected PrintWriter m_pw
protected boolean throwOnWarning
protected boolean throwOnError
protected boolean throwOnFatalError
public ListingErrorHandler(PrintWriter pw)
public ListingErrorHandler()
public void warning(SAXParseException exception) throws SAXException
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.
warning
in interface ErrorHandler
exception
- The warning information encapsulated in a
SAX parse exception.SAXException
- Any SAX exception, possibly
wrapping another exception; only if setThrowOnWarning is true.SAXParseException
public void error(SAXParseException exception) throws SAXException
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.
error
in interface ErrorHandler
exception
- The error information encapsulated in a
SAX parse exception.SAXException
- Any SAX exception, possibly
wrapping another exception; only if setThrowOnErroris true.SAXParseException
public void fatalError(SAXParseException exception) throws SAXException
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.
fatalError
in interface ErrorHandler
exception
- The error information encapsulated in a
SAX parse exception.SAXException
- Any SAX exception, possibly
wrapping another exception; only if setThrowOnFatalError is true.SAXParseException
public 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.
warning
in interface ErrorListener
exception
- The warning information encapsulated in a
transformer exception.TransformerException
- only if
setThrowOnWarning is true.TransformerException
public 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.
error
in interface ErrorListener
exception
- The error information encapsulated in a
transformer exception.TransformerException
- only if
setThrowOnError is true.TransformerException
public void fatalError(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, but there is no guarantee that the output will be useable.
fatalError
in interface ErrorListener
exception
- The error information encapsulated in a
transformer exception.TransformerException
- only if
setThrowOnError is true.TransformerException
public static void logExceptionLocation(PrintWriter pw, Throwable exception)
pw
- PrintWriter to send output toexception
- TransformerException or SAXParseException
to log information aboutpublic static void logSourceLine(PrintWriter pw, SourceLocator locator)
pw
- PrintWriter to send output tolocator
- Xalan wrapper for either a JAXP or a SAX
source location objectprotected static String getSourceLine(String sourceUrl, int lineNum) throws Exception
Exception
public void setThrowOnWarning(boolean b)
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 warningspublic boolean getThrowOnWarning()
public void setThrowOnError(boolean b)
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 errorspublic boolean getThrowOnError()
public void setThrowOnFatalError(boolean b)
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 fatalErrorspublic boolean getThrowOnFatalError()
Copyright © 2018 JBoss by Red Hat. All rights reserved.