View Javadoc

1   /*
2    * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/QualifiedName.java,v 1.9 2005/09/25 11:39:21 elharo Exp $
3    * $Revision: 1.9 $
4    * $Date: 2005/09/25 11:39:21 $
5    *
6    * ====================================================================
7    *
8    * Copyright (C) 2000-2002 bob mcwhirter & James Strachan.
9    * All rights reserved.
10   *
11   * Redistribution and use in source and binary forms, with or without
12   * modification, are permitted provided that the following conditions
13   * are met:
14   * 
15   * 1. Redistributions of source code must retain the above copyright
16   *    notice, this list of conditions, and the following disclaimer.
17   *
18   * 2. Redistributions in binary form must reproduce the above copyright
19   *    notice, this list of conditions, and the disclaimer that follows 
20   *    these conditions in the documentation and/or other materials 
21   *    provided with the distribution.
22   *
23   * 3. The name "Jaxen" must not be used to endorse or promote products
24   *    derived from this software without prior written permission.  For
25   *    written permission, please contact license@jaxen.org.
26   * 
27   * 4. Products derived from this software may not be called "Jaxen", nor
28   *    may "Jaxen" appear in their name, without prior written permission
29   *    from the Jaxen Project Management (pm@jaxen.org).
30   * 
31   * In addition, we request (but do not require) that you include in the 
32   * end-user documentation provided with the redistribution and/or in the 
33   * software itself an acknowledgement equivalent to the following:
34   *     "This product includes software developed by the
35   *      Jaxen Project <http://www.jaxen.org/>."
36   * Alternatively, the acknowledgment may be graphical using the logos 
37   * available at http://www.jaxen.org/
38   *
39   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
40   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
42   * DISCLAIMED.  IN NO EVENT SHALL THE Jaxen AUTHORS OR THE PROJECT
43   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
46   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
47   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
48   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
49   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50   * SUCH DAMAGE.
51   *
52   * ====================================================================
53   * This software consists of voluntary contributions made by many 
54   * individuals on behalf of the Jaxen Project and was originally 
55   * created by bob mcwhirter <bob@werken.com> and 
56   * James Strachan <jstrachan@apache.org>.  For more information on the 
57   * Jaxen Project, please see <http://www.jaxen.org/>.
58   * 
59   * $Id: QualifiedName.java,v 1.9 2005/09/25 11:39:21 elharo Exp $
60   */
61  
62  package org.jaxen;
63  
64  /*** A local name (that matches the XML NCName production) and a namespace URI
65   *  with which the local name is qualified.
66   *
67   *  @author Erwin Bolwidt ( ejb @ klomp.org )
68   */
69  class QualifiedName
70  {
71      private String namespaceURI;
72      private String localName;
73      private String prefix;
74  
75      /*** Constructs a QualifiedName object.
76       *
77       *  @param namespaceURI namespace URI that qualifies the name, or
78       *                      <code>null</code> for default namespace
79       *  @param localName    local name that is qualified by the namespace uri;
80       *                      must not be <code>null</code>
81       */
82      QualifiedName( String namespaceURI, String prefix, String localName )
83      {
84          if (namespaceURI == null) namespaceURI = "";
85          if (prefix == null) prefix = "";
86          this.namespaceURI = namespaceURI;
87          this.localName = localName;
88      }
89  
90      public int hashCode()
91      {
92          return ( localName.hashCode() ^ namespaceURI.hashCode() );
93      }
94  
95      public boolean equals( Object o )
96      {
97          // Because this class is package protected and used in only
98          // two other classes, it's never actually compared to anything 
99          // other than another QualifiedName. No instanceof test is
100         // necessary here.
101         QualifiedName other = (QualifiedName) o;
102         return ( namespaceURI.equals(other.namespaceURI) &&
103                  other.localName.equals(localName) );
104     }
105     
106     /***
107      * @return James Clark's namespace form
108      */
109     String getClarkForm() {
110         if ("".equals(namespaceURI)) return localName;
111         else if ("".equals(prefix)) return "{" + namespaceURI + "}" + localName;
112         else return "{" + namespaceURI + "}" + prefix + ":" + localName;
113     }
114     
115 }
116