javax.xml.transform.dom
Class DOMResult
java.lang.Object
javax.xml.transform.dom.DOMResult
- Result
public class DOMResult
extends java.lang.Object
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()
.
$Revision: 226183 $, $Date: 2005-04-08 12:39:14 +0200 (Fri, 08 Apr 2005) $
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.
|
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.
|
FEATURE
public static final String FEATURE
DOMResult
public DOMResult()
Zero-argument default constructor.
node
,
siblingNode
and
systemId
will be set to
null
.
DOMResult
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
.
node
- The DOM node that will contain the result tree.
DOMResult
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
.
node
- The DOM node that will contain the result tree.systemId
- The system identifier which may be used in association with this node.
DOMResult
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 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.
DOMResult
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 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.
getNextSibling
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.
- The child node before which the result nodes will be inserted.
getNode
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
.
- The node to which the transformation will be appended.
getSystemId
public String 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.
- getSystemId in interface Result
setNextSibling
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
.
nextSibling
- The child node before which the result nodes will be inserted.
setNode
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
.
node
- The node to which the transformation will be appended.
setSystemId
public void setSystemId(String systemId)
Set the systemId that may be used in association with the node.
- setSystemId in interface Result
systemId
- The system identifier as a URI string.