DOMResult.java revision 286
0N/A * Copyright (c) 2000, 2005, Oracle and/or its affiliates. All rights reserved. 0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 0N/A * This code is free software; you can redistribute it and/or modify it 0N/A * under the terms of the GNU General Public License version 2 only, as 0N/A * published by the Free Software Foundation. Oracle designates this 0N/A * particular file as subject to the "Classpath" exception as provided 0N/A * by Oracle in the LICENSE file that accompanied this code. 0N/A * This code is distributed in the hope that it will be useful, but WITHOUT 0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 0N/A * version 2 for more details (a copy is included in the LICENSE file that 0N/A * accompanied this code). 0N/A * You should have received a copy of the GNU General Public License version 0N/A * 2 along with this work; if not, write to the Free Software Foundation, 0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 0N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 0N/A * or visit www.oracle.com if you need additional information or have any 0N/A * <p>Acts as a holder for a transformation result tree in the form of a Document Object Model (DOM) tree.</p> 0N/A * <p>If no output DOM source is set, the transformation will create a Document node as the holder for the result of the transformation, 0N/A * which may be retrieved with {@link #getNode()}.</p> 0N/A * @author <a href="Jeff.Suttor@Sun.com">Jeff Suttor</a> 0N/A /** <p>If {@link javax.xml.transform.TransformerFactory#getFeature} 0N/A * returns <code>true</code> when passed this value as an argument, 0N/A * the <code>Transformer</code> supports <code>Result</code> output of this type.</p> 0N/A * <p>Zero-argument default constructor.</p> 0N/A * <p><code>node</code>, 0N/A * <code>siblingNode</code> and 0N/A * <code>systemId</code> 0N/A * will be set to <code>null</code>.</p> 0N/A * <p>Use a DOM node to create a new output target.</p> 0N/A * <p>In practice, the node should be 0N/A * a {@link org.w3c.dom.Document} node, 0N/A * a {@link org.w3c.dom.DocumentFragment} node, or 0N/A * a {@link org.w3c.dom.Element} node. 0N/A * In other words, a node that accepts children.</p> 0N/A * <p><code>siblingNode</code> and 0N/A * <code>systemId</code> 0N/A * will be set to <code>null</code>.</p> 0N/A * @param node The DOM node that will contain the result tree. 0N/A * <p>Use a DOM node to create a new output target with the specified System ID.<p> 0N/A * <p>In practice, the node should be 0N/A * a {@link org.w3c.dom.Document} node, 0N/A * a {@link org.w3c.dom.DocumentFragment} node, or 0N/A * a {@link org.w3c.dom.Element} node. 0N/A * In other words, a node that accepts children.</p> 0N/A * <p><code>siblingNode</code> will be set to <code>null</code>.</p> 0N/A * @param node The DOM node that will contain the result tree. 0N/A * @param systemId The system identifier which may be used in association with this node. 0N/A * <p>Use a DOM node to create a new output target specifying the child node where the result nodes should be inserted before.</p> * <p>In practice, <code>node</code> and <code>nextSibling</code> should be * a {@link org.w3c.dom.Document} node, * a {@link org.w3c.dom.DocumentFragment} node, or * a {@link org.w3c.dom.Element} node. * In other words, a node that accepts children.</p> * <p>Use <code>nextSibling</code> to specify the child node * where the result nodes should be inserted before. * If <code>nextSibling</code> is not a sibling of <code>node</code>, * then an <code>IllegalArgumentException</code> is thrown. * If <code>node</code> is <code>null</code> and <code>nextSibling</code> is not <code>null</code>, * then an <code>IllegalArgumentException</code> is thrown. * If <code>nextSibling</code> is <code>null</code>, * then the behavior is the same as calling {@link #DOMResult(Node node)}, * i.e. append the result nodes as the last child of the specified <code>node</code>.</p> * <p><code>systemId</code> will be set to <code>null</code>.</p> * @param node The DOM node that will contain the result tree. * @param nextSibling The child node where the result nodes should be inserted before. * @throws IllegalArgumentException If <code>nextSibling</code> is not a sibling of <code>node</code> or * <code>node</code> is <code>null</code> and <code>nextSibling</code> * is not <code>null</code>. // cannot be a sibling of a null node throw new IllegalArgumentException(
"Cannot create a DOMResult when the nextSibling is contained by the \"null\" node.");
// nextSibling contained by node? * <p>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.</p> * <p>In practice, <code>node</code> and <code>nextSibling</code> should be * a {@link org.w3c.dom.Document} node, * a {@link org.w3c.dom.DocumentFragment} node, or a * {@link org.w3c.dom.Element} node. * In other words, a node that accepts children.</p> * <p>Use <code>nextSibling</code> to specify the child node * where the result nodes should be inserted before. * If <code>nextSibling</code> is not a sibling of <code>node</code>, * then an <code>IllegalArgumentException</code> is thrown. * If <code>node</code> is <code>null</code> and <code>nextSibling</code> is not <code>null</code>, * then an <code>IllegalArgumentException</code> is thrown. * If <code>nextSibling</code> is <code>null</code>, * then the behavior is the same as calling {@link #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.</p> * @param node The DOM node that will contain the result tree. * @param nextSibling The child node where the result nodes should be inserted before. * @param systemId The system identifier which may be used in association with this node. * @throws IllegalArgumentException If <code>nextSibling</code> is not a * sibling of <code>node</code> or * <code>node</code> is <code>null</code> and <code>nextSibling</code> * is not <code>null</code>. // cannot be a sibling of a null node throw new IllegalArgumentException(
"Cannot create a DOMResult when the nextSibling is contained by the \"null\" node.");
// nextSibling contained by node? * <p>Set the node that will contain the result DOM tree.<p> * <p>In practice, the node should be * a {@link org.w3c.dom.Document} node, * a {@link org.w3c.dom.DocumentFragment} node, or * a {@link org.w3c.dom.Element} node. * In other words, a node that accepts children.</p> * <p>An <code>IllegalStateException</code> is thrown if * <code>nextSibling</code> is not <code>null</code> and * <code>node</code> is not a parent of <code>nextSibling</code>. * An <code>IllegalStateException</code> is thrown if <code>node</code> is <code>null</code> and * <code>nextSibling</code> is not <code>null</code>.</p> * @param node The node to which the transformation will be appended. * @throws IllegalStateException If <code>nextSibling</code> is not * <code>nextSibling</code> is not a child of <code>node</code> or * <code>node</code> is <code>null</code> and * <code>nextSibling</code> is not <code>null</code>. // cannot be a sibling of a null node throw new IllegalStateException(
"Cannot create a DOMResult when the nextSibling is contained by the \"null\" node.");
// nextSibling contained by node? * <p>Get the node that will contain the result DOM tree.</p> * <p>If no node was set via * {@link #DOMResult(Node node)}, * {@link #DOMResult(Node node, String systeId)}, * {@link #DOMResult(Node node, Node nextSibling)}, * {@link #DOMResult(Node node, Node nextSibling, String systemId)} or * {@link #setNode(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 return <code>null</code>.</p> * @return The node to which the transformation will be appended. * <p>Set the child node before which the result nodes will be inserted.</p> * <p>Use <code>nextSibling</code> to specify the child node * before which the result nodes should be inserted. * If <code>nextSibling</code> is not a descendant of <code>node</code>, * then an <code>IllegalArgumentException</code> is thrown. * If <code>node</code> is <code>null</code> and <code>nextSibling</code> is not <code>null</code>, * then an <code>IllegalStateException</code> is thrown. * If <code>nextSibling</code> is <code>null</code>, * then the behavior is the same as calling {@link #DOMResult(Node node)}, * i.e. append the result nodes as the last child of the specified <code>node</code>.</p> * @param nextSibling The child node before which the result nodes will be inserted. * @throws IllegalArgumentException If <code>nextSibling</code> is not a * descendant of <code>node</code>. * @throws IllegalStateException If <code>node</code> is <code>null</code> * and <code>nextSibling</code> is not <code>null</code>. // cannot be a sibling of a null node throw new IllegalStateException(
"Cannot create a DOMResult when the nextSibling is contained by the \"null\" node.");
// nextSibling contained by node? * <p>Get the child node before which the result nodes will be inserted.</p> * <p>If no node was set via * {@link #DOMResult(Node node, Node nextSibling)}, * {@link #DOMResult(Node node, Node nextSibling, String systemId)} or * {@link #setNextSibling(Node nextSibling)}, * then <code>null</code> will be returned.</p> * @return The child node before which the result nodes will be inserted. * <p>Set the systemId that may be used in association with the node.</p> * @param systemId The system identifier as a URI string. * <p>Get the System Identifier.</p> * <p>If no System ID was set via * {@link #DOMResult(Node node, String systemId)}, * {@link #DOMResult(Node node, Node nextSibling, String systemId)} or * {@link #setSystemId(String systemId)}, * then <code>null</code> will be returned.</p> * @return The system identifier. ////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////// * <p>The node to which the transformation will be appended.</p> * <p>The child node before which the result nodes will be inserted.</p> * <p>The System ID that may be used in association with the node.</p>