jaxp/src/share/classes/org/w3c/dom/DocumentFragment.java
author duke
Sat, 01 Dec 2007 00:00:00 +0000
changeset 6 7f561c08de6b
permissions -rw-r--r--
Initial load
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6
7f561c08de6b Initial load
duke
parents:
diff changeset
     1
/*
7f561c08de6b Initial load
duke
parents:
diff changeset
     2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7f561c08de6b Initial load
duke
parents:
diff changeset
     3
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
     4
 * This code is free software; you can redistribute it and/or modify it
7f561c08de6b Initial load
duke
parents:
diff changeset
     5
 * under the terms of the GNU General Public License version 2 only, as
7f561c08de6b Initial load
duke
parents:
diff changeset
     6
 * published by the Free Software Foundation.  Sun designates this
7f561c08de6b Initial load
duke
parents:
diff changeset
     7
 * particular file as subject to the "Classpath" exception as provided
7f561c08de6b Initial load
duke
parents:
diff changeset
     8
 * by Sun in the LICENSE file that accompanied this code.
7f561c08de6b Initial load
duke
parents:
diff changeset
     9
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    10
 * This code is distributed in the hope that it will be useful, but WITHOUT
7f561c08de6b Initial load
duke
parents:
diff changeset
    11
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
7f561c08de6b Initial load
duke
parents:
diff changeset
    12
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
7f561c08de6b Initial load
duke
parents:
diff changeset
    13
 * version 2 for more details (a copy is included in the LICENSE file that
7f561c08de6b Initial load
duke
parents:
diff changeset
    14
 * accompanied this code).
7f561c08de6b Initial load
duke
parents:
diff changeset
    15
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    16
 * You should have received a copy of the GNU General Public License version
7f561c08de6b Initial load
duke
parents:
diff changeset
    17
 * 2 along with this work; if not, write to the Free Software Foundation,
7f561c08de6b Initial load
duke
parents:
diff changeset
    18
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
7f561c08de6b Initial load
duke
parents:
diff changeset
    19
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    20
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
7f561c08de6b Initial load
duke
parents:
diff changeset
    21
 * CA 95054 USA or visit www.sun.com if you need additional information or
7f561c08de6b Initial load
duke
parents:
diff changeset
    22
 * have any questions.
7f561c08de6b Initial load
duke
parents:
diff changeset
    23
 */
7f561c08de6b Initial load
duke
parents:
diff changeset
    24
7f561c08de6b Initial load
duke
parents:
diff changeset
    25
/*
7f561c08de6b Initial load
duke
parents:
diff changeset
    26
 * This file is available under and governed by the GNU General Public
7f561c08de6b Initial load
duke
parents:
diff changeset
    27
 * License version 2 only, as published by the Free Software Foundation.
7f561c08de6b Initial load
duke
parents:
diff changeset
    28
 * However, the following notice accompanied the original version of this
7f561c08de6b Initial load
duke
parents:
diff changeset
    29
 * file and, per its terms, should not be removed:
7f561c08de6b Initial load
duke
parents:
diff changeset
    30
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    31
 * Copyright (c) 2004 World Wide Web Consortium,
7f561c08de6b Initial load
duke
parents:
diff changeset
    32
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    33
 * (Massachusetts Institute of Technology, European Research Consortium for
7f561c08de6b Initial load
duke
parents:
diff changeset
    34
 * Informatics and Mathematics, Keio University). All Rights Reserved. This
7f561c08de6b Initial load
duke
parents:
diff changeset
    35
 * work is distributed under the W3C(r) Software License [1] in the hope that
7f561c08de6b Initial load
duke
parents:
diff changeset
    36
 * it will be useful, but WITHOUT ANY WARRANTY; without even the implied
7f561c08de6b Initial load
duke
parents:
diff changeset
    37
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7f561c08de6b Initial load
duke
parents:
diff changeset
    38
 *
7f561c08de6b Initial load
duke
parents:
diff changeset
    39
 * [1] http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231
7f561c08de6b Initial load
duke
parents:
diff changeset
    40
 */
7f561c08de6b Initial load
duke
parents:
diff changeset
    41
7f561c08de6b Initial load
duke
parents:
diff changeset
    42
package org.w3c.dom;
7f561c08de6b Initial load
duke
parents:
diff changeset
    43
7f561c08de6b Initial load
duke
parents:
diff changeset
    44
