OpenJDK 27 · javax.xml.transform.dom.DOMResult · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
public static final String	FEATURE If `javax.xml.transform.TransformerFactory#getFeature` returns `true` when passed this value as an argument, the `Transformer` supports `Result` output of this type.
private Node	nextSibling The child node before which the result nodes will be inserted.
private Node	node The node to which the transformation will be appended.
private String	systemId The System ID that may be used in association with the node.

Constructor Summary

Access	Constructor and Description
public	DOMResult() Zero-argument default constructor.
public	DOMResult(Node The DOM node that will contain the result tree. node) Use a DOM node to create a new output target.
public	DOMResult(Node The DOM node that will contain the result tree. node, String The system identifier which may be used in association with this node. systemId) Use a DOM node to create a new output target with the specified System ID. In practice, the node should be a `org.w3c.dom.Document` node, a `org.w3c.dom.DocumentFragment` node, or a `org.w3c.dom.Element` node.
public	DOMResult(Node The DOM node that will contain the result tree. node, Node The child node where the result nodes should be inserted before. nextSibling) Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before.
public	DOMResult(Node The DOM node that will contain the result tree. node, Node The child node where the result nodes should be inserted before. nextSibling, String The system identifier which may be used in association with this node. systemId) 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. In practice, `node` and `nextSibling` should be a `org.w3c.dom.Document` node, a `org.w3c.dom.DocumentFragment` node, or a `org.w3c.dom.Element` node.

Method Summary

Modifier and Type	Method and Description
public Node	Returns: The child node before which the result nodes will be inserted. getNextSibling() Get the child node before which the result nodes will be inserted.
public Node	Returns: The node to which the transformation will be appended. getNode() Get the node that will contain the result DOM tree.
public String	Returns: The system identifier. getSystemId() Implements javax.xml.transform.Result.getSystemId. Get the System Identifier.
public void	setNextSibling(Node The child node before which the result nodes will be inserted. nextSibling) Set the child node before which the result nodes will be inserted.
public void	setNode(Node The node to which the transformation will be appended. node) Set the node that will contain the result DOM tree.
public void	setSystemId(String The system identifier as a URI string. systemId) Implements javax.xml.transform.Result.setSystemId. Set the systemId that may be used in association with the node.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

FEATURE	back to summary
public static final String FEATURE If `javax.xml.transform.TransformerFactory#getFeature` returns `true` when passed this value as an argument, the `Transformer` supports `Result` output of this type.

nextSibling	back to summary
private Node nextSibling The child node before which the result nodes will be inserted. Since 1.5

nextSibling

back to summary

private Node nextSibling

The child node before which the result nodes will be inserted.

Since: 1.5

node	back to summary
private Node node The node to which the transformation will be appended.

systemId	back to summary
private String systemId The System ID that may be used in association with the node.

Constructor Detail

DOMResult back to summary

DOMResult	back to summary
public DOMResult() Zero-argument default constructor. `node`, `siblingNode` and `systemId` will be set to `null`.

public DOMResult()

Zero-argument default constructor.

node, siblingNode and systemId will be set to null.

DOMResult back to summary

DOMResult	back to summary
public DOMResult(Node node) Use a DOM node to create a new output target. In practice, the node should be a `org.w3c.dom.Document` node, a `org.w3c.dom.DocumentFragment` node, or a `org.w3c.dom.Element` node. In other words, a node that accepts children. `siblingNode` and `systemId` will be set to `null`. Parameters node:Node The DOM node that will contain the result tree.

public DOMResult(Node node)

Use a DOM node to create a new output target.

In practice, the node should be a org.w3c.dom.Document node, a org.w3c.dom.DocumentFragment node, or a org.w3c.dom.Element node. In other words, a node that accepts children.

siblingNode and systemId will be set to null.

Parameters

node:Node: The DOM node that will contain the result tree.

DOMResult back to summary

DOMResult	back to summary
public DOMResult(Node node, String systemId) Use a DOM node to create a new output target with the specified System ID. In practice, the node should be a `org.w3c.dom.Document` node, a `org.w3c.dom.DocumentFragment` node, or a `org.w3c.dom.Element` node. In other words, a node that accepts children. `siblingNode` will be set to `null`. Parameters node:Node The DOM node that will contain the result tree. systemId:String The system identifier which may be used in association with this node.

public DOMResult(Node node, String systemId)

Use a DOM node to create a new output target with the specified System ID.

In practice, the node should be a org.w3c.dom.Document node, a org.w3c.dom.DocumentFragment node, or a org.w3c.dom.Element node. In other words, a node that accepts children.

siblingNode will be set to null.

Parameters

node:Node: The DOM node that will contain the result tree.
systemId:String: The system identifier which may be used in association with this node.

DOMResult back to summary

