Class DOMResult

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

    Fields declared in interface Result

    PI_DISABLE_OUTPUT_ESCAPING, PI_ENABLE_OUTPUT_ESCAPING
    Modifier and Type
    Field
    Description
    static final String
    PI_DISABLE_OUTPUT_ESCAPING
    The name of the processing instruction that is sent if the result tree disables output escaping.
    static final String
    PI_ENABLE_OUTPUT_ESCAPING
    The name of the processing instruction that is sent if the result tree enables output escaping at some point after having received a PI_DISABLE_OUTPUT_ESCAPING processing instruction.

  • 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

    Modifier and Type
    Method
    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 declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Field Details

  • Constructor Details

    • 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.

      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, a DocumentFragment node, or a Element 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 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.

      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 or node is null and nextSibling is not null.
      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 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.

      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 or node is null and nextSibling is not null.
      Since:
      1.5

  • Method Details