001 /* QName.java - An XML qualified name.
002 Copyright (C) 2004,2005,2006 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package javax.xml.namespace;
040
041 import java.io.Serializable;
042
043 import javax.xml.XMLConstants;
044
045 /**
046 * An XML
047 * <a href='http://www.w3.org/TR/REC-xml-names/#ns-qualnames'>qualified name</a>.
048 *
049 * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
050 * @since 1.3
051 */
052 public class QName implements Serializable
053 {
054 private static final long serialVersionUID = 4418622981026545151L;
055
056 private final String namespaceURI;
057 private final String localPart;
058 private final String prefix;
059 private transient String qName;
060 transient int hashCode = -1;
061
062 public QName(String namespaceURI, String localPart)
063 {
064 this(namespaceURI, localPart, null);
065 }
066
067 public QName(String namespaceURI, String localPart, String prefix)
068 {
069 if (namespaceURI == null)
070 namespaceURI = XMLConstants.NULL_NS_URI;
071 if (localPart == null)
072 throw new IllegalArgumentException();
073 if (prefix == null)
074 prefix = XMLConstants.DEFAULT_NS_PREFIX;
075 else
076 {
077 if (XMLConstants.XML_NS_PREFIX.equals(prefix))
078 namespaceURI = XMLConstants.XML_NS_URI;
079 else if (XMLConstants.XMLNS_ATTRIBUTE.equals(prefix))
080 namespaceURI = XMLConstants.XMLNS_ATTRIBUTE_NS_URI;
081 }
082 this.namespaceURI = namespaceURI;
083 this.localPart = localPart;
084 this.prefix = prefix;
085 }
086
087 public QName(String localPart)
088 {
089 this(null, localPart, null);
090 }
091
092 public String getNamespaceURI()
093 {
094 return namespaceURI;
095 }
096
097 public String getLocalPart()
098 {
099 return localPart;
100 }
101
102 public String getPrefix()
103 {
104 return prefix;
105 }
106
107 public final boolean equals(Object obj)
108 {
109 if (obj instanceof QName)
110 {
111 QName qname = (QName) obj;
112 return qname.getLocalPart().equals(localPart) &&
113 qname.getNamespaceURI().equals(namespaceURI);
114 }
115 return false;
116 }
117
118 public final int hashCode()
119 {
120 if (hashCode == -1)
121 hashCode = localPart.hashCode() ^ namespaceURI.hashCode();
122 return hashCode;
123 }
124
125 public synchronized String toString()
126 {
127 if (qName == null)
128 {
129 StringBuffer buf = new StringBuffer();
130 if (namespaceURI.length() > 0)
131 {
132 buf.append('{');
133 buf.append(namespaceURI);
134 buf.append('}');
135 }
136 if (prefix.length() > 0)
137 {
138 buf.append(prefix);
139 buf.append(':');
140 }
141 buf.append(localPart);
142 qName = buf.toString();
143 }
144 return qName;
145 }
146
147 public static QName valueOf(String qNameAsString)
148 {
149 String namespaceUri = "", prefix = null;
150 int start = qNameAsString.indexOf('{');
151 int end = qNameAsString.indexOf('}');
152 if (start != -1)
153 {
154 if (end < start)
155 throw new IllegalArgumentException(qNameAsString);
156 namespaceUri = qNameAsString.substring(start + 1, end);
157 qNameAsString = qNameAsString.substring(end + 1);
158 }
159 start = qNameAsString.indexOf(':');
160 if (start != -1)
161 {
162 prefix = qNameAsString.substring(0, start);
163 qNameAsString = qNameAsString.substring(start + 1);
164 }
165 return new QName(namespaceUri, qNameAsString, prefix);
166 }
167
168 }