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