- java.lang.Object
-
- javax.xml.transform.dom.DOMResult
-
- All Implemented Interfaces:
- Result
- Direct Known Subclasses:
- SAAJResult
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()
.
-
-
Field Summary
Fields Modifier and Type Field and Description static String
FEATURE
IfTransformerFactory.getFeature(java.lang.String)
returnstrue
when passed this value as an argument, theTransformer
supportsResult
output of this type.-
Fields inherited from interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
-
Constructor Summary
Constructors Constructor and Description DOMResult()
Zero-argument default constructor.DOMResult(Node node)
Use a DOM node to create a new output target.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.DOMResult(Node node, String systemId)
Use a DOM node to create a new output target with the specified System ID.
-
Method Summary
Methods Modifier and Type Method and Description 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.
-
-
-
Field Detail
-
FEATURE
public static final String FEATURE
If
TransformerFactory.getFeature(java.lang.String)
returnstrue
when passed this value as an argument, theTransformer
supportsResult
output of this type.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DOMResult
public DOMResult()
Zero-argument default constructor.
node
,siblingNode
andsystemId
will be set tonull
.
-
DOMResult
public DOMResult(Node node)
Use a DOM node to create a new output target.
In practice, the node should be a
Document
node, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.siblingNode
andsystemId
will be set tonull
.- Parameters:
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, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.siblingNode
will be set tonull
.- Parameters:
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
andnextSibling
should be aDocument
node, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.Use
nextSibling
to specify the child node where the result nodes should be inserted before. IfnextSibling
is not a sibling ofnode
, then anIllegalArgumentException
is thrown. Ifnode
isnull
andnextSibling
is notnull
, then anIllegalArgumentException
is thrown. IfnextSibling
isnull
, then the behavior is the same as callingDOMResult(Node node)
, i.e. append the result nodes as the last child of the specifiednode
.systemId
will be set tonull
.- 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
- IfnextSibling
is not a sibling ofnode
ornode
isnull
andnextSibling
is notnull
.- Since:
- 1.5
-
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
andnextSibling
should be aDocument
node, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.Use
nextSibling
to specify the child node where the result nodes should be inserted before. IfnextSibling
is not a sibling ofnode
, then anIllegalArgumentException
is thrown. Ifnode
isnull
andnextSibling
is notnull
, then anIllegalArgumentException
is thrown. IfnextSibling
isnull
, then the behavior is the same as callingDOMResult(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
- 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
- IfnextSibling
is not a sibling ofnode
ornode
isnull
andnextSibling
is notnull
.- Since:
- 1.5
-
-
Method Detail
-
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, aDocumentFragment
node, or aElement
node. In other words, a node that accepts children.An
IllegalStateException
is thrown ifnextSibling
is notnull
andnode
is not a parent ofnextSibling
. AnIllegalStateException
is thrown ifnode
isnull
andnextSibling
is notnull
.- Parameters:
node
- The node to which the transformation will be appended.- Throws:
IllegalStateException
- IfnextSibling
is notnull
andnextSibling
is not a child ofnode
ornode
isnull
andnextSibling
is notnull
.
-
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)
orsetNode(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 returnnull
.- Returns:
- The node to which the transformation will be appended.
-
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. IfnextSibling
is not a descendant ofnode
, then anIllegalArgumentException
is thrown. Ifnode
isnull
andnextSibling
is notnull
, then anIllegalStateException
is thrown. IfnextSibling
isnull
, then the behavior is the same as callingDOMResult(Node node)
, i.e. append the result nodes as the last child of the specifiednode
.- Parameters:
nextSibling
- The child node before which the result nodes will be inserted.- Throws:
IllegalArgumentException
- IfnextSibling
is not a descendant ofnode
.IllegalStateException
- Ifnode
isnull
andnextSibling
is notnull
.- Since:
- 1.5
-
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)
orsetNextSibling(Node nextSibling)
, thennull
will be returned.- Returns:
- The child node before which the result nodes will be inserted.
- Since:
- 1.5
-
setSystemId
public void setSystemId(String systemId)
Set the systemId that may be used in association with the node.
- Specified by:
setSystemId
in interfaceResult
- Parameters:
systemId
- The system identifier as a URI string.
-
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)
orsetSystemId(String systemId)
, thennull
will be returned.- Specified by:
getSystemId
in interfaceResult
- Returns:
- The system identifier.
-
-
Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/transform/dom/domresult.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.