Result
Stay organized with collections
Save and categorize content based on your preferences.
Known Indirect 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.
Constant Summary
| String |
PI_DISABLE_OUTPUT_ESCAPING |
The name of the processing instruction that is sent if the
result tree disables output escaping. |
| String |
PI_ENABLE_OUTPUT_ESCAPING |
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 Method Summary
|
abstract
String
|
getSystemId()
Get the system identifier that was set with setSystemId.
|
|
abstract
void
|
|
Constants
public
static
final
String
PI_DISABLE_OUTPUT_ESCAPING
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.
Constant Value:
"javax.xml.transform.disable-output-escaping"
public
static
final
String
PI_ENABLE_OUTPUT_ESCAPING
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.
Constant Value:
"javax.xml.transform.enable-output-escaping"
Public Methods
public
abstract
String
getSystemId
()
Get the system identifier that was set with setSystemId.
Returns
- The system identifier that was set with setSystemId,
or null if setSystemId was not called.
public
abstract
void
setSystemId
(String systemId)
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 |
The system identifier as a URI string.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-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 2024-07-10 UTC."],[[["`Result` is an interface that holds information for building a transformation result tree, which can be XML, plain text, HTML, or other markup."],["It provides methods to get and set the system identifier, a URI string that helps identify the result's location or source."],["`Result` defines constants for processing instructions related to disabling and enabling output escaping during serialization."],["Known implementations of `Result` include `DOMResult`, `SAXResult`, and `StreamResult`, each catering to a different result representation."],["Output escaping can be controlled using processing instructions defined by the constants `PI_DISABLE_OUTPUT_ESCAPING` and `PI_ENABLE_OUTPUT_ESCAPING` to manage well-formedness of the output."]]],["The `Result` interface defines how to build a transformation result tree. It includes methods to `getSystemId` and `setSystemId`, which manage a URI for the result's location, useful for error handling or relative URI resolution. `PI_DISABLE_OUTPUT_ESCAPING` and `PI_ENABLE_OUTPUT_ESCAPING` constants control output escaping during serialization. Indirect subclasses like `DOMResult`, `SAXResult`, and `StreamResult` hold the transformation result in different formats (DOM, SAX, stream).\n"]]
