View Javadoc

1   /*
2    * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/jdom/XPathNamespace.java,v 1.5 2005/04/09 21:56:32 elharo Exp $
3    * $Revision: 1.5 $
4    * $Date: 2005/04/09 21:56:32 $
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: XPathNamespace.java,v 1.5 2005/04/09 21:56:32 elharo Exp $
60   */
61  
62  
63  package org.jaxen.jdom;
64  
65  import org.jdom.Element;
66  import org.jdom.Namespace;
67  
68  /*** Wrapper for JDOM namespace nodes to give them a parent, as required
69   *  by the XPath data model.
70   *
71   *  @author Erwin Bolwidt
72   */
73  public class XPathNamespace
74  {
75      private Element jdomElement;
76  
77      private Namespace jdomNamespace;
78  
79      /*** Creates a namespace-node wrapper for a namespace node that hasn't been
80       *  assigned to an element yet.
81       */
82      public XPathNamespace( Namespace jdomNamespace )
83      {
84          this.jdomNamespace = jdomNamespace;
85      }
86  
87      /*** Creates a namespace-node wrapper for a namespace node that is assigned
88       *  to the given JDOM element.
89       */
90      public XPathNamespace( Element jdomElement, Namespace jdomNamespace )
91      {
92          this.jdomElement = jdomElement;
93          this.jdomNamespace = jdomNamespace;
94      }
95  
96      /*** Returns the JDOM element from which this namespace node has been 
97       *  retrieved. The result may be null when the namespace node has not yet
98       *  been assigned to an element.
99       */
100     public Element getJDOMElement()
101     {
102         return jdomElement;
103     }
104 
105     /*** Sets or changes the element to which this namespace node is assigned.
106      */
107     public void setJDOMElement( Element jdomElement )
108     {
109         this.jdomElement = jdomElement;
110     }
111 
112     /*** Returns the JDOM namespace object of this namespace node; the JDOM
113      *  namespace object contains the prefix and URI of the namespace.
114      */
115     public Namespace getJDOMNamespace()
116     {
117         return jdomNamespace;
118     }
119 
120     public String toString()
121     {
122         return ( "[xmlns:" + jdomNamespace.getPrefix() + "=\"" +
123                  jdomNamespace.getURI() + "\", element=" +
124                  jdomElement.getName() + "]" );
125     }
126 }