Source for javax.xml.namespace.QName

   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 java.io.Serializable;
  42: 
  43: import javax.xml.XMLConstants;
  44: 
  45: /**
  46:  * An XML
  47:  * <a href='http://www.w3.org/TR/REC-xml-names/#ns-qualnames'>qualified name</a>.
  48:  *
  49:  * @author <a href='mailto:dog@gnu.org'>Chris Burdess</a>
  50:  * @since 1.3
  51:  */
  52: public class QName implements Serializable
  53: {
  54:   private static final long serialVersionUID = 4418622981026545151L;
  55: 
  56:   private final String namespaceURI;
  57:   private final String localPart;
  58:   private final String prefix;
  59:   private transient String qName;
  60:   transient int hashCode = -1;
  61: 
  62:   public QName(String namespaceURI, String localPart)
  63:   {
  64:     this(namespaceURI, localPart, null);
  65:   }
  66: 
  67:   public QName(String namespaceURI, String localPart, String prefix)
  68:   {
  69:     if (namespaceURI == null)
  70:       namespaceURI = XMLConstants.NULL_NS_URI;
  71:     if (localPart == null)
  72:       throw new IllegalArgumentException();
  73:     if (prefix == null)
  74:       prefix = XMLConstants.DEFAULT_NS_PREFIX;
  75:     else
  76:       {
  77:         if (XMLConstants.XML_NS_PREFIX.equals(prefix))
  78:           namespaceURI = XMLConstants.XML_NS_URI;
  79:         else if (XMLConstants.XMLNS_ATTRIBUTE.equals(prefix))
  80:           namespaceURI = XMLConstants.XMLNS_ATTRIBUTE_NS_URI;
  81:       }
  82:     this.namespaceURI = namespaceURI;
  83:     this.localPart = localPart;
  84:     this.prefix = prefix;
  85:   }
  86: 
  87:   public QName(String localPart)
  88:   {
  89:     this(null, localPart, null);
  90:   }
  91: 
  92:   public String getNamespaceURI()
  93:   {
  94:     return namespaceURI;
  95:   }
  96: 
  97:   public String getLocalPart()
  98:   {
  99:     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: }