Skip to content

Most visited

Recently visited

navigation
Added in API level 8

DOMResult

public class DOMResult
extends Object implements Result

java.lang.Object
   ↳ javax.xml.transform.dom.DOMResult


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

Summary

Constants

String FEATURE

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

Inherited constants

From interface javax.xml.transform.Result

Public constructors

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 methods

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 methods

From class java.lang.Object
From interface javax.xml.transform.Result

Constants

FEATURE

Added in API level 8
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

DOMResult

Added in API level 8
DOMResult ()

Zero-argument default constructor.

node, siblingNode and systemId will be set to null.

DOMResult

Added in API level 8
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 Node: The DOM node that will contain the result tree.

DOMResult

Added in API level 8
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 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

Added in API level 8
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 Node: The DOM node that will contain the result tree.
nextSibling Node: 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.

DOMResult

Added in API level 8
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 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.
Throws
IllegalArgumentException If nextSibling is not a sibling of node.
IllegalArgumentException If node is null and nextSibling is not null.

Public methods

getNextSibling

Added in API level 8
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
Node The child node before which the result nodes will be inserted.

getNode

Added in API level 8
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
Node The node to which the transformation will be appended.

getSystemId

Added in API level 8
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
String The system identifier.

setNextSibling

Added in API level 8
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 Node: 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.

setNode

Added in API level 8
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 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.

setSystemId

Added in API level 8
void setSystemId (String systemId)

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

Parameters
systemId String: The system identifier as a URI string.
This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.