Stay organized with collections
Save and categorize content based on your preferences.
ErrorListener
interface ErrorListener
To provide customized error handling, implement this interface and use the setErrorListener
method to register an instance of the implementation with the 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 fatalError(javax.xml.transform.TransformerException)
.
Transformer
s may use this mechanism to report XML parsing errors as well as transformation errors.
Summary
Public methods |
abstract Unit |
Receive notification of a recoverable error.
|
abstract Unit |
Receive notification of a non-recoverable error.
|
abstract Unit |
Receive notification of a warning.
|
Public methods
error
abstract fun error(exception: TransformerException!): Unit
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.
Parameters |
exception |
TransformerException!: The error information encapsulated in a transformer exception. |
Exceptions |
javax.xml.transform.TransformerException |
if the application chooses to discontinue the transformation. |
fatalError
abstract fun fatalError(exception: TransformerException!): Unit
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 |
TransformerException!: The error information encapsulated in a TransformerException . |
Exceptions |
javax.xml.transform.TransformerException |
if the application chooses to discontinue the transformation. |
warning
abstract fun warning(exception: TransformerException!): Unit
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 behavior 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.
Parameters |
exception |
TransformerException!: The warning information encapsulated in a transformer exception. |
Exceptions |
javax.xml.transform.TransformerException |
if the application chooses to discontinue the transformation. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# ErrorListener\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nErrorListener\n=============\n\n```\ninterface ErrorListener\n```\n\n|----------------------------------------|\n| [javax.xml.transform.ErrorListener](#) |\n\nTo provide customized error handling, implement this interface and use the `setErrorListener` method to register an instance of the implementation with the [javax.xml.transform.Transformer](/reference/kotlin/javax/xml/transform/Transformer). The `Transformer` then reports all errors and warnings through this interface.\n\nIf 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.\n\nFor 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(javax.xml.transform.TransformerException)](#fatalError(javax.xml.transform.TransformerException)).\n\n`Transformer`s may use this mechanism to report XML parsing errors as well as transformation errors.\n\nSummary\n-------\n\n| Public methods ||\n|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [error](#error(javax.xml.transform.TransformerException))`(`exception:` `[TransformerException](/reference/kotlin/javax/xml/transform/TransformerException)!`)` Receive notification of a recoverable error. |\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [fatalError](#fatalError(javax.xml.transform.TransformerException))`(`exception:` `[TransformerException](/reference/kotlin/javax/xml/transform/TransformerException)!`)` Receive notification of a non-recoverable error. |\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [warning](#warning(javax.xml.transform.TransformerException))`(`exception:` `[TransformerException](/reference/kotlin/javax/xml/transform/TransformerException)!`)` Receive notification of a warning. |\n\nPublic methods\n--------------\n\n### error\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun error(exception: TransformerException!): Unit\n```\n\nReceive notification of a recoverable error.\n\nThe 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.\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|\n| `exception` | [TransformerException](/reference/kotlin/javax/xml/transform/TransformerException)!: The error information encapsulated in a transformer exception. |\n\n| Exceptions ||\n|--------------------------------------------|---------------------------------------------------------------|\n| `javax.xml.transform.TransformerException` | if the application chooses to discontinue the transformation. |\n\n**See Also**\n\n- [javax.xml.transform.TransformerException](/reference/kotlin/javax/xml/transform/TransformerException) \n\n### fatalError\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun fatalError(exception: TransformerException!): Unit\n```\n\nReceive notification of a non-recoverable error.\n\nThe `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.\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `exception` | [TransformerException](/reference/kotlin/javax/xml/transform/TransformerException)!: The error information encapsulated in a `TransformerException`. |\n\n| Exceptions ||\n|--------------------------------------------|---------------------------------------------------------------|\n| `javax.xml.transform.TransformerException` | if the application chooses to discontinue the transformation. |\n\n**See Also**\n\n- [javax.xml.transform.TransformerException](/reference/kotlin/javax/xml/transform/TransformerException) \n\n### warning\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun warning(exception: TransformerException!): Unit\n```\n\nReceive notification of a warning.\n\n[javax.xml.transform.Transformer](/reference/kotlin/javax/xml/transform/Transformer) can use this method to report conditions that are not errors or fatal errors. The default behavior is to take no action.\n\nAfter 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.\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `exception` | [TransformerException](/reference/kotlin/javax/xml/transform/TransformerException)!: The warning information encapsulated in a transformer exception. |\n\n| Exceptions ||\n|--------------------------------------------|---------------------------------------------------------------|\n| `javax.xml.transform.TransformerException` | if the application chooses to discontinue the transformation. |\n\n**See Also**\n\n- [javax.xml.transform.TransformerException](/reference/kotlin/javax/xml/transform/TransformerException)"]]