- java.lang.Object
-
- javax.xml.transform.dom.DOMResult
-
- All Implemented Interfaces:
Result
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().- Since:
- 1.4
-
-
Field Summary
Fields Modifier and Type Field Description static StringFEATUREIfTransformerFactory.getFeature(java.lang.String)returnstruewhen passed this value as an argument, theTransformersupportsResultoutput of this type.-
Fields declared in interface javax.xml.transform.Result
PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
-
-
Constructor Summary
Constructors Constructor Description 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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description NodegetNextSibling()Get the child node before which the result nodes will be inserted.NodegetNode()Get the node that will contain the result DOM tree.StringgetSystemId()Get the System Identifier.voidsetNextSibling(Node nextSibling)Set the child node before which the result nodes will be inserted.voidsetNode(Node node)Set the node that will contain the result DOM tree.voidsetSystemId(String systemId)Set the systemId that may be used in association with the node.
-
-
-
Field Detail
-
FEATURE
public static final String FEATURE
IfTransformerFactory.getFeature(java.lang.String)returnstruewhen passed this value as an argument, theTransformersupportsResultoutput of this type.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
DOMResult
public DOMResult()
Zero-argument default constructor.node,siblingNodeandsystemIdwill 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
Documentnode, aDocumentFragmentnode, or aElementnode. In other words, a node that accepts children.siblingNodeandsystemIdwill 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
Documentnode, aDocumentFragmentnode, or aElementnode. In other words, a node that accepts children.siblingNodewill 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,
nodeandnextSiblingshould be aDocumentnode, aDocumentFragmentnode, or aElementnode. In other words, a node that accepts children.Use
nextSiblingto specify the child node where the result nodes should be inserted before. IfnextSiblingis not a sibling ofnode, then anIllegalArgumentExceptionis thrown. IfnodeisnullandnextSiblingis notnull, then anIllegalArgumentExceptionis thrown. IfnextSiblingisnull, then the behavior is the same as callingDOMResult(Node node), i.e. append the result nodes as the last child of the specifiednode.systemIdwill 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- IfnextSiblingis not a sibling ofnodeornodeisnullandnextSiblingis 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,
nodeandnextSiblingshould be aDocumentnode, aDocumentFragmentnode, or aElementnode. In other words, a node that accepts children.Use
nextSiblingto specify the child node where the result nodes should be inserted before. IfnextSiblingis not a sibling ofnode, then anIllegalArgumentExceptionis thrown. IfnodeisnullandnextSiblingis notnull, then anIllegalArgumentExceptionis thrown. IfnextSiblingisnull, 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- IfnextSiblingis not a sibling ofnodeornodeisnullandnextSiblingis 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
Documentnode, aDocumentFragmentnode, or aElementnode. In other words, a node that accepts children.An
IllegalStateExceptionis thrown ifnextSiblingis notnullandnodeis not a parent ofnextSibling. AnIllegalStateExceptionis thrown ifnodeisnullandnextSiblingis notnull.- Parameters:
node- The node to which the transformation will be appended.- Throws:
IllegalStateException- IfnextSiblingis notnullandnextSiblingis not a child ofnodeornodeisnullandnextSiblingis 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
nextSiblingto specify the child node before which the result nodes should be inserted. IfnextSiblingis not a descendant ofnode, then anIllegalArgumentExceptionis thrown. IfnodeisnullandnextSiblingis notnull, then anIllegalStateExceptionis thrown. IfnextSiblingisnull, 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- IfnextSiblingis not a descendant ofnode.IllegalStateException- IfnodeisnullandnextSiblingis 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), thennullwill 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:
setSystemIdin 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), thennullwill be returned.- Specified by:
getSystemIdin interfaceResult- Returns:
- The system identifier.
-
-