QName.java 4.71 KB
Newer Older
Tom Tromey committed
1
/* QName.java - An XML qualified name.
2
   Copyright (C) 2004,2005,2006 Free Software Foundation, Inc.
Tom Tromey committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

This file is part of GNU Classpath.

GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
 
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING.  If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.

Linking this library statically or dynamically with other modules is
making a combined work based on this library.  Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.

As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module.  An independent module is a module which is not derived from
or based on this library.  If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so.  If you do not wish to do so, delete this
exception statement from your version. */

Tom Tromey committed
38 39 40

package javax.xml.namespace;

41 42
import java.io.Serializable;

Tom Tromey committed
43 44 45 46 47 48 49 50 51
import javax.xml.XMLConstants;

/**
 * An XML
 * <a href='http://www.w3.org/TR/REC-xml-names/#ns-qualnames'>qualified name</a>.
 *
 * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
 * @since 1.3
 */
52
public class QName implements Serializable
Tom Tromey committed
53
{
54
  private static final long serialVersionUID = 4418622981026545151L;
Tom Tromey committed
55 56 57 58

  private final String namespaceURI;
  private final String localPart;
  private final String prefix;
59 60
  private transient String qName;
  transient int hashCode = -1;
Tom Tromey committed
61 62 63 64 65 66 67 68 69

  public QName(String namespaceURI, String localPart)
  {
    this(namespaceURI, localPart, null);
  }

  public QName(String namespaceURI, String localPart, String prefix)
  {
    if (namespaceURI == null)
70
      namespaceURI = XMLConstants.NULL_NS_URI;
Tom Tromey committed
71
    if (localPart == null)
72
      throw new IllegalArgumentException();
Tom Tromey committed
73
    if (prefix == null)
74 75
      prefix = XMLConstants.DEFAULT_NS_PREFIX;
    else
Tom Tromey committed
76
      {
77 78 79 80
        if (XMLConstants.XML_NS_PREFIX.equals(prefix))
          namespaceURI = XMLConstants.XML_NS_URI;
        else if (XMLConstants.XMLNS_ATTRIBUTE.equals(prefix))
          namespaceURI = XMLConstants.XMLNS_ATTRIBUTE_NS_URI;
Tom Tromey committed
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
      }
    this.namespaceURI = namespaceURI;
    this.localPart = localPart;
    this.prefix = prefix;
  }

  public QName(String localPart)
  {
    this(null, localPart, null);
  }

  public String getNamespaceURI()
  {
    return namespaceURI;
  }

  public String getLocalPart()
  {
    return localPart;
  }

  public String getPrefix()
  {
    return prefix;
  }

107
  public final boolean equals(Object obj)
Tom Tromey committed
108 109 110 111 112 113 114 115 116 117 118 119 120
  {
    if (obj instanceof QName)
      {
        QName qname = (QName) obj;
        return qname.getLocalPart().equals(localPart) &&
          qname.getNamespaceURI().equals(namespaceURI);
      }
    return false;
  }

  public final int hashCode()
  {
    if (hashCode == -1)
121
      hashCode = localPart.hashCode() ^ namespaceURI.hashCode();
Tom Tromey committed
122 123 124
    return hashCode;
  }

125
  public synchronized String toString()
Tom Tromey committed
126
  {
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
    if (qName == null)
      {
	StringBuffer buf = new StringBuffer();
	if (namespaceURI.length() > 0)
	  {
	    buf.append('{');
	    buf.append(namespaceURI);
	    buf.append('}');
	  }
	if (prefix.length() > 0)
	  {
	    buf.append(prefix);
	    buf.append(':');
	  }
	buf.append(localPart);
	qName = buf.toString();
      }
Tom Tromey committed
144 145 146 147 148 149 150 151 152 153 154
    return qName;
  }

  public static QName valueOf(String qNameAsString)
  {
    String namespaceUri = "", prefix = null;
    int start = qNameAsString.indexOf('{');
    int end = qNameAsString.indexOf('}');
    if (start != -1)
      {
        if (end < start)
155
          throw new IllegalArgumentException(qNameAsString);
Tom Tromey committed
156 157 158 159 160 161 162 163 164 165 166 167 168
        namespaceUri = qNameAsString.substring(start + 1, end);
        qNameAsString = qNameAsString.substring(end + 1);
      }
    start = qNameAsString.indexOf(':');
    if (start != -1)
      {
        prefix = qNameAsString.substring(0, start);
        qNameAsString = qNameAsString.substring(start + 1);
      }
    return new QName(namespaceUri, qNameAsString, prefix);
  }
  
}