Stay organized with collections
Save and categorize content based on your preferences.
Result
interface Result
Known Direct Subclasses
DOMResult |
Acts as a holder for a transformation result tree in the form of a Document Object Model (DOM) tree.
|
SAXResult |
Acts as an holder for a transformation Result.
|
StreamResult |
Acts as an holder for a transformation result, which may be XML, plain Text, HTML, or some other form of markup.
|
|
An object that implements this interface contains the information needed to build a transformation result tree.
Summary
Constants |
static String |
The name of the processing instruction that is sent if the result tree disables output escaping.
|
static String |
The name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.
|
Public methods |
abstract String! |
Get the system identifier that was set with setSystemId.
|
abstract Unit |
Set the system identifier for this Result.
|
Constants
PI_DISABLE_OUTPUT_ESCAPING
static val PI_DISABLE_OUTPUT_ESCAPING: String
The name of the processing instruction that is sent if the result tree disables output escaping.
Normally, result tree serialization escapes & and < (and possibly other characters) when outputting text nodes. This ensures that the output is well-formed XML. However, it is sometimes convenient to be able to produce output that is almost, but not quite well-formed XML; for example, the output may include ill-formed sections that will be transformed into well-formed XML by a subsequent non-XML aware process. If a processing instruction is sent with this name, serialization should be output without any escaping.
Result DOM trees may also have PI_DISABLE_OUTPUT_ESCAPING and PI_ENABLE_OUTPUT_ESCAPING inserted into the tree.
Value: "javax.xml.transform.disable-output-escaping"
PI_ENABLE_OUTPUT_ESCAPING
static val PI_ENABLE_OUTPUT_ESCAPING: String
The name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.
Value: "javax.xml.transform.enable-output-escaping"
Public methods
getSystemId
abstract fun getSystemId(): String!
Get the system identifier that was set with setSystemId.
Return |
String! |
The system identifier that was set with setSystemId, or null if setSystemId was not called. |
setSystemId
abstract fun setSystemId(systemId: String!): Unit
Set the system identifier for this Result.
If the Result is not to be written to a file, the system identifier is optional. The application may still want to provide one, however, for use in error messages and warnings, or to resolve relative output identifiers.
Parameters |
systemId |
String!: The system identifier as a URI string. |
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# Result\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nResult\n======\n\n```\ninterface Result\n```\n\n|---------------------------------|\n| [javax.xml.transform.Result](#) |\n\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Known Direct Subclasses [DOMResult](/reference/kotlin/javax/xml/transform/dom/DOMResult), [SAXResult](/reference/kotlin/javax/xml/transform/sax/SAXResult), [StreamResult](/reference/kotlin/javax/xml/transform/stream/StreamResult) |---------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| | [DOMResult](/reference/kotlin/javax/xml/transform/dom/DOMResult) | Acts as a holder for a transformation result tree in the form of a Document Object Model (DOM) tree. | | [SAXResult](/reference/kotlin/javax/xml/transform/sax/SAXResult) | Acts as an holder for a transformation Result. | | [StreamResult](/reference/kotlin/javax/xml/transform/stream/StreamResult) | Acts as an holder for a transformation result, which may be XML, plain Text, HTML, or some other form of markup. | |\n\nAn object that implements this interface contains the information needed to build a transformation result tree.\n\nSummary\n-------\n\n| Constants ||\n|-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| static [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [PI_DISABLE_OUTPUT_ESCAPING](#PI_DISABLE_OUTPUT_ESCAPING:kotlin.String) The name of the processing instruction that is sent if the result tree disables output escaping. |\n| static [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html) | [PI_ENABLE_OUTPUT_ESCAPING](#PI_ENABLE_OUTPUT_ESCAPING:kotlin.String) The name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction. |\n\n| Public methods ||\n|--------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getSystemId](#getSystemId())`()` Get the system identifier that was set with setSystemId. |\n| abstract [Unit](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html) | [setSystemId](#setSystemId(kotlin.String))`(`systemId:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Set the system identifier for this Result. |\n\nConstants\n---------\n\n### PI_DISABLE_OUTPUT_ESCAPING\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val PI_DISABLE_OUTPUT_ESCAPING: String\n```\n\nThe name of the processing instruction that is sent if the result tree disables output escaping.\n\nNormally, result tree serialization escapes \\& and \\\u003c (and possibly other characters) when outputting text nodes. This ensures that the output is well-formed XML. However, it is sometimes convenient to be able to produce output that is almost, but not quite well-formed XML; for example, the output may include ill-formed sections that will be transformed into well-formed XML by a subsequent non-XML aware process. If a processing instruction is sent with this name, serialization should be output without any escaping.\n\nResult DOM trees may also have PI_DISABLE_OUTPUT_ESCAPING and PI_ENABLE_OUTPUT_ESCAPING inserted into the tree. \n\n Value: \"javax.xml.transform.disable-output-escaping\"\n\n**See Also**\n\n### PI_ENABLE_OUTPUT_ESCAPING\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nstatic val PI_ENABLE_OUTPUT_ESCAPING: String\n```\n\nThe name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction. \n\n Value: \"javax.xml.transform.enable-output-escaping\"\n\n**See Also**\n\nPublic methods\n--------------\n\n### getSystemId\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun getSystemId(): String!\n```\n\nGet the system identifier that was set with setSystemId.\n\n| Return ||\n|-----------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | The system identifier that was set with setSystemId, or null if setSystemId was not called. |\n\n### setSystemId\n\nAdded in [API level 8](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun setSystemId(systemId: String!): Unit\n```\n\nSet the system identifier for this Result.\n\nIf the Result is not to be written to a file, the system identifier is optional. The application may still want to provide one, however, for use in error messages and warnings, or to resolve relative output identifiers.\n\n| Parameters ||\n|------------|---------------------------------------------------------------------------------------------------------------------------|\n| `systemId` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: The system identifier as a URI string. |"]]