DOMResult

public class DOMResult extends Object
implements Result

Acts as a holder for a transformation result tree in the form of a Document Object Model (DOM) tree.

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().

Constant Summary

String FEATURE

If getFeature(String) returns true when passed this value as an argument, the Transformer supports Result output of this type.

Inherited Constant Summary

Public Constructor Summary

DOMResult()

Zero-argument default constructor.

DOMResult(Node node)

Use a DOM node to create a new output target.

DOMResult(Node node, String systemId)

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

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.

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.

Public Method Summary

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(Node nextSibling)

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

void
setNode(Node node)

Set the node that will contain the result DOM tree.

void
setSystemId(String systemId)

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

Inherited Method Summary

Constants

public static final String FEATURE

If getFeature(String) returns true when passed this value as an argument, the Transformer supports Result output of this type.

Constant Value: "http://javax.xml.transform.dom.DOMResult/feature"

Public Constructors

public DOMResult ()

Zero-argument default constructor.

node, siblingNode and systemId will be set to null.

public DOMResult (Node node)

Use a DOM node to create a new output target.

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.

Parameters
node The DOM node that will contain the result tree.

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 Document node, a DocumentFragment node, or a Element node. In other words, a node that accepts children.

siblingNode will be set to null.

Parameters
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)

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 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), i.e. append the result nodes as the last child of the specified node.

systemId will be set to null.

Parameters
node The DOM node that will contain the result tree.
nextSibling The child node where the result nodes should be inserted before.
Throws
IllegalArgumentException If nextSibling is not a sibling of node.
IllegalArgumentException If node is null and nextSibling is not null.

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 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, String), i.e. append the result nodes as the last child of the specified node and use the specified System ID.

Parameters
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.
Throws
IllegalArgumentException If nextSibling is not a sibling of node.
IllegalArgumentException If node is null and nextSibling is not null.

Public Methods

public Node getNextSibling ()

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

If no node was set via DOMResult(Node, Node), DOMResult(Node, Node, String) or setNextSibling(Node), then null will be returned.

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

public Node getNode ()

Get the node that will contain the result DOM tree.

If no node was set via DOMResult(Node), DOMResult(Node, String), DOMResult(Node, Node), DOMResult(Node, Node, String) or setNode(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
  • The node to which the transformation will be appended.

public String getSystemId ()

Get the System Identifier.

If no System ID was set via DOMResult(Node, String), DOMResult(Node, Node, String) or setSystemId(String), then null will be returned.

Returns
  • The system identifier.

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), i.e. append the result nodes as the last child of the specified node.

Parameters
nextSibling The child node before which the result nodes will be inserted.
Throws
IllegalArgumentException If nextSibling is not a descendant of node.
IllegalStateException If 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 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.

Parameters
node The node to which the transformation will be appended.
Throws
IllegalStateException If nextSibling is not null and nextSibling is not a child of node.
IllegalStateException If node is null and nextSibling is not null.

public void setSystemId (String systemId)

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

Parameters
systemId The system identifier as a URI string.