DOMResult	back to summary
public DOMResult(Node node, Node nextSibling) Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before. In practice, `node` and `nextSibling` should be a `org.w3c.dom.Document` node, a `org.w3c.dom.DocumentFragment` node, or a `org.w3c.dom.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`. Parameters node:Node The DOM node that will contain the result tree. nextSibling:Node The child node where the result nodes should be inserted before. Exceptions IllegalArgumentException: If `nextSibling` is not a sibling of `node` or `node` is `null` and `nextSibling` is not `null`. Since 1.5

public DOMResult(Node node, Node nextSibling)

Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before.

In practice, node and nextSibling should be a org.w3c.dom.Document node, a org.w3c.dom.DocumentFragment node, or a org.w3c.dom.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.

Parameters

node:Node: The DOM node that will contain the result tree.
nextSibling:Node: The child node where the result nodes should be inserted before.

Exceptions

IllegalArgumentException:: If nextSibling is not a sibling of node or node is null and nextSibling is not null.

Since

1.5

DOMResult back to summary

DOMResult	back to summary
public DOMResult(Node node, Node nextSibling, String systemId) 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. In practice, `node` and `nextSibling` should be a `org.w3c.dom.Document` node, a `org.w3c.dom.DocumentFragment` node, or a `org.w3c.dom.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. Parameters node:Node The DOM node that will contain the result tree. nextSibling:Node The child node where the result nodes should be inserted before. systemId:String The system identifier which may be used in association with this node. Exceptions IllegalArgumentException: If `nextSibling` is not a sibling of `node` or `node` is `null` and `nextSibling` is not `null`. Since 1.5

public DOMResult(Node node, Node nextSibling, String systemId)

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.

In practice, node and nextSibling should be a org.w3c.dom.Document node, a org.w3c.dom.DocumentFragment node, or a org.w3c.dom.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.

Parameters

node:Node: The DOM node that will contain the result tree.
nextSibling:Node: The child node where the result nodes should be inserted before.
systemId:String: The system identifier which may be used in association with this node.

Exceptions

IllegalArgumentException:: If nextSibling is not a sibling of node or node is null and nextSibling is not null.

Since

1.5

Method Detail

getNextSibling back to summary

getNextSibling	back to summary
public Node getNextSibling() Get the child node before which the result nodes will be inserted. 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. Returns:Node The child node before which the result nodes will be inserted. Since 1.5

public Node getNextSibling()

Get the child node before which the result nodes will be inserted.

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.

Returns:Node: The child node before which the result nodes will be inserted.
Since: 1.5

getNode back to summary

getNode	back to summary
public Node getNode() Get the node that will contain the result DOM tree. 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`. Returns:Node The node to which the transformation will be appended.

public Node getNode()

Get the node that will contain the result DOM tree.

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.

Returns:Node: The node to which the transformation will be appended.

getSystemId back to summary

getSystemId	back to summary
public String getSystemId() Implements javax.xml.transform.Result.getSystemId. Get the System Identifier. 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. Returns:String The system identifier.

public String getSystemId()

Implements javax.xml.transform.Result.getSystemId.

Get the System Identifier.

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.

Returns:String: The system identifier.

setNextSibling back to summary

setNextSibling	back to summary
public void setNextSibling(Node nextSibling) Set the child node before which the result nodes will be inserted. 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`. Parameters nextSibling:Node The child node before which the result nodes will be inserted. Exceptions IllegalArgumentException: If `nextSibling` is not a descendant of `node`. IllegalStateException: If `node` is `null` and `nextSibling` is not `null`. Since 1.5

public void setNextSibling(Node nextSibling)

Set the child node before which the result nodes will be inserted.

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.

Parameters

nextSibling:Node: The child node before which the result nodes will be inserted.

Exceptions

IllegalArgumentException:: If nextSibling is not a descendant of node.
IllegalStateException:: If node is null and nextSibling is not null.

Since

1.5

setNode back to summary

setNode	back to summary
public void setNode(Node node) Set the node that will contain the result DOM tree. In practice, the node should be a `org.w3c.dom.Document` node, a `org.w3c.dom.DocumentFragment` node, or a `org.w3c.dom.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`. Parameters node:Node The node to which the transformation will be appended. Exceptions IllegalStateException: If `nextSibling` is not `null` and `nextSibling` is not a child of `node` or `node` is `null` and `nextSibling` is not `null`.

public void setNode(Node node)

Set the node that will contain the result DOM tree.

In practice, the node should be a org.w3c.dom.Document node, a org.w3c.dom.DocumentFragment node, or a org.w3c.dom.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.

Parameters

node:Node: The node to which the transformation will be appended.

Exceptions

IllegalStateException:: If nextSibling is not null and nextSibling is not a child of node or node is null and nextSibling is not null.

setSystemId	back to summary
public void setSystemId(String systemId) Implements javax.xml.transform.Result.setSystemId. Set the systemId that may be used in association with the node. Parameters systemId:String The system identifier as a URI string.

setSystemId

back to summary

public void setSystemId(String systemId)

Implements javax.xml.transform.Result.setSystemId.

Set the systemId that may be used in association with the node.

Parameters

systemId:String: The system identifier as a URI string.

public Class DOMResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail