to top

Added in API level 8

public class

DOMResult

extends Object
implements Result

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

Class Overview

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.

[Expand]

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.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this `Object`.
boolean	equals( Object o) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of `Class` that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object.
final void	wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.
final void	wait(long millis) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires.

From interface javax.xml.transform.Result

Constants

public static final String FEATURE

Added in API level 8

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

Added in API level 8

Zero-argument default constructor.

node, siblingNode and systemId will be set to null.

public DOMResult (Node node)

Added in API level 8

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)

Added in API level 8

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)

Added in API level 8

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)

Added in API level 8

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

Added in API level 8

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

Added in API level 8

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

Added in API level 8

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)

Added in API level 8

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)

Added in API level 8

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)

Added in API level 8

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

Parameters

systemId	The system identifier as a URI string.

Results

Interfaces

Classes

DOMResult

Class Overview

Summary

Constants

public static final String FEATURE

Public Constructors

public DOMResult ()

public DOMResult (Node node)

Parameters

public DOMResult (Node node, String systemId)

Parameters

public DOMResult (Node node, Node nextSibling)

Parameters

Throws

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

Parameters

Throws

Public Methods

public Node getNextSibling ()

Returns

public Node getNode ()

Returns

public String getSystemId ()

Returns

public void setNextSibling (Node nextSibling)

Parameters

Throws

public void setNode (Node node)

Parameters

Throws

public void setSystemId (String systemId)

Parameters