Home » xml-commons-external-1.4.01-src » javax » xml » transform » dom » [javadoc | source]
javax.xml.transform.dom
public class: DOMResult [javadoc | source]
java.lang.Object
   javax.xml.transform.dom.DOMResult

All Implemented Interfaces:
    Result

Direct Known Subclasses:
    SAAJResult

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
public static final  String FEATURE   

If javax.xml.transform.TransformerFactory#getFeature returns true when passed this value as an argument, the Transformer supports Result output of this type.

 
Constructor:
 public DOMResult() 
 public DOMResult(Node node) 
    Parameters:
    node - The DOM node that will contain the result tree.
 public DOMResult(Node node,
    String systemId) 
    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) 

    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 org.w3c.dom.Document node, a org.w3c.dom.DocumentFragment node, or a org.w3c.dom.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.

    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.
    since: 1.5 -
 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 org.w3c.dom.Document node, a org.w3c.dom.DocumentFragment node, or a org.w3c.dom.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.

    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.
    since: 1.5 -
Method from javax.xml.transform.dom.DOMResult Summary:
getNextSibling,   getNode,   getSystemId,   setNextSibling,   setNode,   setSystemId
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.xml.transform.dom.DOMResult Detail:
 public Node getNextSibling() 
 public Node getNode() 
 public String getSystemId() 
 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.

 public  void setNode(Node node) 

    Set the node that will contain the result DOM tree.

    In practice, the node should be a org.w3c.dom.Document node, a org.w3c.dom.DocumentFragment node, or a org.w3c.dom.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.

 public  void setSystemId(String systemId) 

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