Result
public class DOMResult extends Object implements Result
If no output DOM source is set, the transformation will create a Document node as the holder for the result of the transformation, which may be retrieved with getNode()
.
Modifier and Type | Field | Description |
---|---|---|
static final String |
FEATURE |
If TransformerFactory.getFeature(java.lang.String) returns true when passed this value as an argument, the Transformer supports Result output of this type. |
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
Constructor | Description |
---|---|
DOMResult() |
Zero-argument default constructor. |
DOMResult |
Use a DOM node to create a new output target. |
DOMResult |
Use a DOM node to create a new output target with the specified System ID. |
DOMResult |
Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before. |
DOMResult |
Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before and the specified System ID. |
Modifier and Type | Method | Description |
---|---|---|
Node |
getNextSibling() |
Get the child node before which the result nodes will be inserted. |
Node |
getNode() |
Get the node that will contain the result DOM tree. |
String |
getSystemId() |
Get the System Identifier. |
void |
setNextSibling |
Set the child node before which the result nodes will be inserted. |
void |
setNode |
Set the node that will contain the result DOM tree. |
void |
setSystemId |
Set the systemId that may be used in association with the node. |
public static final String FEATURE
TransformerFactory.getFeature(java.lang.String)
returns true
when passed this value as an argument, the Transformer
supports Result
output of this type.public DOMResult()
node
, siblingNode
and systemId
will be set to null
.
public DOMResult(Node node)
In practice, the node should be a Document
node, a DocumentFragment
node, or a Element
node. In other words, a node that accepts children.
siblingNode
and systemId
will be set to null
.
node
- The DOM node that will contain the result tree.public DOMResult(Node node, String systemId)
In practice, the node should be a Document
node, a DocumentFragment
node, or a Element
node. In other words, a node that accepts children.
siblingNode
will be set to null
.
node
- The DOM node that will contain the result tree.systemId
- The system identifier which may be used in association with this node.public DOMResult(Node node, Node nextSibling)
In practice, node
and nextSibling
should be a Document
node, a DocumentFragment
node, or a Element
node. In other words, a node that accepts children.
Use nextSibling
to specify the child node where the result nodes should be inserted before. If nextSibling
is not a sibling of node
, then an IllegalArgumentException
is thrown. If node
is null
and nextSibling
is not null
, then an IllegalArgumentException
is thrown. If nextSibling
is null
, then the behavior is the same as calling DOMResult(Node node)
, i.e. append the result nodes as the last child of the specified node
.
systemId
will be set to null
.
node
- The DOM node that will contain the result tree.nextSibling
- The child node where the result nodes should be inserted before.IllegalArgumentException
- If nextSibling
is not a sibling of node
or node
is null
and nextSibling
is not null
.public DOMResult(Node node, Node nextSibling, String systemId)
In practice, node
and nextSibling
should be a Document
node, a DocumentFragment
node, or a Element
node. In other words, a node that accepts children.
Use nextSibling
to specify the child node where the result nodes should be inserted before. If nextSibling
is not a sibling of node
, then an IllegalArgumentException
is thrown. If node
is null
and nextSibling
is not null
, then an IllegalArgumentException
is thrown. If nextSibling
is null
, then the behavior is the same as calling DOMResult(Node node, String systemId)
, i.e. append the result nodes as the last child of the specified node and use the specified System ID.
node
- The DOM node that will contain the result tree.nextSibling
- The child node where the result nodes should be inserted before.systemId
- The system identifier which may be used in association with this node.IllegalArgumentException
- If nextSibling
is not a sibling of node
or node
is null
and nextSibling
is not null
.public void setNode(Node node)
In practice, the node should be a Document
node, a DocumentFragment
node, or a Element
node. In other words, a node that accepts children.
An IllegalStateException
is thrown if nextSibling
is not null
and node
is not a parent of nextSibling
. An IllegalStateException
is thrown if node
is null
and nextSibling
is not null
.
node
- The node to which the transformation will be appended.IllegalStateException
- If nextSibling
is not null
and nextSibling
is not a child of node
or node
is null
and nextSibling
is not null
.public Node getNode()
If no node was set via DOMResult(Node node)
, DOMResult(Node node, String systeId)
, DOMResult(Node node, Node nextSibling)
, DOMResult(Node node, Node nextSibling, String systemId)
or setNode(Node node)
, then the node will be set by the transformation, and may be obtained from this method once the transformation is complete. Calling this method before the transformation will return null
.
public void setNextSibling(Node nextSibling)
Use nextSibling
to specify the child node before which the result nodes should be inserted. If nextSibling
is not a descendant of node
, then an IllegalArgumentException
is thrown. If node
is null
and nextSibling
is not null
, then an IllegalStateException
is thrown. If nextSibling
is null
, then the behavior is the same as calling DOMResult(Node node)
, i.e. append the result nodes as the last child of the specified node
.
nextSibling
- The child node before which the result nodes will be inserted.IllegalArgumentException
- If nextSibling
is not a descendant of node
.IllegalStateException
- If node
is null
and nextSibling
is not null
.public Node getNextSibling()
If no node was set via DOMResult(Node node, Node nextSibling)
, DOMResult(Node node, Node nextSibling, String systemId)
or setNextSibling(Node nextSibling)
, then null
will be returned.
public void setSystemId(String systemId)
setSystemId
in interface Result
systemId
- The system identifier as a URI string.public String getSystemId()
If no System ID was set via DOMResult(Node node, String systemId)
, DOMResult(Node node, Node nextSibling, String systemId)
or setSystemId(String systemId)
, then null
will be returned.
getSystemId
in interface Result
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.xml/javax/xml/transform/dom/DOMResult.html