All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.w3c.dom.DocumentFragment Maven / Gradle / Ivy

The newest version!
/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * This file is available under and governed by the GNU General Public
 * License version 2 only, as published by the Free Software Foundation.
 * However, the following notice accompanied the original version of this
 * file and, per its terms, should not be removed:
 *
 * Copyright (c) 2004 World Wide Web Consortium,
 *
 * (Massachusetts Institute of Technology, European Research Consortium for
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
 * work is distributed under the W3C(r) Software License [1] in the hope that
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
 */

package org.w3c.dom;

/**
 * DocumentFragment is a "lightweight" or "minimal"
 * Document object. It is very common to want to be able to
 * extract a portion of a document's tree or to create a new fragment of a
 * document. Imagine implementing a user command like cut or rearranging a
 * document by moving fragments around. It is desirable to have an object
 * which can hold such fragments and it is quite natural to use a Node for
 * this purpose. While it is true that a Document object could
 * fulfill this role, a Document object can potentially be a
 * heavyweight object, depending on the underlying implementation. What is
 * really needed for this is a very lightweight object.
 * DocumentFragment is such an object.
 * 

Furthermore, various operations -- such as inserting nodes as children * of another Node -- may take DocumentFragment * objects as arguments; this results in all the child nodes of the * DocumentFragment being moved to the child list of this node. *

The children of a DocumentFragment node are zero or more * nodes representing the tops of any sub-trees defining the structure of * the document. DocumentFragment nodes do not need to be * well-formed XML documents (although they do need to follow the rules * imposed upon well-formed XML parsed entities, which can have multiple top * nodes). For example, a DocumentFragment might have only one * child and that child node could be a Text node. Such a * structure model represents neither an HTML document nor a well-formed XML * document. *

When a DocumentFragment is inserted into a * Document (or indeed any other Node that may * take children) the children of the DocumentFragment and not * the DocumentFragment itself are inserted into the * Node. This makes the DocumentFragment very * useful when the user wishes to create nodes that are siblings; the * DocumentFragment acts as the parent of these nodes so that * the user can use the standard methods from the Node * interface, such as Node.insertBefore and * Node.appendChild. *

See also the Document Object Model (DOM) Level 3 Core Specification. */ public interface DocumentFragment extends Node { }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy