libjava/classpath/javax/xml/namespace/QName.java

   1 /* QName.java - An XML qualified name.
   2    Copyright (C) 2004,2005,2006 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.xml.namespace;
  40
  41 import gnu.java.lang.CPStringBuilder;
  42
  43 import java.io.Serializable;
  44
  45 import javax.xml.XMLConstants;
  46
  47 /**
  48  * An XML
  49  * <a href='http://www.w3.org/TR/REC-xml-names/#ns-qualnames'>qualified name</a>.
  50  *
  51  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  52  * @since 1.3
  53  */
  54 public class QName implements Serializable
  55 {
  56   private static final long serialVersionUID = 4418622981026545151L;
  57
  58   private final String namespaceURI;
  59   private final String localPart;
  60   private final String prefix;
  61   private transient String qName;
  62   transient int hashCode = -1;
  63
  64   public QName(String namespaceURI, String localPart)
  65   {
  66     this(namespaceURI, localPart, null);
  67   }
  68
  69   public QName(String namespaceURI, String localPart, String prefix)
  70   {
  71     if (namespaceURI == null)
  72       namespaceURI = XMLConstants.NULL_NS_URI;
  73     if (localPart == null)
  74       throw new IllegalArgumentException();
  75     if (prefix == null)
  76       prefix = XMLConstants.DEFAULT_NS_PREFIX;
  77     else
  78       {
  79         if (XMLConstants.XML_NS_PREFIX.equals(prefix))
  80           namespaceURI = XMLConstants.XML_NS_URI;
  81         else if (XMLConstants.XMLNS_ATTRIBUTE.equals(prefix))
  82           namespaceURI = XMLConstants.XMLNS_ATTRIBUTE_NS_URI;
  83       }
  84     this.namespaceURI = namespaceURI;
  85     this.localPart = localPart;
  86     this.prefix = prefix;
  87   }
  88
  89   public QName(String localPart)
  90   {
  91     this(null, localPart, null);
  92   }
  93
  94   public String getNamespaceURI()
  95   {
  96     return namespaceURI;
  97   }
  98
  99   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 }