/**
7f561c08de6b Initial load
duke
parents:
diff changeset
    45
 * <code>DocumentFragment</code> is a "lightweight" or "minimal"
7f561c08de6b Initial load
duke
parents:
diff changeset
    46
 * <code>Document</code> object. It is very common to want to be able to
7f561c08de6b Initial load
duke
parents:
diff changeset
    47
 * extract a portion of a document's tree or to create a new fragment of a
7f561c08de6b Initial load
duke
parents:
diff changeset
    48
 * document. Imagine implementing a user command like cut or rearranging a
7f561c08de6b Initial load
duke
parents:
diff changeset
    49
 * document by moving fragments around. It is desirable to have an object
7f561c08de6b Initial load
duke
parents:
diff changeset
    50
 * which can hold such fragments and it is quite natural to use a Node for
7f561c08de6b Initial load
duke
parents:
diff changeset
    51
 * this purpose. While it is true that a <code>Document</code> object could
7f561c08de6b Initial load
duke
parents:
diff changeset
    52
 * fulfill this role, a <code>Document</code> object can potentially be a
7f561c08de6b Initial load
duke
parents:
diff changeset
    53
 * heavyweight object, depending on the underlying implementation. What is
7f561c08de6b Initial load
duke
parents:
diff changeset
    54
 * really needed for this is a very lightweight object.
7f561c08de6b Initial load
duke
parents:
diff changeset
    55
 * <code>DocumentFragment</code> is such an object.
7f561c08de6b Initial load
duke
parents:
diff changeset
    56
 * <p>Furthermore, various operations -- such as inserting nodes as children
7f561c08de6b Initial load
duke
parents:
diff changeset
    57
 * of another <code>Node</code> -- may take <code>DocumentFragment</code>
7f561c08de6b Initial load
duke
parents:
diff changeset
    58
 * objects as arguments; this results in all the child nodes of the
7f561c08de6b Initial load
duke
parents:
diff changeset
    59
 * <code>DocumentFragment</code> being moved to the child list of this node.
7f561c08de6b Initial load
duke
parents:
diff changeset
    60
 * <p>The children of a <code>DocumentFragment</code> node are zero or more
7f561c08de6b Initial load
duke
parents:
diff changeset
    61
 * nodes representing the tops of any sub-trees defining the structure of
7f561c08de6b Initial load
duke
parents:
diff changeset
    62
 * the document. <code>DocumentFragment</code> nodes do not need to be
7f561c08de6b Initial load
duke
parents:
diff changeset
    63
 * well-formed XML documents (although they do need to follow the rules
7f561c08de6b Initial load
duke
parents:
diff changeset
    64
 * imposed upon well-formed XML parsed entities, which can have multiple top
7f561c08de6b Initial load
duke
parents:
diff changeset
    65
 * nodes). For example, a <code>DocumentFragment</code> might have only one
7f561c08de6b Initial load
duke
parents:
diff changeset
    66
 * child and that child node could be a <code>Text</code> node. Such a
7f561c08de6b Initial load
duke
parents:
diff changeset
    67
 * structure model represents neither an HTML document nor a well-formed XML
7f561c08de6b Initial load
duke
parents:
diff changeset
    68
 * document.
7f561c08de6b Initial load
duke
parents:
diff changeset
    69
 * <p>When a <code>DocumentFragment</code> is inserted into a
7f561c08de6b Initial load
duke
parents:
diff changeset
    70
 * <code>Document</code> (or indeed any other <code>Node</code> that may
7f561c08de6b Initial load
duke
parents:
diff changeset
    71
 * take children) the children of the <code>DocumentFragment</code> and not
7f561c08de6b Initial load
duke
parents:
diff changeset
    72
 * the <code>DocumentFragment</code> itself are inserted into the
7f561c08de6b Initial load
duke
parents:
diff changeset
    73
 * <code>Node</code>. This makes the <code>DocumentFragment</code> very
7f561c08de6b Initial load
duke
parents:
diff changeset
    74
 * useful when the user wishes to create nodes that are siblings; the
7f561c08de6b Initial load
duke
parents:
diff changeset
    75
 * <code>DocumentFragment</code> acts as the parent of these nodes so that
7f561c08de6b Initial load
duke
parents:
diff changeset
    76
 * the user can use the standard methods from the <code>Node</code>
7f561c08de6b Initial load
duke
parents:
diff changeset
    77
 * interface, such as <code>Node.insertBefore</code> and
7f561c08de6b Initial load
duke
parents:
diff changeset
    78
 * <code>Node.appendChild</code>.
7f561c08de6b Initial load
duke
parents:
diff changeset
    79
 * <p>See also the <a href='http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407'>Document Object Model (DOM) Level 3 Core Specification</a>.
7f561c08de6b Initial load
duke
parents:
diff changeset
    80
 */
7f561c08de6b Initial load
duke
parents:
diff changeset
    81
public interface DocumentFragment extends Node {
7f561c08de6b Initial load
duke
parents:
diff changeset
    82
}