KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > xni > QName


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.xni;
59
60 /**
61  * A structure that holds the components of an XML Namespaces qualified
62  * name.
63  * <p>
64  * To be used correctly, the strings must be identical references for
65  * equal strings. Within the parser, these values are considered symbols
66  * and should always be retrieved from the <code>SymbolTable</code>.
67  *
68  * @see <a HREF="../../../../../xerces2/com/sun/org/apache/xerces/internal/util/SymbolTable.html">com.sun.org.apache.xerces.internal.util.SymbolTable</a>
69  *
70  * @author Andy Clark, IBM
71  *
72  * @version $Id: QName.java,v 1.5 2002/01/29 01:15:19 lehors Exp $
73  */
74 public class QName
75     implements Cloneable JavaDoc {
76
77     //
78 // Data
79 //
80
81     /**
82      * The qname prefix. For example, the prefix for the qname "a:foo"
83      * is "a".
84      */
85     public String JavaDoc prefix;
86
87     /**
88      * The qname localpart. For example, the localpart for the qname "a:foo"
89      * is "foo".
90      */
91     public String JavaDoc localpart;
92
93     /**
94      * The qname rawname. For example, the rawname for the qname "a:foo"
95      * is "a:foo".
96      */
97     public String JavaDoc rawname;
98
99     /**
100      * The URI to which the qname prefix is bound. This binding must be
101      * performed by a XML Namespaces aware processor.
102      */
103     public String JavaDoc uri;
104
105     //
106 // Constructors
107 //
108
109     /** Default constructor. */
110     public QName() {
111         clear();
112     } // <init>()
113
114     /** Constructs a QName with the specified values. */
115     public QName(String JavaDoc prefix, String JavaDoc localpart, String JavaDoc rawname, String JavaDoc uri) {
116         setValues(prefix, localpart, rawname, uri);
117     } // <init>(String,String,String,String)
118
119     /** Constructs a copy of the specified QName. */
120     public QName(QName qname) {
121         setValues(qname);
122     } // <init>(QName)
123
124     //
125 // Public methods
126 //
127
128     /**
129      * Convenience method to set the values of the qname components.
130      *
131      * @param QName The qualified name to be copied.
132      */
133     public void setValues(QName qname) {
134         prefix = qname.prefix;
135         localpart = qname.localpart;
136         rawname = qname.rawname;
137         uri = qname.uri;
138     } // setValues(QName)
139
140     /**
141      * Convenience method to set the values of the qname components.
142      *
143      * @param prefix The qname prefix. (e.g. "a")
144      * @param localpart The qname localpart. (e.g. "foo")
145      * @param rawname The qname rawname. (e.g. "a:foo")
146      * @param uri The URI binding. (e.g. "http://foo.com/mybinding")
147      */
148     public void setValues(String JavaDoc prefix, String JavaDoc localpart, String JavaDoc rawname,
149                           String JavaDoc uri) {
150         this.prefix = prefix;
151         this.localpart = localpart;
152         this.rawname = rawname;
153         this.uri = uri;
154     } // setValues(String,String,String,String)
155
156     /** Clears the values of the qname components. */
157     public void clear() {
158         prefix = null;
159         localpart = null;
160         rawname = null;
161         uri = null;
162     } // clear()
163
164     //
165 // Cloneable methods
166 //
167
168     /** Returns a clone of this object. */
169     public Object JavaDoc clone() {
170         return new QName(this);
171     } // clone():Object
172
173     //
174 // Object methods
175 //
176
177     /** Returns the hashcode for this object. */
178     public int hashCode() {
179         if (uri != null) {
180             return uri.hashCode() + localpart.hashCode();
181         }
182         return rawname.hashCode();
183     } // hashCode():int
184
185     /** Returns true if the two objects are equal. */
186     public boolean equals(Object JavaDoc object) {
187         if (object instanceof QName) {
188             QName qname = (QName)object;
189             if (qname.uri != null) {
190                 return uri == qname.uri && localpart == qname.localpart;
191             }
192             else if (uri == null) {
193                 return rawname == qname.rawname;
194             }
195             // fall through and return not equal
196 }
197         return false;
198     } // equals(Object):boolean
199
200     /** Returns a string representation of this object. */
201     public String JavaDoc toString() {
202
203         StringBuffer JavaDoc str = new StringBuffer JavaDoc();
204         boolean comma = false;
205         if (prefix != null) {
206             str.append("prefix=\""+prefix+'"');
207             comma = true;
208         }
209         if (localpart != null) {
210             if (comma) {
211                 str.append(',');
212             }
213             str.append("localpart=\""+localpart+'"');
214             comma = true;
215         }
216         if (rawname != null) {
217             if (comma) {
218                 str.append(',');
219             }
220             str.append("rawname=\""+rawname+'"');
221             comma = true;
222         }
223         if (uri != null) {
224             if (comma) {
225                 str.append(',');
226             }
227             str.append("uri=\""+uri+'"');
228         }
229         return str.toString();
230
231     } // toString():String
232
233 } // class QName
234
Popular Tags