1 /*
2 * $Header$
3 * $Revision$
4 * $Date$
5 *
6 * ====================================================================
7 *
8 * Copyright 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 are
13 * met:
14 *
15 * * Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 *
18 * * Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 *
22 * * Neither the name of the Jaxen Project nor the names of its
23 * contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
27 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
29 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
30 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 *
38 * ====================================================================
39 * This software consists of voluntary contributions made by many
40 * individuals on behalf of the Jaxen Project and was originally
41 * created by bob mcwhirter <bob@werken.com> and
42 * James Strachan <jstrachan@apache.org>. For more information on the
43 * Jaxen Project, please see <http://www.jaxen.org/>.
44 *
45 * $Id$
46 */
47
48
49 package org.jaxen.jdom;
50
51 import org.jdom.Element;
52 import org.jdom.Namespace;
53
54 /** Wrapper for JDOM namespace nodes to give them a parent, as required
55 * by the XPath data model.
56 *
57 * @author Erwin Bolwidt
58 */
59 public class XPathNamespace
60 {
61 private Element jdomElement;
62
63 private Namespace jdomNamespace;
64
65 /** Creates a namespace-node wrapper for a namespace node that hasn't been
66 * assigned to an element yet.
67 */
68 public XPathNamespace( Namespace jdomNamespace )
69 {
70 this.jdomNamespace = jdomNamespace;
71 }
72
73 /** Creates a namespace-node wrapper for a namespace node that is assigned
74 * to the given JDOM element.
75 */
76 public XPathNamespace( Element jdomElement, Namespace jdomNamespace )
77 {
78 this.jdomElement = jdomElement;
79 this.jdomNamespace = jdomNamespace;
80 }
81
82 /** Returns the JDOM element from which this namespace node has been
83 * retrieved. The result may be null when the namespace node has not yet
84 * been assigned to an element.
85 */
86 public Element getJDOMElement()
87 {
88 return jdomElement;
89 }
90
91 /** Sets or changes the element to which this namespace node is assigned.
92 */
93 public void setJDOMElement( Element jdomElement )
94 {
95 this.jdomElement = jdomElement;
96 }
97
98 /** Returns the JDOM namespace object of this namespace node; the JDOM
99 * namespace object contains the prefix and URI of the namespace.
100 */
101 public Namespace getJDOMNamespace()
102 {
103 return jdomNamespace;
104 }
105
106 public String toString()
107 {
108 return ( "[xmlns:" + jdomNamespace.getPrefix() + "=\"" +
109 jdomNamespace.getURI() + "\", element=" +
110 jdomElement.getName() + "]" );
111 }
112 }