<!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>Branch xref</title>
<link type="text/css" rel="stylesheet" href="../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../apidocs/org/dom4j/Branch.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> java.util.Iterator;
<a name="11" href="#11">11</a> <strong>import</strong> java.util.List;
<a name="12" href="#12">12</a>
<a name="13" href="#13">13</a> <em>/**<em>*</em></em>
<a name="14" href="#14">14</a> <em> * <p></em>
<a name="15" href="#15">15</a> <em> * <code>Branch</code> interface defines the common behaviour for Nodes which</em>
<a name="16" href="#16">16</a> <em> * can contain child nodes (content) such as XML elements and documents. This</em>
<a name="17" href="#17">17</a> <em> * interface allows both elements and documents to be treated in a polymorphic</em>
<a name="18" href="#18">18</a> <em> * manner when changing or navigating child nodes (content).</em>
<a name="19" href="#19">19</a> <em> * </p></em>
<a name="20" href="#20">20</a> <em> * </em>
<a name="21" href="#21">21</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="22" href="#22">22</a> <em> * @version $Revision: 1.32 $</em>
<a name="23" href="#23">23</a> <em> */</em>
<a name="24" href="#24">24</a> <strong>public</strong> <strong>interface</strong> <a href="../../org/dom4j/Branch.html">Branch</a> <strong>extends</strong> <a href="../../org/dom4j/Node.html">Node</a> {
<a name="25" href="#25">25</a> <em>/**<em>*</em></em>
<a name="26" href="#26">26</a> <em> * Returns the <code>Node</code> at the specified index position.</em>
<a name="27" href="#27">27</a> <em> * </em>
<a name="28" href="#28">28</a> <em> * @param index</em>
<a name="29" href="#29">29</a> <em> * the index of the node to return.</em>
<a name="30" href="#30">30</a> <em> * </em>
<a name="31" href="#31">31</a> <em> * @return the <code>Node</code> at the specified position.</em>
<a name="32" href="#32">32</a> <em> * </em>
<a name="33" href="#33">33</a> <em> * @throws IndexOutOfBoundsException</em>
<a name="34" href="#34">34</a> <em> * if the index is out of range (index &lt; 0 || index &gt;=</em>
<a name="35" href="#35">35</a> <em> * {@link Branch#nodeCount()}).</em>
<a name="36" href="#36">36</a> <em> */</em>
<a name="37" href="#37">37</a> <a href="../../org/dom4j/Node.html">Node</a> node(<strong>int</strong> index) throws IndexOutOfBoundsException;
<a name="38" href="#38">38</a>
<a name="39" href="#39">39</a> <em>/**<em>*</em></em>
<a name="40" href="#40">40</a> <em> * Returns the index of the given node if it is a child node of this branch</em>
<a name="41" href="#41">41</a> <em> * or -1 if the given node is not a child node.</em>
<a name="42" href="#42">42</a> <em> * </em>
<a name="43" href="#43">43</a> <em> * @param node</em>
<a name="44" href="#44">44</a> <em> * the content child node to find.</em>
<a name="45" href="#45">45</a> <em> * </em>
<a name="46" href="#46">46</a> <em> * @return the index of the given node starting at 0 or -1 if the node is</em>
<a name="47" href="#47">47</a> <em> * not a child node of this branch</em>
<a name="48" href="#48">48</a> <em> */</em>
<a name="49" href="#49">49</a> <strong>int</strong> indexOf(<a href="../../org/dom4j/Node.html">Node</a> node);
<a name="50" href="#50">50</a>
<a name="51" href="#51">51</a> <em>/**<em>*</em></em>
<a name="52" href="#52">52</a> <em> * Returns the number of <code>Node</code> instances that this branch</em>
<a name="53" href="#53">53</a> <em> * contains.</em>
<a name="54" href="#54">54</a> <em> * </em>
<a name="55" href="#55">55</a> <em> * @return the number of nodes this branch contains</em>
<a name="56" href="#56">56</a> <em> */</em>
<a name="57" href="#57">57</a> <strong>int</strong> nodeCount();
<a name="58" href="#58">58</a>
<a name="59" href="#59">59</a> <em>/**<em>*</em></em>
<a name="60" href="#60">60</a> <em> * Returns the element of the given ID attribute value. If this tree is</em>
<a name="61" href="#61">61</a> <em> * capable of understanding which attribute value should be used for the ID</em>
<a name="62" href="#62">62</a> <em> * then it should be used, otherwise this method should return null.</em>
<a name="63" href="#63">63</a> <em> * </em>
<a name="64" href="#64">64</a> <em> * @param elementID</em>
<a name="65" href="#65">65</a> <em> * DOCUMENT ME!</em>
<a name="66" href="#66">66</a> <em> * </em>
<a name="67" href="#67">67</a> <em> * @return DOCUMENT ME!</em>
<a name="68" href="#68">68</a> <em> */</em>
<a name="69" href="#69">69</a> <a href="../../org/dom4j/Element.html">Element</a> elementByID(String elementID);
<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> * <p></em>
<a name="73" href="#73">73</a> <em> * Returns the content nodes of this branch as a backed {@link List}so that</em>
<a name="74" href="#74">74</a> <em> * the content of this branch may be modified directly using the</em>
<a name="75" href="#75">75</a> <em> * {@link List}interface. The <code>List</code> is backed by the</em>
<a name="76" href="#76">76</a> <em> * <code>Branch</code> so that changes to the list are reflected in the</em>
<a name="77" href="#77">77</a> <em> * branch and vice versa.</em>
<a name="78" href="#78">78</a> <em> * </p></em>
<a name="79" href="#79">79</a> <em> * </em>
<a name="80" href="#80">80</a> <em> * @return the nodes that this branch contains as a <code>List</code></em>
<a name="81" href="#81">81</a> <em> */</em>
<a name="82" href="#82">82</a> List content();
<a name="83" href="#83">83</a>
<a name="84" href="#84">84</a> <em>/**<em>*</em></em>
<a name="85" href="#85">85</a> <em> * Returns an iterator through the content nodes of this branch</em>
<a name="86" href="#86">86</a> <em> * </em>
<a name="87" href="#87">87</a> <em> * @return an iterator through the content nodes of this branch</em>
<a name="88" href="#88">88</a> <em> */</em>
<a name="89" href="#89">89</a> Iterator nodeIterator();
<a name="90" href="#90">90</a>
<a name="91" href="#91">91</a> <em>/**<em>*</em></em>
<a name="92" href="#92">92</a> <em> * Sets the contents of this branch as a <code>List</code> of</em>
<a name="93" href="#93">93</a> <em> * <code>Node</code> instances.</em>
<a name="94" href="#94">94</a> <em> * </em>
<a name="95" href="#95">95</a> <em> * @param content</em>
<a name="96" href="#96">96</a> <em> * is the list of nodes to use as the content for this branch.</em>
<a name="97" href="#97">97</a> <em> */</em>
<a name="98" href="#98">98</a> <strong>void</strong> setContent(List content);
<a name="99" href="#99">99</a>
<a name="100" href="#100">100</a> <em>/**<em>*</em></em>
<a name="101" href="#101">101</a> <em> * Appends the content of the given branch to this branch instance. This</em>
<a name="102" href="#102">102</a> <em> * method behaves like the {@link</em>
<a name="103" href="#103">103</a> <em> * java.util.Collection#addAll(java.util.Collection)} method.</em>
<a name="104" href="#104">104</a> <em> * </em>
<a name="105" href="#105">105</a> <em> * @param branch</em>
<a name="106" href="#106">106</a> <em> * is the branch whose content will be added to me.</em>
<a name="107" href="#107">107</a> <em> */</em>
<a name="108" href="#108">108</a> <strong>void</strong> appendContent(<a href="../../org/dom4j/Branch.html">Branch</a> branch);
<a name="109" href="#109">109</a>
<a name="110" href="#110">110</a> <em>/**<em>*</em></em>
<a name="111" href="#111">111</a> <em> * Clears the content for this branch, removing any <code>Node</code></em>
<a name="112" href="#112">112</a> <em> * instances this branch may contain.</em>
<a name="113" href="#113">113</a> <em> */</em>
<a name="114" href="#114">114</a> <strong>void</strong> clearContent();
<a name="115" href="#115">115</a>
<a name="116" href="#116">116</a> <em>/**<em>*</em></em>
<a name="117" href="#117">117</a> <em> * <p></em>
<a name="118" href="#118">118</a> <em> * Returns a list of all the processing instructions in this branch. The</em>
<a name="119" href="#119">119</a> <em> * list is backed by this branch so that changes to the list will be</em>
<a name="120" href="#120">120</a> <em> * reflected in the branch but the reverse is not the case.</em>
<a name="121" href="#121">121</a> <em> * </p></em>
<a name="122" href="#122">122</a> <em> * </em>
<a name="123" href="#123">123</a> <em> * @return a backed list of the processing instructions</em>
<a name="124" href="#124">124</a> <em> */</em>
<a name="125" href="#125">125</a> List processingInstructions();
<a name="126" href="#126">126</a>
<a name="127" href="#127">127</a> <em>/**<em>*</em></em>
<a name="128" href="#128">128</a> <em> * <p></em>
<a name="129" href="#129">129</a> <em> * Returns a list of the processing instructions for the given target. The</em>
<a name="130" href="#130">130</a> <em> * list is backed by this branch so that changes to the list will be</em>
<a name="131" href="#131">131</a> <em> * reflected in the branch but the reverse is not the case.</em>
<a name="132" href="#132">132</a> <em> * </p></em>
<a name="133" href="#133">133</a> <em> * </em>
<a name="134" href="#134">134</a> <em> * @param target</em>
<a name="135" href="#135">135</a> <em> * DOCUMENT ME!</em>
<a name="136" href="#136">136</a> <em> * </em>
<a name="137" href="#137">137</a> <em> * @return a backed list of the processing instructions</em>
<a name="138" href="#138">138</a> <em> */</em>
<a name="139" href="#139">139</a> List processingInstructions(String target);
<a name="140" href="#140">140</a>
<a name="141" href="#141">141</a> <em>/**<em>*</em></em>
<a name="142" href="#142">142</a> <em> * DOCUMENT ME!</em>
<a name="143" href="#143">143</a> <em> * </em>
<a name="144" href="#144">144</a> <em> * @param target</em>
<a name="145" href="#145">145</a> <em> * DOCUMENT ME!</em>
<a name="146" href="#146">146</a> <em> * </em>
<a name="147" href="#147">147</a> <em> * @return the processing instruction for the given target</em>
<a name="148" href="#148">148</a> <em> */</em>
<a name="149" href="#149">149</a> <a href="../../org/dom4j/ProcessingInstruction.html">ProcessingInstruction</a> processingInstruction(String target);
<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> * Sets all the processing instructions for this branch</em>
<a name="153" href="#153">153</a> <em> * </em>
<a name="154" href="#154">154</a> <em> * @param listOfPIs</em>
<a name="155" href="#155">155</a> <em> * DOCUMENT ME!</em>
<a name="156" href="#156">156</a> <em> */</em>
<a name="157" href="#157">157</a> <strong>void</strong> setProcessingInstructions(List listOfPIs);
<a name="158" href="#158">158</a>
<a name="159" href="#159">159</a> <em>/**<em>*</em></em>
<a name="160" href="#160">160</a> <em> * Adds a new <code>Element</code> node with the given name to this branch</em>
<a name="161" href="#161">161</a> <em> * and returns a reference to the new node.</em>
<a name="162" href="#162">162</a> <em> * </em>
<a name="163" href="#163">163</a> <em> * @param name</em>
<a name="164" href="#164">164</a> <em> * is the name for the <code>Element</code> node.</em>
<a name="165" href="#165">165</a> <em> * </em>
<a name="166" href="#166">166</a> <em> * @return the newly added <code>Element</code> node.</em>
<a name="167" href="#167">167</a> <em> */</em>
<a name="168" href="#168">168</a> <a href="../../org/dom4j/Element.html">Element</a> addElement(String name);
<a name="169" href="#169">169</a>
<a name="170" href="#170">170</a> <em>/**<em>*</em></em>
<a name="171" href="#171">171</a> <em> * Adds a new <code>Element</code> node with the given {@link QName}to</em>
<a name="172" href="#172">172</a> <em> * this branch and returns a reference to the new node.</em>
<a name="173" href="#173">173</a> <em> * </em>
<a name="174" href="#174">174</a> <em> * @param qname</em>
<a name="175" href="#175">175</a> <em> * is the qualified name for the <code>Element</code> node.</em>
<a name="176" href="#176">176</a> <em> * </em>
<a name="177" href="#177">177</a> <em> * @return the newly added <code>Element</code> node.</em>
<a name="178" href="#178">178</a> <em> */</em>
<a name="179" href="#179">179</a> <a href="../../org/dom4j/Element.html">Element</a> addElement(<a href="../../org/dom4j/QName.html">QName</a> qname);
<a name="180" href="#180">180</a>
<a name="181" href="#181">181</a> <em>/**<em>*</em></em>
<a name="182" href="#182">182</a> <em> * Adds a new <code>Element</code> node with the given qualified name and</em>
<a name="183" href="#183">183</a> <em> * namespace URI to this branch and returns a reference to the new node.</em>
<a name="184" href="#184">184</a> <em> * </em>
<a name="185" href="#185">185</a> <em> * @param qualifiedName</em>
<a name="186" href="#186">186</a> <em> * is the fully qualified name of the Element</em>
<a name="187" href="#187">187</a> <em> * @param namespaceURI</em>
<a name="188" href="#188">188</a> <em> * is the URI of the namespace to use</em>
<a name="189" href="#189">189</a> <em> * </em>
<a name="190" href="#190">190</a> <em> * @return the newly added <code>Element</code> node.</em>
<a name="191" href="#191">191</a> <em> */</em>
<a name="192" href="#192">192</a> <a href="../../org/dom4j/Element.html">Element</a> addElement(String qualifiedName, String namespaceURI);
<a name="193" href="#193">193</a>
<a name="194" href="#194">194</a> <em>/**<em>*</em></em>
<a name="195" href="#195">195</a> <em> * Removes the processing instruction for the given target if it exists</em>
<a name="196" href="#196">196</a> <em> * </em>
<a name="197" href="#197">197</a> <em> * @param target</em>
<a name="198" href="#198">198</a> <em> * DOCUMENT ME!</em>
<a name="199" href="#199">199</a> <em> * </em>
<a name="200" href="#200">200</a> <em> * @return true if a processing instruction was removed else false</em>
<a name="201" href="#201">201</a> <em> */</em>
<a name="202" href="#202">202</a> <strong>boolean</strong> removeProcessingInstruction(String target);
<a name="203" href="#203">203</a>
<a name="204" href="#204">204</a> <em>/**<em>*</em></em>
<a name="205" href="#205">205</a> <em> * Adds the given <code>Node</code> or throws {@link IllegalAddException}</em>
<a name="206" href="#206">206</a> <em> * if the given node is not of a valid type. This is a polymorphic method</em>
<a name="207" href="#207">207</a> <em> * which will call the typesafe method for the node type such as</em>
<a name="208" href="#208">208</a> <em> * add(Element) or add(Comment).</em>
<a name="209" href="#209">209</a> <em> * </em>
<a name="210" href="#210">210</a> <em> * @param node</em>
<a name="211" href="#211">211</a> <em> * is the given node to add</em>
<a name="212" href="#212">212</a> <em> */</em>
<a name="213" href="#213">213</a> <strong>void</strong> add(<a href="../../org/dom4j/Node.html">Node</a> node);
<a name="214" href="#214">214</a>
<a name="215" href="#215">215</a> <em>/**<em>*</em></em>
<a name="216" href="#216">216</a> <em> * Adds the given <code>Comment</code> to this branch. If the given node</em>
<a name="217" href="#217">217</a> <em> * already has a parent defined then an <code>IllegalAddException</code></em>
<a name="218" href="#218">218</a> <em> * will be thrown.</em>
<a name="219" href="#219">219</a> <em> * </em>
<a name="220" href="#220">220</a> <em> * @param comment</em>
<a name="221" href="#221">221</a> <em> * is the comment to be added</em>
<a name="222" href="#222">222</a> <em> */</em>
<a name="223" href="#223">223</a> <strong>void</strong> add(<a href="../../org/dom4j/Comment.html">Comment</a> comment);
<a name="224" href="#224">224</a>
<a name="225" href="#225">225</a> <em>/**<em>*</em></em>
<a name="226" href="#226">226</a> <em> * Adds the given <code>Element</code> to this branch. If the given node</em>
<a name="227" href="#227">227</a> <em> * already has a parent defined then an <code>IllegalAddException</code></em>
<a name="228" href="#228">228</a> <em> * will be thrown.</em>
<a name="229" href="#229">229</a> <em> * </em>
<a name="230" href="#230">230</a> <em> * @param element</em>
<a name="231" href="#231">231</a> <em> * is the element to be added</em>
<a name="232" href="#232">232</a> <em> */</em>
<a name="233" href="#233">233</a> <strong>void</strong> add(<a href="../../org/dom4j/Element.html">Element</a> element);
<a name="234" href="#234">234</a>
<a name="235" href="#235">235</a> <em>/**<em>*</em></em>
<a name="236" href="#236">236</a> <em> * Adds the given <code>ProcessingInstruction</code> to this branch. If</em>
<a name="237" href="#237">237</a> <em> * the given node already has a parent defined then an</em>
<a name="238" href="#238">238</a> <em> * <code>IllegalAddException</code> will be thrown.</em>
<a name="239" href="#239">239</a> <em> * </em>
<a name="240" href="#240">240</a> <em> * @param pi</em>
<a name="241" href="#241">241</a> <em> * is the processing instruction to be added</em>
<a name="242" href="#242">242</a> <em> */</em>
<a name="243" href="#243">243</a> <strong>void</strong> add(<a href="../../org/dom4j/ProcessingInstruction.html">ProcessingInstruction</a> pi);
<a name="244" href="#244">244</a>
<a name="245" href="#245">245</a> <em>/**<em>*</em></em>
<a name="246" href="#246">246</a> <em> * Removes the given <code>Node</code> if the node is an immediate child</em>
<a name="247" href="#247">247</a> <em> * of this branch. If the given node is not an immediate child of this</em>
<a name="248" href="#248">248</a> <em> * branch then the {@link Node#detach()}method should be used instead. This</em>
<a name="249" href="#249">249</a> <em> * is a polymorphic method which will call the typesafe method for the node</em>
<a name="250" href="#250">250</a> <em> * type such as remove(Element) or remove(Comment).</em>
<a name="251" href="#251">251</a> <em> * </em>
<a name="252" href="#252">252</a> <em> * @param node</em>
<a name="253" href="#253">253</a> <em> * is the given node to be removed</em>
<a name="254" href="#254">254</a> <em> * </em>
<a name="255" href="#255">255</a> <em> * @return true if the node was removed</em>
<a name="256" href="#256">256</a> <em> */</em>
<a name="257" href="#257">257</a> <strong>boolean</strong> remove(<a href="../../org/dom4j/Node.html">Node</a> node);
<a name="258" href="#258">258</a>
<a name="259" href="#259">259</a> <em>/**<em>*</em></em>
<a name="260" href="#260">260</a> <em> * Removes the given <code>Comment</code> if the node is an immediate</em>
<a name="261" href="#261">261</a> <em> * child of this branch. If the given node is not an immediate child of this</em>
<a name="262" href="#262">262</a> <em> * branch then the {@link Node#detach()}method should be used instead.</em>
<a name="263" href="#263">263</a> <em> * </em>
<a name="264" href="#264">264</a> <em> * @param comment</em>
<a name="265" href="#265">265</a> <em> * is the comment to be removed</em>
<a name="266" href="#266">266</a> <em> * </em>
<a name="267" href="#267">267</a> <em> * @return true if the comment was removed</em>
<a name="268" href="#268">268</a> <em> */</em>
<a name="269" href="#269">269</a> <strong>boolean</strong> remove(<a href="../../org/dom4j/Comment.html">Comment</a> comment);
<a name="270" href="#270">270</a>
<a name="271" href="#271">271</a> <em>/**<em>*</em></em>
<a name="272" href="#272">272</a> <em> * Removes the given <code>Element</code> if the node is an immediate</em>
<a name="273" href="#273">273</a> <em> * child of this branch. If the given node is not an immediate child of this</em>
<a name="274" href="#274">274</a> <em> * branch then the {@link Node#detach()}method should be used instead.</em>
<a name="275" href="#275">275</a> <em> * </em>
<a name="276" href="#276">276</a> <em> * @param element</em>
<a name="277" href="#277">277</a> <em> * is the element to be removed</em>
<a name="278" href="#278">278</a> <em> * </em>
<a name="279" href="#279">279</a> <em> * @return true if the element was removed</em>
<a name="280" href="#280">280</a> <em> */</em>
<a name="281" href="#281">281</a> <strong>boolean</strong> remove(<a href="../../org/dom4j/Element.html">Element</a> element);
<a name="282" href="#282">282</a>
<a name="283" href="#283">283</a> <em>/**<em>*</em></em>
<a name="284" href="#284">284</a> <em> * Removes the given <code>ProcessingInstruction</code> if the node is an</em>
<a name="285" href="#285">285</a> <em> * immediate child of this branch. If the given node is not an immediate</em>
<a name="286" href="#286">286</a> <em> * child of this branch then the {@link Node#detach()}method should be used</em>
<a name="287" href="#287">287</a> <em> * instead.</em>
<a name="288" href="#288">288</a> <em> * </em>
<a name="289" href="#289">289</a> <em> * @param pi</em>
<a name="290" href="#290">290</a> <em> * is the processing instruction to be removed</em>
<a name="291" href="#291">291</a> <em> * </em>
<a name="292" href="#292">292</a> <em> * @return true if the processing instruction was removed</em>
<a name="293" href="#293">293</a> <em> */</em>
<a name="294" href="#294">294</a> <strong>boolean</strong> remove(<a href="../../org/dom4j/ProcessingInstruction.html">ProcessingInstruction</a> pi);
<a name="295" href="#295">295</a>
<a name="296" href="#296">296</a> <em>/**<em>*</em></em>
<a name="297" href="#297">297</a> <em> * Puts all <code>Text</code> nodes in the full depth of the sub-tree</em>
<a name="298" href="#298">298</a> <em> * underneath this <code>Node</code>, including attribute nodes, into a</em>
<a name="299" href="#299">299</a> <em> * "normal" form where only structure (e.g., elements, comments, processing</em>
<a name="300" href="#300">300</a> <em> * instructions, CDATA sections, and entity references) separates</em>
<a name="301" href="#301">301</a> <em> * <code>Text</code> nodes, i.e., there are neither adjacent</em>
<a name="302" href="#302">302</a> <em> * <code>Text</code> nodes nor empty <code>Text</code> nodes. This can</em>
<a name="303" href="#303">303</a> <em> * be used to ensure that the DOM view of a document is the same as if it</em>
<a name="304" href="#304">304</a> <em> * were saved and re-loaded, and is useful when operations (such as XPointer</em>
<a name="305" href="#305">305</a> <em> * lookups) that depend on a particular document tree structure are to be</em>
<a name="306" href="#306">306</a> <em> * used.In cases where the document contains <code>CDATASections</code>,</em>
<a name="307" href="#307">307</a> <em> * the normalize operation alone may not be sufficient, since XPointers do</em>
<a name="308" href="#308">308</a> <em> * not differentiate between <code>Text</code> nodes and</em>
<a name="309" href="#309">309</a> <em> * <code>CDATASection</code> nodes.</em>
<a name="310" href="#310">310</a> <em> * </em>
<a name="311" href="#311">311</a> <em> * @since DOM Level 2</em>
<a name="312" href="#312">312</a> <em> */</em>
<a name="313" href="#313">313</a> <strong>void</strong> normalize();
<a name="314" href="#314">314</a> }
<a name="315" href="#315">315</a>
<a name="316" href="#316">316</a> <em class="comment">/*</em>
<a name="317" href="#317">317</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="318" href="#318">318</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="319" href="#319">319</a> <em class="comment"> * following conditions are met:</em>
<a name="320" href="#320">320</a> <em class="comment"> * </em>
<a name="321" href="#321">321</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="322" href="#322">322</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="323" href="#323">323</a> <em class="comment"> * </em>
<a name="324" href="#324">324</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="325" href="#325">325</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="326" href="#326">326</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="327" href="#327">327</a> <em class="comment"> * </em>
<a name="328" href="#328">328</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="329" href="#329">329</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="330" href="#330">330</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="331" href="#331">331</a> <em class="comment"> * </em>
<a name="332" href="#332">332</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="333" href="#333">333</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="334" href="#334">334</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="335" href="#335">335</a> <em class="comment"> * </em>
<a name="336" href="#336">336</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="337" href="#337">337</a> <em class="comment"> * </em>
<a name="338" href="#338">338</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="339" href="#339">339</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="340" href="#340">340</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="341" href="#341">341</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="342" href="#342">342</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="343" href="#343">343</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="344" href="#344">344</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="345" href="#345">345</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="346" href="#346">346</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="347" href="#347">347</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="348" href="#348">348</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="349" href="#349">349</a> <em class="comment"> * </em>
<a name="350" href="#350">350</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="351" href="#351">351</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>
