<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>Namespace xref</title>
<link type="text/css" rel="stylesheet" href="../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../apidocs/org/dom4j/Namespace.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <em class="comment">/*</em>
<a name="2" href="#2">2</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="3" href="#3">3</a> <em class="comment"> *</em>
<a name="4" href="#4">4</a> <em class="comment"> * This software is open source.</em>
<a name="5" href="#5">5</a> <em class="comment"> * See the bottom of this file for the licence.</em>
<a name="6" href="#6">6</a> <em class="comment"> */</em>
<a name="7" href="#7">7</a>
<a name="8" href="#8">8</a> <strong>package</strong> <a href="../../org/dom4j/package-summary.html">org.dom4j</a>;
<a name="9" href="#9">9</a>
<a name="10" href="#10">10</a> <strong>import</strong> org.dom4j.tree.AbstractNode;
<a name="11" href="#11">11</a> <strong>import</strong> org.dom4j.tree.DefaultNamespace;
<a name="12" href="#12">12</a> <strong>import</strong> org.dom4j.tree.NamespaceCache;
<a name="13" href="#13">13</a>
<a name="14" href="#14">14</a> <em>/**<em>*</em></em>
<a name="15" href="#15">15</a> <em> * <p></em>
<a name="16" href="#16">16</a> <em> * <code>Namespace</code> is a Flyweight Namespace that can be shared amongst</em>
<a name="17" href="#17">17</a> <em> * nodes.</em>
<a name="18" href="#18">18</a> <em> * </p></em>
<a name="19" href="#19">19</a> <em> * </em>
<a name="20" href="#20">20</a> <em> * @author <a href="<a href="mailto:jstrachan@apache.org" target="alexandria_uri">mailto:jstrachan@apache.org</a>">James Strachan </a></em>
<a name="21" href="#21">21</a> <em> * @version $Revision: 1.22 $</em>
<a name="22" href="#22">22</a> <em> */</em>
<a name="23" href="#23">23</a> <strong>public</strong> <strong>class</strong> <a href="../../org/dom4j/Namespace.html">Namespace</a> <strong>extends</strong> <a href="../../org/dom4j/tree/AbstractNode.html">AbstractNode</a> {
<a name="24" href="#24">24</a> <em>/**<em>* Cache of <a href="../../org/dom4j/Namespace.html">Namespace</a> instances */</em></em>
<a name="25" href="#25">25</a> <strong>protected</strong> <strong>static</strong> <strong>final</strong> <a href="../../org/dom4j/tree/NamespaceCache.html">NamespaceCache</a> CACHE = <strong>new</strong> <a href="../../org/dom4j/tree/NamespaceCache.html">NamespaceCache</a>();
<a name="26" href="#26">26</a>
<a name="27" href="#27">27</a> <em>/**<em>* XML <a href="../../org/dom4j/Namespace.html">Namespace</a> */</em></em>
<a name="28" href="#28">28</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> <a href="../../org/dom4j/Namespace.html">Namespace</a> XML_NAMESPACE = CACHE.get(<span class="string">"xml"</span>,
<a name="29" href="#29">29</a> <span class="string">"http://www.w3.org/XML/1998/namespace"</span>);
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <em>/**<em>* No <a href="../../org/dom4j/Namespace.html">Namespace</a> present */</em></em>
<a name="32" href="#32">32</a> <strong>public</strong> <strong>static</strong> <strong>final</strong> <a href="../../org/dom4j/Namespace.html">Namespace</a> NO_NAMESPACE = CACHE.get(<span class="string">""</span>, <span class="string">""</span>);
<a name="33" href="#33">33</a>
<a name="34" href="#34">34</a> <em>/**<em>* The prefix mapped to this namespace */</em></em>
<a name="35" href="#35">35</a> <strong>private</strong> String prefix;
<a name="36" href="#36">36</a>
<a name="37" href="#37">37</a> <em>/**<em>* The URI for this namespace */</em></em>
<a name="38" href="#38">38</a> <strong>private</strong> String uri;
<a name="39" href="#39">39</a>
<a name="40" href="#40">40</a> <em>/**<em>* A cached version of the hashcode for efficiency */</em></em>
<a name="41" href="#41">41</a> <strong>private</strong> <strong>int</strong> hashCode;
<a name="42" href="#42">42</a>
<a name="43" href="#43">43</a> <em>/**<em>*</em></em>
<a name="44" href="#44">44</a> <em> * DOCUMENT ME!</em>
<a name="45" href="#45">45</a> <em> * </em>
<a name="46" href="#46">46</a> <em> * @param prefix</em>
<a name="47" href="#47">47</a> <em> * is the prefix for this namespace</em>
<a name="48" href="#48">48</a> <em> * @param uri</em>
<a name="49" href="#49">49</a> <em> * is the URI for this namespace</em>
<a name="50" href="#50">50</a> <em> */</em>
<a name="51" href="#51">51</a> <strong>public</strong> <a href="../../org/dom4j/Namespace.html">Namespace</a>(String prefix, String uri) {
<a name="52" href="#52">52</a> <strong>this</strong>.prefix = (prefix != <strong>null</strong>) ? prefix : <span class="string">""</span>;
<a name="53" href="#53">53</a> <strong>this</strong>.uri = (uri != <strong>null</strong>) ? uri : <span class="string">""</span>;
<a name="54" href="#54">54</a> }
<a name="55" href="#55">55</a>
<a name="56" href="#56">56</a> <em>/**<em>*</em></em>
<a name="57" href="#57">57</a> <em> * A helper method to return the Namespace instance for the given prefix and</em>
<a name="58" href="#58">58</a> <em> * URI</em>
<a name="59" href="#59">59</a> <em> * </em>
<a name="60" href="#60">60</a> <em> * @param prefix</em>
<a name="61" href="#61">61</a> <em> * DOCUMENT ME!</em>
<a name="62" href="#62">62</a> <em> * @param uri</em>
<a name="63" href="#63">63</a> <em> * DOCUMENT ME!</em>
<a name="64" href="#64">64</a> <em> * </em>
<a name="65" href="#65">65</a> <em> * @return an interned Namespace object</em>
<a name="66" href="#66">66</a> <em> */</em>
<a name="67" href="#67">67</a> <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Namespace.html">Namespace</a> get(String prefix, String uri) {
<a name="68" href="#68">68</a> <strong>return</strong> CACHE.get(prefix, uri);
<a name="69" href="#69">69</a> }
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <em>/**<em>*</em></em>
<a name="72" href="#72">72</a> <em> * A helper method to return the Namespace instance for no prefix and the</em>
<a name="73" href="#73">73</a> <em> * URI</em>
<a name="74" href="#74">74</a> <em> * </em>
<a name="75" href="#75">75</a> <em> * @param uri</em>
<a name="76" href="#76">76</a> <em> * DOCUMENT ME!</em>
<a name="77" href="#77">77</a> <em> * </em>
<a name="78" href="#78">78</a> <em> * @return an interned Namespace object</em>
<a name="79" href="#79">79</a> <em> */</em>
<a name="80" href="#80">80</a> <strong>public</strong> <strong>static</strong> <a href="../../org/dom4j/Namespace.html">Namespace</a> get(String uri) {
<a name="81" href="#81">81</a> <strong>return</strong> CACHE.get(uri);
<a name="82" href="#82">82</a> }
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <strong>public</strong> <strong>short</strong> getNodeType() {
<a name="85" href="#85">85</a> <strong>return</strong> NAMESPACE_NODE;
<a name="86" href="#86">86</a> }
<a name="87" href="#87">87</a>
<a name="88" href="#88">88</a> <em>/**<em>*</em></em>
<a name="89" href="#89">89</a> <em> * DOCUMENT ME!</em>
<a name="90" href="#90">90</a> <em> * </em>
<a name="91" href="#91">91</a> <em> * @return the hash code based on the qualified name and the URI of the</em>
<a name="92" href="#92">92</a> <em> * namespace.</em>
<a name="93" href="#93">93</a> <em> */</em>
<a name="94" href="#94">94</a> <strong>public</strong> <strong>int</strong> hashCode() {
<a name="95" href="#95">95</a> <strong>if</strong> (hashCode == 0) {
<a name="96" href="#96">96</a> hashCode = createHashCode();
<a name="97" href="#97">97</a> }
<a name="98" href="#98">98</a>
<a name="99" href="#99">99</a> <strong>return</strong> hashCode;
<a name="100" href="#100">100</a> }
<a name="101" href="#101">101</a>
<a name="102" href="#102">102</a> <em>/**<em>*</em></em>
<a name="103" href="#103">103</a> <em> * Factory method to create the hashcode allowing derived classes to change</em>
<a name="104" href="#104">104</a> <em> * the behaviour</em>
<a name="105" href="#105">105</a> <em> * </em>
<a name="106" href="#106">106</a> <em> * @return DOCUMENT ME!</em>
<a name="107" href="#107">107</a> <em> */</em>
<a name="108" href="#108">108</a> <strong>protected</strong> <strong>int</strong> createHashCode() {
<a name="109" href="#109">109</a> <strong>int</strong> result = uri.hashCode() ^ prefix.hashCode();
<a name="110" href="#110">110</a>
<a name="111" href="#111">111</a> <strong>if</strong> (result == 0) {
<a name="112" href="#112">112</a> result = 0xbabe;
<a name="113" href="#113">113</a> }
<a name="114" href="#114">114</a>
<a name="115" href="#115">115</a> <strong>return</strong> result;
<a name="116" href="#116">116</a> }
<a name="117" href="#117">117</a>
<a name="118" href="#118">118</a> <em>/**<em>*</em></em>
<a name="119" href="#119">119</a> <em> * Checks whether this Namespace equals the given Namespace. Two Namespaces</em>
<a name="120" href="#120">120</a> <em> * are equals if their URI and prefix are equal.</em>
<a name="121" href="#121">121</a> <em> * </em>
<a name="122" href="#122">122</a> <em> * @param object</em>
<a name="123" href="#123">123</a> <em> * DOCUMENT ME!</em>
<a name="124" href="#124">124</a> <em> * </em>
<a name="125" href="#125">125</a> <em> * @return DOCUMENT ME!</em>
<a name="126" href="#126">126</a> <em> */</em>
<a name="127" href="#127">127</a> <strong>public</strong> <strong>boolean</strong> equals(Object object) {
<a name="128" href="#128">128</a> <strong>if</strong> (<strong>this</strong> == object) {
<a name="129" href="#129">129</a> <strong>return</strong> <strong>true</strong>;
<a name="130" href="#130">130</a> } <strong>else</strong> <strong>if</strong> (object instanceof Namespace) {
<a name="131" href="#131">131</a> <a href="../../org/dom4j/Namespace.html">Namespace</a> that = (Namespace) object;
<a name="132" href="#132">132</a>
<a name="133" href="#133">133</a> <em class="comment">// we cache hash codes so this should be quick</em>
<a name="134" href="#134">134</a> <strong>if</strong> (hashCode() == that.hashCode()) {
<a name="135" href="#135">135</a> <strong>return</strong> uri.equals(that.getURI())
<a name="136" href="#136">136</a> && prefix.equals(that.getPrefix());
<a name="137" href="#137">137</a> }
<a name="138" href="#138">138</a> }
<a name="139" href="#139">139</a>
<a name="140" href="#140">140</a> <strong>return</strong> false;
<a name="141" href="#141">141</a> }
<a name="142" href="#142">142</a>
<a name="143" href="#143">143</a> <strong>public</strong> String getText() {
<a name="144" href="#144">144</a> <strong>return</strong> uri;
<a name="145" href="#145">145</a> }
<a name="146" href="#146">146</a>
<a name="147" href="#147">147</a> <strong>public</strong> String getStringValue() {
<a name="148" href="#148">148</a> <strong>return</strong> uri;
<a name="149" href="#149">149</a> }
<a name="150" href="#150">150</a>
<a name="151" href="#151">151</a> <em>/**<em>*</em></em>
<a name="152" href="#152">152</a> <em> * DOCUMENT ME!</em>
<a name="153" href="#153">153</a> <em> * </em>
<a name="154" href="#154">154</a> <em> * @return the prefix for this <code>Namespace</code>.</em>
<a name="155" href="#155">155</a> <em> */</em>
<a name="156" href="#156">156</a> <strong>public</strong> String getPrefix() {
<a name="157" href="#157">157</a> <strong>return</strong> prefix;
<a name="158" href="#158">158</a> }
<a name="159" href="#159">159</a>
<a name="160" href="#160">160</a> <em>/**<em>*</em></em>
<a name="161" href="#161">161</a> <em> * DOCUMENT ME!</em>
<a name="162" href="#162">162</a> <em> * </em>
<a name="163" href="#163">163</a> <em> * @return the URI for this <code>Namespace</code>.</em>
<a name="164" href="#164">164</a> <em> */</em>
<a name="165" href="#165">165</a> <strong>public</strong> String getURI() {
<a name="166" href="#166">166</a> <strong>return</strong> uri;
<a name="167" href="#167">167</a> }
<a name="168" href="#168">168</a>
<a name="169" href="#169">169</a> <strong>public</strong> String getXPathNameStep() {
<a name="170" href="#170">170</a> <strong>if</strong> ((prefix != <strong>null</strong>) && !<span class="string">""</span>.equals(prefix)) {
<a name="171" href="#171">171</a> <strong>return</strong> <span class="string">"namespace::"</span> + prefix;
<a name="172" href="#172">172</a> }
<a name="173" href="#173">173</a>
<a name="174" href="#174">174</a> <strong>return</strong> <span class="string">"namespace::*[name()='']"</span>;
<a name="175" href="#175">175</a> }
<a name="176" href="#176">176</a>
<a name="177" href="#177">177</a> <strong>public</strong> String getPath(<a href="../../org/dom4j/Element.html">Element</a> context) {
<a name="178" href="#178">178</a> StringBuffer path = <strong>new</strong> StringBuffer(10);
<a name="179" href="#179">179</a> <a href="../../org/dom4j/Element.html">Element</a> parent = getParent();
<a name="180" href="#180">180</a>
<a name="181" href="#181">181</a> <strong>if</strong> ((parent != <strong>null</strong>) && (parent != context)) {
<a name="182" href="#182">182</a> path.append(parent.getPath(context));
<a name="183" href="#183">183</a> path.append('/');
<a name="184" href="#184">184</a> }
<a name="185" href="#185">185</a>
<a name="186" href="#186">186</a> path.append(getXPathNameStep());
<a name="187" href="#187">187</a>
<a name="188" href="#188">188</a> <strong>return</strong> path.toString();
<a name="189" href="#189">189</a> }
<a name="190" href="#190">190</a>
<a name="191" href="#191">191</a> <strong>public</strong> String getUniquePath(<a href="../../org/dom4j/Element.html">Element</a> context) {
<a name="192" href="#192">192</a> StringBuffer path = <strong>new</strong> StringBuffer(10);
<a name="193" href="#193">193</a> <a href="../../org/dom4j/Element.html">Element</a> parent = getParent();
<a name="194" href="#194">194</a>
<a name="195" href="#195">195</a> <strong>if</strong> ((parent != <strong>null</strong>) && (parent != context)) {
<a name="196" href="#196">196</a> path.append(parent.getUniquePath(context));
<a name="197" href="#197">197</a> path.append('/');
<a name="198" href="#198">198</a> }
<a name="199" href="#199">199</a>
<a name="200" href="#200">200</a> path.append(getXPathNameStep());
<a name="201" href="#201">201</a>
<a name="202" href="#202">202</a> <strong>return</strong> path.toString();
<a name="203" href="#203">203</a> }
<a name="204" href="#204">204</a>
<a name="205" href="#205">205</a> <strong>public</strong> String toString() {
<a name="206" href="#206">206</a> <strong>return</strong> <strong>super</strong>.toString() + <span class="string">" [Namespace: prefix "</span> + getPrefix()
<a name="207" href="#207">207</a> + <span class="string">" mapped to URI \""</span> + getURI() + <span class="string">"\"]"</span>;
<a name="208" href="#208">208</a> }
<a name="209" href="#209">209</a>
<a name="210" href="#210">210</a> <strong>public</strong> String asXML() {
<a name="211" href="#211">211</a> StringBuffer asxml = <strong>new</strong> StringBuffer(10);
<a name="212" href="#212">212</a> String pref = getPrefix();
<a name="213" href="#213">213</a>
<a name="214" href="#214">214</a> <strong>if</strong> ((pref != <strong>null</strong>) && (pref.length() > 0)) {
<a name="215" href="#215">215</a> asxml.append(<span class="string">"xmlns:"</span>);
<a name="216" href="#216">216</a> asxml.append(pref);
<a name="217" href="#217">217</a> asxml.append(<span class="string">"=\""</span>);
<a name="218" href="#218">218</a> } <strong>else</strong> {
<a name="219" href="#219">219</a> asxml.append(<span class="string">"xmlns=\""</span>);
<a name="220" href="#220">220</a> }
<a name="221" href="#221">221</a>
<a name="222" href="#222">222</a> asxml.append(getURI());
<a name="223" href="#223">223</a> asxml.append(<span class="string">"\""</span>);
<a name="224" href="#224">224</a>
<a name="225" href="#225">225</a> <strong>return</strong> asxml.toString();
<a name="226" href="#226">226</a> }
<a name="227" href="#227">227</a>
<a name="228" href="#228">228</a> <strong>public</strong> <strong>void</strong> accept(<a href="../../org/dom4j/Visitor.html">Visitor</a> visitor) {
<a name="229" href="#229">229</a> visitor.visit(<strong>this</strong>);
<a name="230" href="#230">230</a> }
<a name="231" href="#231">231</a>
<a name="232" href="#232">232</a> <strong>protected</strong> <a href="../../org/dom4j/Node.html">Node</a> createXPathResult(<a href="../../org/dom4j/Element.html">Element</a> parent) {
<a name="233" href="#233">233</a> <strong>return</strong> <strong>new</strong> <a href="../../org/dom4j/tree/DefaultNamespace.html">DefaultNamespace</a>(parent, getPrefix(), getURI());
<a name="234" href="#234">234</a> }
<a name="235" href="#235">235</a> }
<a name="236" href="#236">236</a>
<a name="237" href="#237">237</a> <em class="comment">/*</em>
<a name="238" href="#238">238</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="239" href="#239">239</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="240" href="#240">240</a> <em class="comment"> * following conditions are met:</em>
<a name="241" href="#241">241</a> <em class="comment"> * </em>
<a name="242" href="#242">242</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="243" href="#243">243</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="244" href="#244">244</a> <em class="comment"> * </em>
<a name="245" href="#245">245</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="246" href="#246">246</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="247" href="#247">247</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="248" href="#248">248</a> <em class="comment"> * </em>
<a name="249" href="#249">249</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="250" href="#250">250</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="251" href="#251">251</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="252" href="#252">252</a> <em class="comment"> * </em>
<a name="253" href="#253">253</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="254" href="#254">254</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="255" href="#255">255</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="256" href="#256">256</a> <em class="comment"> * </em>
<a name="257" href="#257">257</a> <em class="comment"> * 5. Due credit should be given to the DOM4J Project - <a href="http://www.dom4j.org" target="alexandria_uri">http://www.dom4j.org</a></em>
<a name="258" href="#258">258</a> <em class="comment"> * </em>
<a name="259" href="#259">259</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="260" href="#260">260</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="261" href="#261">261</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="262" href="#262">262</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="263" href="#263">263</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="264" href="#264">264</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="265" href="#265">265</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="266" href="#266">266</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="267" href="#267">267</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="268" href="#268">268</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="269" href="#269">269</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="270" href="#270">270</a> <em class="comment"> * </em>
<a name="271" href="#271">271</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="272" href="#272">272</a> <em class="comment"> */</em>
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>
