KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > dom > ChildNode


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2000-2002 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package com.sun.org.apache.xerces.internal.dom;
59
60 import org.w3c.dom.Node JavaDoc;
61
62 /**
63  * ChildNode inherits from NodeImpl and adds the capability of being a child by
64  * having references to its previous and next siblings.
65  *
66  * @version $Id: ChildNode.java,v 1.8 2004/02/10 17:09:45 elena Exp $
67  */
68 public abstract class ChildNode
69     extends NodeImpl {
70
71     //
72 // Constants
73 //
74
75     /** Serialization version. */
76     static final long serialVersionUID = -6112455738802414002L;
77
78     transient StringBuffer JavaDoc fBufferStr = null;
79     
80     //
81 // Data
82 //
83
84     /** Previous sibling. */
85     protected ChildNode previousSibling;
86
87     /** Next sibling. */
88     protected ChildNode nextSibling;
89
90     //
91 // Constructors
92 //
93
94     /**
95      * No public constructor; only subclasses of Node should be
96      * instantiated, and those normally via a Document's factory methods
97      * <p>
98      * Every Node knows what Document it belongs to.
99      */
100     protected ChildNode(CoreDocumentImpl ownerDocument) {
101         super(ownerDocument);
102     } // <init>(CoreDocumentImpl)
103
104     /** Constructor for serialization. */
105     public ChildNode() {}
106
107     //
108 // Node methods
109 //
110
111     /**
112      * Returns a duplicate of a given node. You can consider this a
113      * generic "copy constructor" for nodes. The newly returned object should
114      * be completely independent of the source object's subtree, so changes
115      * in one after the clone has been made will not affect the other.
116      * <P>
117      * Note: since we never have any children deep is meaningless here,
118      * ParentNode overrides this behavior.
119      * @see ParentNode
120      *
121      * <p>
122      * Example: Cloning a Text node will copy both the node and the text it
123      * contains.
124      * <p>
125      * Example: Cloning something that has children -- Element or Attr, for
126      * example -- will _not_ clone those children unless a "deep clone"
127      * has been requested. A shallow clone of an Attr node will yield an
128      * empty Attr of the same name.
129      * <p>
130      * NOTE: Clones will always be read/write, even if the node being cloned
131      * is read-only, to permit applications using only the DOM API to obtain
132      * editable copies of locked portions of the tree.
133      */
134     public Node JavaDoc cloneNode(boolean deep) {
135
136         ChildNode newnode = (ChildNode) super.cloneNode(deep);
137         
138         // Need to break the association w/ original kids
139 newnode.previousSibling = null;
140         newnode.nextSibling = null;
141         newnode.isFirstChild(false);
142
143         return newnode;
144
145     } // cloneNode(boolean):Node
146
147     /**
148      * Returns the parent node of this node
149      */
150     public Node JavaDoc getParentNode() {
151         // if we have an owner, ownerNode is our parent, otherwise it's
152 // our ownerDocument and we don't have a parent
153 return isOwned() ? ownerNode : null;
154     }
155
156     /*
157      * same as above but returns internal type
158      */
159     final NodeImpl parentNode() {
160         // if we have an owner, ownerNode is our parent, otherwise it's
161 // our ownerDocument and we don't have a parent
162 return isOwned() ? ownerNode : null;
163     }
164
165     /** The next child of this node's parent, or null if none */
166     public Node JavaDoc getNextSibling() {
167         return nextSibling;
168     }
169
170     /** The previous child of this node's parent, or null if none */
171     public Node JavaDoc getPreviousSibling() {
172         // if we are the firstChild, previousSibling actually refers to our
173 // parent's lastChild, but we hide that
174 return isFirstChild() ? null : previousSibling;
175     }
176
177     /*
178      * same as above but returns internal type
179      */
180     final ChildNode previousSibling() {
181         // if we are the firstChild, previousSibling actually refers to our
182 // parent's lastChild, but we hide that
183 return isFirstChild() ? null : previousSibling;
184     }
185
186 } // class ChildNode
187
Popular Tags