DOMResult (Java Platform SE 7 ) (original) (raw)

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 If TransformerFactory.getFeature(java.lang.String) returns true when passed this value as an argument, the Transformer supports Result output of this type.

   * ### Fields inherited from interface javax.xml.transform.[Result](../../../../javax/xml/transform/Result.html "interface in javax.xml.transform")  
   `[PI_DISABLE_OUTPUT_ESCAPING](../../../../javax/xml/transform/Result.html#PI%5FDISABLE%5FOUTPUT%5FESCAPING), [PI_ENABLE_OUTPUT_ESCAPING](../../../../javax/xml/transform/Result.html#PI%5FENABLE%5FOUTPUT%5FESCAPING)`

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.

   * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../../java/lang/Object.html#clone%28%29), [equals](../../../../java/lang/Object.html#equals%28java.lang.Object%29), [finalize](../../../../java/lang/Object.html#finalize%28%29), [getClass](../../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../../java/lang/Object.html#hashCode%28%29), [notify](../../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../../java/lang/Object.html#toString%28%29), [wait](../../../../java/lang/Object.html#wait%28%29), [wait](../../../../java/lang/Object.html#wait%28long%29), [wait](../../../../java/lang/Object.html#wait%28long,%20int%29)`

Field Detail

 * #### FEATURE  
 public static final [String](../../../../java/lang/String.html "class in java.lang") FEATURE  
 See Also:  
 [Constant Field Values](../../../../constant-values.html#javax.xml.transform.dom.DOMResult.FEATURE)

Constructor Detail

* #### DOMResult  
public DOMResult()  
Zero-argument default constructor.  
`node`,`siblingNode` and`systemId` will be set to `null`.  
* #### DOMResult  
public DOMResult([Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") node)  
Use a DOM node to create a new output target.  
In practice, the node should be a [Document](../../../../org/w3c/dom/Document.html "interface in org.w3c.dom") node, a [DocumentFragment](../../../../org/w3c/dom/DocumentFragment.html "interface in org.w3c.dom") node, or a [Element](../../../../org/w3c/dom/Element.html "interface in org.w3c.dom") 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.  
* #### DOMResult  
public DOMResult([Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") node,  
         [String](../../../../java/lang/String.html "class in java.lang") systemId)  
Use a DOM node to create a new output target with the specified System ID.  
In practice, the node should be a [Document](../../../../org/w3c/dom/Document.html "interface in org.w3c.dom") node, a [DocumentFragment](../../../../org/w3c/dom/DocumentFragment.html "interface in org.w3c.dom") node, or a [Element](../../../../org/w3c/dom/Element.html "interface in org.w3c.dom") 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.  
* #### DOMResult  
public DOMResult([Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") node,  
         [Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") 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](../../../../org/w3c/dom/Document.html "interface in org.w3c.dom") node, a [DocumentFragment](../../../../org/w3c/dom/DocumentFragment.html "interface in org.w3c.dom") node, or a [Element](../../../../org/w3c/dom/Element.html "interface in org.w3c.dom") 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)](../../../../javax/xml/transform/dom/DOMResult.html#DOMResult%28org.w3c.dom.Node%29), 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](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If `nextSibling` is not a sibling of `node` or`node` is `null` and `nextSibling` is not `null`.  
Since:  
1.5  
* #### DOMResult  
public DOMResult([Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") node,  
         [Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") nextSibling,  
         [String](../../../../java/lang/String.html "class in java.lang") 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](../../../../org/w3c/dom/Document.html "interface in org.w3c.dom") node, a [DocumentFragment](../../../../org/w3c/dom/DocumentFragment.html "interface in org.w3c.dom") node, or a[Element](../../../../org/w3c/dom/Element.html "interface in org.w3c.dom") 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)](../../../../javax/xml/transform/dom/DOMResult.html#DOMResult%28org.w3c.dom.Node,%20java.lang.String%29), 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](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If `nextSibling` is not a sibling of `node` or`node` is `null` and `nextSibling` is not `null`.  
Since:  
1.5

Method Detail

* #### setNode  
public void setNode([Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") node)  
Set the node that will contain the result DOM tree.  
In practice, the node should be a [Document](../../../../org/w3c/dom/Document.html "interface in org.w3c.dom") node, a [DocumentFragment](../../../../org/w3c/dom/DocumentFragment.html "interface in org.w3c.dom") node, or a [Element](../../../../org/w3c/dom/Element.html "interface in org.w3c.dom") 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](../../../../java/lang/IllegalStateException.html "class in java.lang")` \- If `nextSibling` is not`null` and`nextSibling` is not a child of `node` or`node` is `null` and`nextSibling` is not `null`.  
* #### getNode  
public [Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") getNode()  
Returns:  
The node to which the transformation will be appended.  
* #### setNextSibling  
public void setNextSibling([Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") 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)](../../../../javax/xml/transform/dom/DOMResult.html#DOMResult%28org.w3c.dom.Node%29), 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](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- If `nextSibling` is not a descendant of `node`.  
`[IllegalStateException](../../../../java/lang/IllegalStateException.html "class in java.lang")` \- If `node` is `null` and `nextSibling` is not `null`.  
Since:  
1.5  
* #### getNextSibling  
public [Node](../../../../org/w3c/dom/Node.html "interface in org.w3c.dom") getNextSibling()  
Returns:  
The child node before which the result nodes will be inserted.  
Since:  
1.5  
* #### setSystemId  
public void setSystemId([String](../../../../java/lang/String.html "class in java.lang") systemId)  
Set the systemId that may be used in association with the node.  
**Specified by:**  
`[setSystemId](../../../../javax/xml/transform/Result.html#setSystemId%28java.lang.String%29)` in interface `[Result](../../../../javax/xml/transform/Result.html "interface in javax.xml.transform")`  
Parameters:  
`systemId` \- The system identifier as a URI string.  
* #### getSystemId  
public [String](../../../../java/lang/String.html "class in java.lang") getSystemId()  
**Specified by:**  
`[getSystemId](../../../../javax/xml/transform/Result.html#getSystemId%28%29)` in interface `[Result](../../../../javax/xml/transform/Result.html "interface in javax.xml.transform")`  
Returns:  
The system identifier.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

DOMResult (Java Platform SE 7 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail