Sophie

Sophie

distrib > Mageia > 6 > armv5tl > by-pkgid > cacbe0cdc7cef785f91dc4ba8bcbc61e > files > 291

dom4j-manual-1.6.1-28.1.mga6.noarch.rpm

<!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>Element xref</title>
<link type="text/css" rel="stylesheet" href="../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../apidocs/org/dom4j/Element.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>  <strong>import</strong> java.util.Map;
<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> * &lt;p></em>
<a name="16" href="#16">16</a>  <em> * &lt;code>Element&lt;/code> interface defines an XML element. An element can have</em>
<a name="17" href="#17">17</a>  <em> * declared namespaces, attributes, child nodes and textual content.</em>
<a name="18" href="#18">18</a>  <em> * &lt;/p></em>
<a name="19" href="#19">19</a>  <em> * </em>
<a name="20" href="#20">20</a>  <em> * &lt;p></em>
<a name="21" href="#21">21</a>  <em> * Some of this interface is optional. Some implementations may be read-only and</em>
<a name="22" href="#22">22</a>  <em> * not support being modified. Some implementations may not support the parent</em>
<a name="23" href="#23">23</a>  <em> * relationship and methods such as {@link #getParent}or {@link#getDocument}.</em>
<a name="24" href="#24">24</a>  <em> * &lt;/p></em>
<a name="25" href="#25">25</a>  <em> * </em>
<a name="26" href="#26">26</a>  <em> * @author &lt;a href="<a href="mailto:jstrachan@apache.org" target="alexandria_uri">mailto:jstrachan@apache.org</a>">James Strachan &lt;/a></em>
<a name="27" href="#27">27</a>  <em> * @version $Revision: 1.47 $</em>
<a name="28" href="#28">28</a>  <em> */</em>
<a name="29" href="#29">29</a>  <strong>public</strong> <strong>interface</strong> <a href="../../org/dom4j/Element.html">Element</a> <strong>extends</strong> <a href="../../org/dom4j/Branch.html">Branch</a> {
<a name="30" href="#30">30</a>      <em class="comment">// Name and namespace related methods</em>
<a name="31" href="#31">31</a>      <em class="comment">// -------------------------------------------------------------------------</em>
<a name="32" href="#32">32</a>  
<a name="33" href="#33">33</a>      <em>/**<em>*</em></em>
<a name="34" href="#34">34</a>  <em>     * &lt;p></em>
<a name="35" href="#35">35</a>  <em>     * Returns the &lt;code>QName&lt;/code> of this element which represents the</em>
<a name="36" href="#36">36</a>  <em>     * local name, the qualified name and the &lt;code>Namespace&lt;/code>.</em>
<a name="37" href="#37">37</a>  <em>     * &lt;/p></em>
<a name="38" href="#38">38</a>  <em>     * </em>
<a name="39" href="#39">39</a>  <em>     * @return the &lt;code>QName&lt;/code> associated with this element</em>
<a name="40" href="#40">40</a>  <em>     */</em>
<a name="41" href="#41">41</a>      <a href="../../org/dom4j/QName.html">QName</a> getQName();
<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>     * &lt;p></em>
<a name="45" href="#45">45</a>  <em>     * Sets the &lt;code>QName&lt;/code> of this element which represents the local</em>
<a name="46" href="#46">46</a>  <em>     * name, the qualified name and the &lt;code>Namespace&lt;/code>.</em>
<a name="47" href="#47">47</a>  <em>     * &lt;/p></em>
<a name="48" href="#48">48</a>  <em>     * </em>
<a name="49" href="#49">49</a>  <em>     * @param qname</em>
<a name="50" href="#50">50</a>  <em>     *            is the &lt;code>QName&lt;/code> to be associated with this element</em>
<a name="51" href="#51">51</a>  <em>     */</em>
<a name="52" href="#52">52</a>      <strong>void</strong> setQName(<a href="../../org/dom4j/QName.html">QName</a> qname);
<a name="53" href="#53">53</a>  
<a name="54" href="#54">54</a>      <em>/**<em>*</em></em>
<a name="55" href="#55">55</a>  <em>     * &lt;p></em>
<a name="56" href="#56">56</a>  <em>     * Returns the &lt;code>Namespace&lt;/code> of this element if one exists</em>
<a name="57" href="#57">57</a>  <em>     * otherwise &lt;code>Namespace.NO_NAMESPACE&lt;/code> is returned.</em>
<a name="58" href="#58">58</a>  <em>     * &lt;/p></em>
<a name="59" href="#59">59</a>  <em>     * </em>
<a name="60" href="#60">60</a>  <em>     * @return the &lt;code>Namespace&lt;/code> associated with this element</em>
<a name="61" href="#61">61</a>  <em>     */</em>
<a name="62" href="#62">62</a>      <a href="../../org/dom4j/Namespace.html">Namespace</a> getNamespace();
<a name="63" href="#63">63</a>  
<a name="64" href="#64">64</a>      <em>/**<em>*</em></em>
<a name="65" href="#65">65</a>  <em>     * &lt;p></em>
<a name="66" href="#66">66</a>  <em>     * Returns the &lt;code>QName&lt;/code> for the given qualified name, using the</em>
<a name="67" href="#67">67</a>  <em>     * namespace URI in scope for the given prefix of the qualified name or the</em>
<a name="68" href="#68">68</a>  <em>     * default namespace if the qualified name has no prefix.</em>
<a name="69" href="#69">69</a>  <em>     * &lt;/p></em>
<a name="70" href="#70">70</a>  <em>     * </em>
<a name="71" href="#71">71</a>  <em>     * @param qualifiedName</em>
<a name="72" href="#72">72</a>  <em>     *            DOCUMENT ME!</em>
<a name="73" href="#73">73</a>  <em>     * </em>
<a name="74" href="#74">74</a>  <em>     * @return the &lt;code>QName&lt;/code> for the given qualified name</em>
<a name="75" href="#75">75</a>  <em>     */</em>
<a name="76" href="#76">76</a>      <a href="../../org/dom4j/QName.html">QName</a> getQName(String qualifiedName);
<a name="77" href="#77">77</a>  
<a name="78" href="#78">78</a>      <em>/**<em>*</em></em>
<a name="79" href="#79">79</a>  <em>     * &lt;p></em>
<a name="80" href="#80">80</a>  <em>     * Returns the &lt;code>Namespace&lt;/code> which is mapped to the given prefix</em>
<a name="81" href="#81">81</a>  <em>     * or null if it could not be found.</em>
<a name="82" href="#82">82</a>  <em>     * &lt;/p></em>
<a name="83" href="#83">83</a>  <em>     * </em>
<a name="84" href="#84">84</a>  <em>     * @param prefix</em>
<a name="85" href="#85">85</a>  <em>     *            DOCUMENT ME!</em>
<a name="86" href="#86">86</a>  <em>     * </em>
<a name="87" href="#87">87</a>  <em>     * @return the &lt;code>Namespace&lt;/code> associated with the given prefix</em>
<a name="88" href="#88">88</a>  <em>     */</em>
<a name="89" href="#89">89</a>      <a href="../../org/dom4j/Namespace.html">Namespace</a> getNamespaceForPrefix(String prefix);
<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>     * &lt;p></em>
<a name="93" href="#93">93</a>  <em>     * Returns the &lt;code>Namespace&lt;/code> which is mapped to the given URI or</em>
<a name="94" href="#94">94</a>  <em>     * null if it could not be found. If there is more than one</em>
<a name="95" href="#95">95</a>  <em>     * &lt;code>Namespace&lt;/code> mapped to the URI, which of them will be</em>
<a name="96" href="#96">96</a>  <em>     * returned is undetermined.</em>
<a name="97" href="#97">97</a>  <em>     * &lt;/p></em>
<a name="98" href="#98">98</a>  <em>     * </em>
<a name="99" href="#99">99</a>  <em>     * @param uri</em>
<a name="100" href="#100">100</a> <em>     *            DOCUMENT ME!</em>
<a name="101" href="#101">101</a> <em>     * </em>
<a name="102" href="#102">102</a> <em>     * @return the &lt;code>Namespace&lt;/code> associated with the given URI</em>
<a name="103" href="#103">103</a> <em>     */</em>
<a name="104" href="#104">104</a>     <a href="../../org/dom4j/Namespace.html">Namespace</a> getNamespaceForURI(String uri);
<a name="105" href="#105">105</a> 
<a name="106" href="#106">106</a>     <em>/**<em>*</em></em>
<a name="107" href="#107">107</a> <em>     * &lt;p></em>
<a name="108" href="#108">108</a> <em>     * Returns the all namespaces which are mapped to the given URI or an empty</em>
<a name="109" href="#109">109</a> <em>     * list if no such namespaces could be found.</em>
<a name="110" href="#110">110</a> <em>     * &lt;/p></em>
<a name="111" href="#111">111</a> <em>     * </em>
<a name="112" href="#112">112</a> <em>     * @param uri</em>
<a name="113" href="#113">113</a> <em>     *            DOCUMENT ME!</em>
<a name="114" href="#114">114</a> <em>     * </em>
<a name="115" href="#115">115</a> <em>     * @return the namespaces associated with the given URI</em>
<a name="116" href="#116">116</a> <em>     * </em>
<a name="117" href="#117">117</a> <em>     * @since 1.5</em>
<a name="118" href="#118">118</a> <em>     */</em>
<a name="119" href="#119">119</a>     List getNamespacesForURI(String uri);
<a name="120" href="#120">120</a> 
<a name="121" href="#121">121</a>     <em>/**<em>*</em></em>
<a name="122" href="#122">122</a> <em>     * &lt;p></em>
<a name="123" href="#123">123</a> <em>     * Returns the namespace prefix of this element if one exists otherwise an</em>
<a name="124" href="#124">124</a> <em>     * empty &lt;code>String&lt;/code> is returned.</em>
<a name="125" href="#125">125</a> <em>     * &lt;/p></em>
<a name="126" href="#126">126</a> <em>     * </em>
<a name="127" href="#127">127</a> <em>     * @return the prefix of the &lt;code>Namespace&lt;/code> of this element or an</em>
<a name="128" href="#128">128</a> <em>     *         empty &lt;code>String&lt;/code></em>
<a name="129" href="#129">129</a> <em>     */</em>
<a name="130" href="#130">130</a>     String getNamespacePrefix();
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>     <em>/**<em>*</em></em>
<a name="133" href="#133">133</a> <em>     * &lt;p></em>
<a name="134" href="#134">134</a> <em>     * Returns the URI mapped to the namespace of this element if one exists</em>
<a name="135" href="#135">135</a> <em>     * otherwise an empty &lt;code>String&lt;/code> is returned.</em>
<a name="136" href="#136">136</a> <em>     * &lt;/p></em>
<a name="137" href="#137">137</a> <em>     * </em>
<a name="138" href="#138">138</a> <em>     * @return the URI for the &lt;code>Namespace&lt;/code> of this element or an</em>
<a name="139" href="#139">139</a> <em>     *         empty &lt;code>String&lt;/code></em>
<a name="140" href="#140">140</a> <em>     */</em>
<a name="141" href="#141">141</a>     String getNamespaceURI();
<a name="142" href="#142">142</a> 
<a name="143" href="#143">143</a>     <em>/**<em>*</em></em>
<a name="144" href="#144">144</a> <em>     * &lt;p></em>
<a name="145" href="#145">145</a> <em>     * Returns the fully qualified name of this element. This will be the same</em>
<a name="146" href="#146">146</a> <em>     * as the value returned from {@link #getName}if this element has no</em>
<a name="147" href="#147">147</a> <em>     * namespace attached to this element or an expression of the form</em>
<a name="148" href="#148">148</a> <em>     * </em>
<a name="149" href="#149">149</a> <em>     * &lt;pre></em>
<a name="150" href="#150">150</a> <em>     * getNamespacePrefix() + &amp;quot;:&amp;quot; + getName()</em>
<a name="151" href="#151">151</a> <em>     * &lt;/pre></em>
<a name="152" href="#152">152</a> <em>     * </em>
<a name="153" href="#153">153</a> <em>     * will be returned.</em>
<a name="154" href="#154">154</a> <em>     * &lt;/p></em>
<a name="155" href="#155">155</a> <em>     * </em>
<a name="156" href="#156">156</a> <em>     * @return the fully qualified name of the element.</em>
<a name="157" href="#157">157</a> <em>     */</em>
<a name="158" href="#158">158</a>     String getQualifiedName();
<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>     * &lt;p></em>
<a name="162" href="#162">162</a> <em>     * Returns any additional namespaces declarations for this element other</em>
<a name="163" href="#163">163</a> <em>     * than namespace returned via the {@link #getNamespace()}method. If no</em>
<a name="164" href="#164">164</a> <em>     * additional namespace declarations are present for this element then an</em>
<a name="165" href="#165">165</a> <em>     * empty list will be returned. The list is backed by the element such that</em>
<a name="166" href="#166">166</a> <em>     * changes to the list will be reflected in the element though the reverse</em>
<a name="167" href="#167">167</a> <em>     * is not the case.</em>
<a name="168" href="#168">168</a> <em>     * &lt;/p></em>
<a name="169" href="#169">169</a> <em>     * </em>
<a name="170" href="#170">170</a> <em>     * @return a list of any additional namespace declarations.</em>
<a name="171" href="#171">171</a> <em>     */</em>
<a name="172" href="#172">172</a>     List additionalNamespaces();
<a name="173" href="#173">173</a> 
<a name="174" href="#174">174</a>     <em>/**<em>*</em></em>
<a name="175" href="#175">175</a> <em>     * &lt;p></em>
<a name="176" href="#176">176</a> <em>     * Returns all the namespaces declared by this element. If no namespaces are</em>
<a name="177" href="#177">177</a> <em>     * declared for this element then an empty list will be returned. The list</em>
<a name="178" href="#178">178</a> <em>     * is backed by the element such that changes to the list will be reflected</em>
<a name="179" href="#179">179</a> <em>     * in the element though the reverse is not the case.</em>
<a name="180" href="#180">180</a> <em>     * &lt;/p></em>
<a name="181" href="#181">181</a> <em>     * </em>
<a name="182" href="#182">182</a> <em>     * @return a list of namespaces declared for this element.</em>
<a name="183" href="#183">183</a> <em>     */</em>
<a name="184" href="#184">184</a>     List declaredNamespaces();
<a name="185" href="#185">185</a> 
<a name="186" href="#186">186</a>     <em class="comment">// Builder methods</em>
<a name="187" href="#187">187</a>     <em class="comment">// -------------------------------------------------------------------------</em>
<a name="188" href="#188">188</a> 
<a name="189" href="#189">189</a>     <em>/**<em>*</em></em>
<a name="190" href="#190">190</a> <em>     * &lt;p></em>
<a name="191" href="#191">191</a> <em>     * Adds the attribute value of the given local name. If an attribute already</em>
<a name="192" href="#192">192</a> <em>     * exists for the given name it will be replaced. Attributes with null</em>
<a name="193" href="#193">193</a> <em>     * values are silently ignored. If the value of the attribute is null then</em>
<a name="194" href="#194">194</a> <em>     * this method call will remove any attributes with the given name.</em>
<a name="195" href="#195">195</a> <em>     * &lt;/p></em>
<a name="196" href="#196">196</a> <em>     * </em>
<a name="197" href="#197">197</a> <em>     * @param name</em>
<a name="198" href="#198">198</a> <em>     *            is the name of the attribute whose value is to be added or</em>
<a name="199" href="#199">199</a> <em>     *            updated</em>
<a name="200" href="#200">200</a> <em>     * @param value</em>
<a name="201" href="#201">201</a> <em>     *            is the attribute's value</em>
<a name="202" href="#202">202</a> <em>     * </em>
<a name="203" href="#203">203</a> <em>     * @return this &lt;code>Element&lt;/code> instance.</em>
<a name="204" href="#204">204</a> <em>     */</em>
<a name="205" href="#205">205</a>     <a href="../../org/dom4j/Element.html">Element</a> addAttribute(String name, String value);
<a name="206" href="#206">206</a> 
<a name="207" href="#207">207</a>     <em>/**<em>*</em></em>
<a name="208" href="#208">208</a> <em>     * &lt;p></em>
<a name="209" href="#209">209</a> <em>     * Adds the attribute value of the given fully qualified name. If an</em>
<a name="210" href="#210">210</a> <em>     * attribute already exists for the given name it will be replaced.</em>
<a name="211" href="#211">211</a> <em>     * Attributes with null values are silently ignored. If the value of the</em>
<a name="212" href="#212">212</a> <em>     * attribute is null then this method call will remove any attributes with</em>
<a name="213" href="#213">213</a> <em>     * the given name.</em>
<a name="214" href="#214">214</a> <em>     * &lt;/p></em>
<a name="215" href="#215">215</a> <em>     * </em>
<a name="216" href="#216">216</a> <em>     * @param qName</em>
<a name="217" href="#217">217</a> <em>     *            is the fully qualified name of the attribute whose value is to</em>
<a name="218" href="#218">218</a> <em>     *            be added or updated</em>
<a name="219" href="#219">219</a> <em>     * @param value</em>
<a name="220" href="#220">220</a> <em>     *            is the attribute's value</em>
<a name="221" href="#221">221</a> <em>     * </em>
<a name="222" href="#222">222</a> <em>     * @return this &lt;code>Element&lt;/code> instance.</em>
<a name="223" href="#223">223</a> <em>     */</em>
<a name="224" href="#224">224</a>     <a href="../../org/dom4j/Element.html">Element</a> addAttribute(<a href="../../org/dom4j/QName.html">QName</a> qName, String value);
<a name="225" href="#225">225</a> 
<a name="226" href="#226">226</a>     <em>/**<em>*</em></em>
<a name="227" href="#227">227</a> <em>     * Adds a new &lt;code>Comment&lt;/code> node with the given text to this</em>
<a name="228" href="#228">228</a> <em>     * element.</em>
<a name="229" href="#229">229</a> <em>     * </em>
<a name="230" href="#230">230</a> <em>     * @param comment</em>
<a name="231" href="#231">231</a> <em>     *            is the text for the &lt;code>Comment&lt;/code> node.</em>
<a name="232" href="#232">232</a> <em>     * </em>
<a name="233" href="#233">233</a> <em>     * @return this &lt;code>Element&lt;/code> instance.</em>
<a name="234" href="#234">234</a> <em>     */</em>
<a name="235" href="#235">235</a>     <a href="../../org/dom4j/Element.html">Element</a> addComment(String comment);
<a name="236" href="#236">236</a> 
<a name="237" href="#237">237</a>     <em>/**<em>*</em></em>
<a name="238" href="#238">238</a> <em>     * Adds a new &lt;code>CDATA&lt;/code> node with the given text to this element.</em>
<a name="239" href="#239">239</a> <em>     * </em>
<a name="240" href="#240">240</a> <em>     * @param cdata</em>
<a name="241" href="#241">241</a> <em>     *            is the text for the &lt;code>CDATA&lt;/code> node.</em>
<a name="242" href="#242">242</a> <em>     * </em>
<a name="243" href="#243">243</a> <em>     * @return this &lt;code>Element&lt;/code> instance.</em>
<a name="244" href="#244">244</a> <em>     */</em>
<a name="245" href="#245">245</a>     <a href="../../org/dom4j/Element.html">Element</a> addCDATA(String cdata);
<a name="246" href="#246">246</a> 
<a name="247" href="#247">247</a>     <em>/**<em>*</em></em>
<a name="248" href="#248">248</a> <em>     * Adds a new &lt;code>Entity&lt;/code> node with the given name and text to</em>
<a name="249" href="#249">249</a> <em>     * this element and returns a reference to the new node.</em>
<a name="250" href="#250">250</a> <em>     * </em>
<a name="251" href="#251">251</a> <em>     * @param name</em>
<a name="252" href="#252">252</a> <em>     *            is the name for the &lt;code>Entity&lt;/code> node.</em>
<a name="253" href="#253">253</a> <em>     * @param text</em>
<a name="254" href="#254">254</a> <em>     *            is the text for the &lt;code>Entity&lt;/code> node.</em>
<a name="255" href="#255">255</a> <em>     * </em>
<a name="256" href="#256">256</a> <em>     * @return this &lt;code>Element&lt;/code> instance.</em>
<a name="257" href="#257">257</a> <em>     */</em>
<a name="258" href="#258">258</a>     <a href="../../org/dom4j/Element.html">Element</a> addEntity(String name, String text);
<a name="259" href="#259">259</a> 
<a name="260" href="#260">260</a>     <em>/**<em>*</em></em>
<a name="261" href="#261">261</a> <em>     * Adds a namespace to this element for use by its child content</em>
<a name="262" href="#262">262</a> <em>     * </em>
<a name="263" href="#263">263</a> <em>     * @param prefix</em>
<a name="264" href="#264">264</a> <em>     *            is the prefix to use, which should not be null or blank</em>
<a name="265" href="#265">265</a> <em>     * @param uri</em>
<a name="266" href="#266">266</a> <em>     *            is the namespace URI</em>
<a name="267" href="#267">267</a> <em>     * </em>
<a name="268" href="#268">268</a> <em>     * @return this &lt;code>Element&lt;/code> instance.</em>
<a name="269" href="#269">269</a> <em>     */</em>
<a name="270" href="#270">270</a>     <a href="../../org/dom4j/Element.html">Element</a> addNamespace(String prefix, String uri);
<a name="271" href="#271">271</a> 
<a name="272" href="#272">272</a>     <em>/**<em>*</em></em>
<a name="273" href="#273">273</a> <em>     * Adds a processing instruction for the given target</em>
<a name="274" href="#274">274</a> <em>     * </em>
<a name="275" href="#275">275</a> <em>     * @param target</em>
<a name="276" href="#276">276</a> <em>     *            is the target of the processing instruction</em>
<a name="277" href="#277">277</a> <em>     * @param text</em>
<a name="278" href="#278">278</a> <em>     *            is the textual data (key/value pairs) of the processing</em>
<a name="279" href="#279">279</a> <em>     *            instruction</em>
<a name="280" href="#280">280</a> <em>     * </em>
<a name="281" href="#281">281</a> <em>     * @return this &lt;code>Element&lt;/code> instance.</em>
<a name="282" href="#282">282</a> <em>     */</em>
<a name="283" href="#283">283</a>     <a href="../../org/dom4j/Element.html">Element</a> addProcessingInstruction(String target, String text);
<a name="284" href="#284">284</a> 
<a name="285" href="#285">285</a>     <em>/**<em>*</em></em>
<a name="286" href="#286">286</a> <em>     * Adds a processing instruction for the given target</em>
<a name="287" href="#287">287</a> <em>     * </em>
<a name="288" href="#288">288</a> <em>     * @param target</em>
<a name="289" href="#289">289</a> <em>     *            is the target of the processing instruction</em>
<a name="290" href="#290">290</a> <em>     * @param data</em>
<a name="291" href="#291">291</a> <em>     *            is a Map of the key / value pairs of the processing</em>
<a name="292" href="#292">292</a> <em>     *            instruction</em>
<a name="293" href="#293">293</a> <em>     * </em>
<a name="294" href="#294">294</a> <em>     * @return this &lt;code>Element&lt;/code> instance.</em>
<a name="295" href="#295">295</a> <em>     */</em>
<a name="296" href="#296">296</a>     <a href="../../org/dom4j/Element.html">Element</a> addProcessingInstruction(String target, Map data);
<a name="297" href="#297">297</a> 
<a name="298" href="#298">298</a>     <em>/**<em>*</em></em>
<a name="299" href="#299">299</a> <em>     * Adds a new &lt;code>Text&lt;/code> node with the given text to this element.</em>
<a name="300" href="#300">300</a> <em>     * </em>
<a name="301" href="#301">301</a> <em>     * @param text</em>
<a name="302" href="#302">302</a> <em>     *            is the text for the &lt;code>Text&lt;/code> node.</em>
<a name="303" href="#303">303</a> <em>     * </em>
<a name="304" href="#304">304</a> <em>     * @return this &lt;code>Element&lt;/code> instance.</em>
<a name="305" href="#305">305</a> <em>     */</em>
<a name="306" href="#306">306</a>     <a href="../../org/dom4j/Element.html">Element</a> addText(String text);
<a name="307" href="#307">307</a> 
<a name="308" href="#308">308</a>     <em class="comment">// Typesafe modifying methods</em>
<a name="309" href="#309">309</a>     <em class="comment">// -------------------------------------------------------------------------</em>
<a name="310" href="#310">310</a> 
<a name="311" href="#311">311</a>     <em>/**<em>*</em></em>
<a name="312" href="#312">312</a> <em>     * Adds the given &lt;code>Attribute&lt;/code> to this element. If the given</em>
<a name="313" href="#313">313</a> <em>     * node already has a parent defined then an</em>
<a name="314" href="#314">314</a> <em>     * &lt;code>IllegalAddException&lt;/code> will be thrown. Attributes with null</em>
<a name="315" href="#315">315</a> <em>     * values are silently ignored.</em>
<a name="316" href="#316">316</a> <em>     * </em>
<a name="317" href="#317">317</a> <em>     * &lt;p></em>
<a name="318" href="#318">318</a> <em>     * If the value of the attribute is null then this method call will remove</em>
<a name="319" href="#319">319</a> <em>     * any attributes with the QName of this attribute.</em>
<a name="320" href="#320">320</a> <em>     * &lt;/p></em>
<a name="321" href="#321">321</a> <em>     * </em>
<a name="322" href="#322">322</a> <em>     * @param attribute</em>
<a name="323" href="#323">323</a> <em>     *            is the attribute to be added</em>
<a name="324" href="#324">324</a> <em>     */</em>
<a name="325" href="#325">325</a>     <strong>void</strong> add(<a href="../../org/dom4j/Attribute.html">Attribute</a> attribute);
<a name="326" href="#326">326</a> 
<a name="327" href="#327">327</a>     <em>/**<em>*</em></em>
<a name="328" href="#328">328</a> <em>     * Adds the given &lt;code>CDATA&lt;/code> to this element. If the given node</em>
<a name="329" href="#329">329</a> <em>     * already has a parent defined then an &lt;code>IllegalAddException&lt;/code></em>
<a name="330" href="#330">330</a> <em>     * will be thrown.</em>
<a name="331" href="#331">331</a> <em>     * </em>
<a name="332" href="#332">332</a> <em>     * @param cdata</em>
<a name="333" href="#333">333</a> <em>     *            is the CDATA to be added</em>
<a name="334" href="#334">334</a> <em>     */</em>
<a name="335" href="#335">335</a>     <strong>void</strong> add(<a href="../../org/dom4j/CDATA.html">CDATA</a> cdata);
<a name="336" href="#336">336</a> 
<a name="337" href="#337">337</a>     <em>/**<em>*</em></em>
<a name="338" href="#338">338</a> <em>     * Adds the given &lt;code>Entity&lt;/code> to this element. If the given node</em>
<a name="339" href="#339">339</a> <em>     * already has a parent defined then an &lt;code>IllegalAddException&lt;/code></em>
<a name="340" href="#340">340</a> <em>     * will be thrown.</em>
<a name="341" href="#341">341</a> <em>     * </em>
<a name="342" href="#342">342</a> <em>     * @param entity</em>
<a name="343" href="#343">343</a> <em>     *            is the entity to be added</em>
<a name="344" href="#344">344</a> <em>     */</em>
<a name="345" href="#345">345</a>     <strong>void</strong> add(<a href="../../org/dom4j/Entity.html">Entity</a> entity);
<a name="346" href="#346">346</a> 
<a name="347" href="#347">347</a>     <em>/**<em>*</em></em>
<a name="348" href="#348">348</a> <em>     * Adds the given &lt;code>Text&lt;/code> to this element. If the given node</em>
<a name="349" href="#349">349</a> <em>     * already has a parent defined then an &lt;code>IllegalAddException&lt;/code></em>
<a name="350" href="#350">350</a> <em>     * will be thrown.</em>
<a name="351" href="#351">351</a> <em>     * </em>
<a name="352" href="#352">352</a> <em>     * @param text</em>
<a name="353" href="#353">353</a> <em>     *            is the text to be added</em>
<a name="354" href="#354">354</a> <em>     */</em>
<a name="355" href="#355">355</a>     <strong>void</strong> add(<a href="../../org/dom4j/Text.html">Text</a> text);
<a name="356" href="#356">356</a> 
<a name="357" href="#357">357</a>     <em>/**<em>*</em></em>
<a name="358" href="#358">358</a> <em>     * Adds the given &lt;code>Namespace&lt;/code> to this element. If the given</em>
<a name="359" href="#359">359</a> <em>     * node already has a parent defined then an</em>
<a name="360" href="#360">360</a> <em>     * &lt;code>IllegalAddException&lt;/code> will be thrown.</em>
<a name="361" href="#361">361</a> <em>     * </em>
<a name="362" href="#362">362</a> <em>     * @param namespace</em>
<a name="363" href="#363">363</a> <em>     *            is the namespace to be added</em>
<a name="364" href="#364">364</a> <em>     */</em>
<a name="365" href="#365">365</a>     <strong>void</strong> add(<a href="../../org/dom4j/Namespace.html">Namespace</a> namespace);
<a name="366" href="#366">366</a> 
<a name="367" href="#367">367</a>     <em>/**<em>*</em></em>
<a name="368" href="#368">368</a> <em>     * Removes the given &lt;code>Attribute&lt;/code> from this element.</em>
<a name="369" href="#369">369</a> <em>     * </em>
<a name="370" href="#370">370</a> <em>     * @param attribute</em>
<a name="371" href="#371">371</a> <em>     *            is the attribute to be removed</em>
<a name="372" href="#372">372</a> <em>     * </em>
<a name="373" href="#373">373</a> <em>     * @return true if the attribute was removed</em>
<a name="374" href="#374">374</a> <em>     */</em>
<a name="375" href="#375">375</a>     <strong>boolean</strong> remove(<a href="../../org/dom4j/Attribute.html">Attribute</a> attribute);
<a name="376" href="#376">376</a> 
<a name="377" href="#377">377</a>     <em>/**<em>*</em></em>
<a name="378" href="#378">378</a> <em>     * Removes the given &lt;code>CDATA&lt;/code> if the node is an immediate child</em>
<a name="379" href="#379">379</a> <em>     * of this element. If the given node is not an immediate child of this</em>
<a name="380" href="#380">380</a> <em>     * element then the {@link Node#detach()}method should be used instead.</em>
<a name="381" href="#381">381</a> <em>     * </em>
<a name="382" href="#382">382</a> <em>     * @param cdata</em>
<a name="383" href="#383">383</a> <em>     *            is the CDATA to be removed</em>
<a name="384" href="#384">384</a> <em>     * </em>
<a name="385" href="#385">385</a> <em>     * @return true if the cdata was removed</em>
<a name="386" href="#386">386</a> <em>     */</em>
<a name="387" href="#387">387</a>     <strong>boolean</strong> remove(<a href="../../org/dom4j/CDATA.html">CDATA</a> cdata);
<a name="388" href="#388">388</a> 
<a name="389" href="#389">389</a>     <em>/**<em>*</em></em>
<a name="390" href="#390">390</a> <em>     * Removes the given &lt;code>Entity&lt;/code> if the node is an immediate child</em>
<a name="391" href="#391">391</a> <em>     * of this element. If the given node is not an immediate child of this</em>
<a name="392" href="#392">392</a> <em>     * element then the {@link Node#detach()}method should be used instead.</em>
<a name="393" href="#393">393</a> <em>     * </em>
<a name="394" href="#394">394</a> <em>     * @param entity</em>
<a name="395" href="#395">395</a> <em>     *            is the entity to be removed</em>
<a name="396" href="#396">396</a> <em>     * </em>
<a name="397" href="#397">397</a> <em>     * @return true if the entity was removed</em>
<a name="398" href="#398">398</a> <em>     */</em>
<a name="399" href="#399">399</a>     <strong>boolean</strong> remove(<a href="../../org/dom4j/Entity.html">Entity</a> entity);
<a name="400" href="#400">400</a> 
<a name="401" href="#401">401</a>     <em>/**<em>*</em></em>
<a name="402" href="#402">402</a> <em>     * Removes the given &lt;code>Namespace&lt;/code> if the node is an immediate</em>
<a name="403" href="#403">403</a> <em>     * child of this element. If the given node is not an immediate child of</em>
<a name="404" href="#404">404</a> <em>     * this element then the {@link Node#detach()}method should be used</em>
<a name="405" href="#405">405</a> <em>     * instead.</em>
<a name="406" href="#406">406</a> <em>     * </em>
<a name="407" href="#407">407</a> <em>     * @param namespace</em>
<a name="408" href="#408">408</a> <em>     *            is the namespace to be removed</em>
<a name="409" href="#409">409</a> <em>     * </em>
<a name="410" href="#410">410</a> <em>     * @return true if the namespace was removed</em>
<a name="411" href="#411">411</a> <em>     */</em>
<a name="412" href="#412">412</a>     <strong>boolean</strong> remove(<a href="../../org/dom4j/Namespace.html">Namespace</a> namespace);
<a name="413" href="#413">413</a> 
<a name="414" href="#414">414</a>     <em>/**<em>*</em></em>
<a name="415" href="#415">415</a> <em>     * Removes the given &lt;code>Text&lt;/code> if the node is an immediate child</em>
<a name="416" href="#416">416</a> <em>     * of this element. If the given node is not an immediate child of this</em>
<a name="417" href="#417">417</a> <em>     * element then the {@link Node#detach()}method should be used instead.</em>
<a name="418" href="#418">418</a> <em>     * </em>
<a name="419" href="#419">419</a> <em>     * @param text</em>
<a name="420" href="#420">420</a> <em>     *            is the text to be removed</em>
<a name="421" href="#421">421</a> <em>     * </em>
<a name="422" href="#422">422</a> <em>     * @return true if the text was removed</em>
<a name="423" href="#423">423</a> <em>     */</em>
<a name="424" href="#424">424</a>     <strong>boolean</strong> remove(<a href="../../org/dom4j/Text.html">Text</a> text);
<a name="425" href="#425">425</a> 
<a name="426" href="#426">426</a>     <em class="comment">// Text methods</em>
<a name="427" href="#427">427</a>     <em class="comment">// -------------------------------------------------------------------------</em>
<a name="428" href="#428">428</a> 
<a name="429" href="#429">429</a>     <em>/**<em>*</em></em>
<a name="430" href="#430">430</a> <em>     * Returns the text value of this element without recursing through child</em>
<a name="431" href="#431">431</a> <em>     * elements. This method iterates through all {@link Text},{@link CDATA}</em>
<a name="432" href="#432">432</a> <em>     * and {@link Entity}nodes that this element contains and appends the text</em>
<a name="433" href="#433">433</a> <em>     * values together.</em>
<a name="434" href="#434">434</a> <em>     * </em>
<a name="435" href="#435">435</a> <em>     * @return the textual content of this Element. Child elements are not</em>
<a name="436" href="#436">436</a> <em>     *         navigated. This method does not return null;</em>
<a name="437" href="#437">437</a> <em>     */</em>
<a name="438" href="#438">438</a>     String getText();
<a name="439" href="#439">439</a> 
<a name="440" href="#440">440</a>     <em>/**<em>*</em></em>
<a name="441" href="#441">441</a> <em>     * DOCUMENT ME!</em>
<a name="442" href="#442">442</a> <em>     * </em>
<a name="443" href="#443">443</a> <em>     * @return the trimmed text value where whitespace is trimmed and normalised</em>
<a name="444" href="#444">444</a> <em>     *         into single spaces. This method does not return null.</em>
<a name="445" href="#445">445</a> <em>     */</em>
<a name="446" href="#446">446</a>     String getTextTrim();
<a name="447" href="#447">447</a> 
<a name="448" href="#448">448</a>     <em>/**<em>*</em></em>
<a name="449" href="#449">449</a> <em>     * Returns the XPath string-value of this node. The behaviour of this method</em>
<a name="450" href="#450">450</a> <em>     * is defined in the &lt;a href="<a href="http://www.w3.org/TR/xpath" target="alexandria_uri">http://www.w3.org/TR/xpath</a>">XPath</em>
<a name="451" href="#451">451</a> <em>     * specification &lt;/a>. This method returns the string-value of all the</em>
<a name="452" href="#452">452</a> <em>     * contained {@link Text},{@link CDATA},{@link Entity}and {@link</em>
<a name="453" href="#453">453</a> <em>     * Element} nodes all appended together.</em>
<a name="454" href="#454">454</a> <em>     * </em>
<a name="455" href="#455">455</a> <em>     * @return the text from all the child Text and Element nodes appended</em>
<a name="456" href="#456">456</a> <em>     *         together.</em>
<a name="457" href="#457">457</a> <em>     */</em>
<a name="458" href="#458">458</a>     String getStringValue();
<a name="459" href="#459">459</a> 
<a name="460" href="#460">460</a>     <em>/**<em>*</em></em>
<a name="461" href="#461">461</a> <em>     * Accesses the data of this element which may implement data typing</em>
<a name="462" href="#462">462</a> <em>     * bindings such as XML Schema or Java Bean bindings or will return the same</em>
<a name="463" href="#463">463</a> <em>     * value as {@link #getText}</em>
<a name="464" href="#464">464</a> <em>     * </em>
<a name="465" href="#465">465</a> <em>     * @return DOCUMENT ME!</em>
<a name="466" href="#466">466</a> <em>     */</em>
<a name="467" href="#467">467</a>     Object getData();
<a name="468" href="#468">468</a> 
<a name="469" href="#469">469</a>     <em>/**<em>*</em></em>
<a name="470" href="#470">470</a> <em>     * Sets the data value of this element if this element supports data binding</em>
<a name="471" href="#471">471</a> <em>     * or calls {@link #setText}if it doesn't</em>
<a name="472" href="#472">472</a> <em>     * </em>
<a name="473" href="#473">473</a> <em>     * @param data</em>
<a name="474" href="#474">474</a> <em>     *            DOCUMENT ME!</em>
<a name="475" href="#475">475</a> <em>     */</em>
<a name="476" href="#476">476</a>     <strong>void</strong> setData(Object data);
<a name="477" href="#477">477</a> 
<a name="478" href="#478">478</a>     <em class="comment">// Attribute methods</em>
<a name="479" href="#479">479</a>     <em class="comment">// -------------------------------------------------------------------------</em>
<a name="480" href="#480">480</a> 
<a name="481" href="#481">481</a>     <em>/**<em>*</em></em>
<a name="482" href="#482">482</a> <em>     * &lt;p></em>
<a name="483" href="#483">483</a> <em>     * Returns the {@link Attribute}instances this element contains as a backed</em>
<a name="484" href="#484">484</a> <em>     * {@link List}so that the attributes may be modified directly using the</em>
<a name="485" href="#485">485</a> <em>     * {@link List}interface. The &lt;code>List&lt;/code> is backed by the</em>
<a name="486" href="#486">486</a> <em>     * &lt;code>Element&lt;/code> so that changes to the list are reflected in the</em>
<a name="487" href="#487">487</a> <em>     * element and vice versa.</em>
<a name="488" href="#488">488</a> <em>     * &lt;/p></em>
<a name="489" href="#489">489</a> <em>     * </em>
<a name="490" href="#490">490</a> <em>     * @return the attributes that this element contains as a &lt;code>List&lt;/code></em>
<a name="491" href="#491">491</a> <em>     */</em>
<a name="492" href="#492">492</a>     List attributes();
<a name="493" href="#493">493</a> 
<a name="494" href="#494">494</a>     <em>/**<em>*</em></em>
<a name="495" href="#495">495</a> <em>     * Sets the attributes that this element contains</em>
<a name="496" href="#496">496</a> <em>     * </em>
<a name="497" href="#497">497</a> <em>     * @param attributes</em>
<a name="498" href="#498">498</a> <em>     *            DOCUMENT ME!</em>
<a name="499" href="#499">499</a> <em>     */</em>
<a name="500" href="#500">500</a>     <strong>void</strong> setAttributes(List attributes);
<a name="501" href="#501">501</a> 
<a name="502" href="#502">502</a>     <em>/**<em>*</em></em>
<a name="503" href="#503">503</a> <em>     * DOCUMENT ME!</em>
<a name="504" href="#504">504</a> <em>     * </em>
<a name="505" href="#505">505</a> <em>     * @return the number of attributes this element contains</em>
<a name="506" href="#506">506</a> <em>     */</em>
<a name="507" href="#507">507</a>     <strong>int</strong> attributeCount();
<a name="508" href="#508">508</a> 
<a name="509" href="#509">509</a>     <em>/**<em>*</em></em>
<a name="510" href="#510">510</a> <em>     * DOCUMENT ME!</em>
<a name="511" href="#511">511</a> <em>     * </em>
<a name="512" href="#512">512</a> <em>     * @return an iterator over the attributes of this element</em>
<a name="513" href="#513">513</a> <em>     */</em>
<a name="514" href="#514">514</a>     Iterator attributeIterator();
<a name="515" href="#515">515</a> 
<a name="516" href="#516">516</a>     <em>/**<em>*</em></em>
<a name="517" href="#517">517</a> <em>     * Returns the attribute at the specified indexGets the</em>
<a name="518" href="#518">518</a> <em>     * </em>
<a name="519" href="#519">519</a> <em>     * @param index</em>
<a name="520" href="#520">520</a> <em>     *            DOCUMENT ME!</em>
<a name="521" href="#521">521</a> <em>     * </em>
<a name="522" href="#522">522</a> <em>     * @return the attribute at the specified index where index &amp;gt;= 0 and</em>
<a name="523" href="#523">523</a> <em>     *         index &amp;lt; number of attributes or throws an</em>
<a name="524" href="#524">524</a> <em>     *         IndexOutOfBoundsException if the index is not within the</em>
<a name="525" href="#525">525</a> <em>     *         allowable range</em>
<a name="526" href="#526">526</a> <em>     */</em>
<a name="527" href="#527">527</a>     <a href="../../org/dom4j/Attribute.html">Attribute</a> attribute(<strong>int</strong> index);
<a name="528" href="#528">528</a> 
<a name="529" href="#529">529</a>     <em>/**<em>*</em></em>
<a name="530" href="#530">530</a> <em>     * Returns the attribute with the given name</em>
<a name="531" href="#531">531</a> <em>     * </em>
<a name="532" href="#532">532</a> <em>     * @param name</em>
<a name="533" href="#533">533</a> <em>     *            DOCUMENT ME!</em>
<a name="534" href="#534">534</a> <em>     * </em>
<a name="535" href="#535">535</a> <em>     * @return the attribute for the given local name in any namespace. If there</em>
<a name="536" href="#536">536</a> <em>     *         are more than one attributes with the given local name in</em>
<a name="537" href="#537">537</a> <em>     *         different namespaces then the first one is returned.</em>
<a name="538" href="#538">538</a> <em>     */</em>
<a name="539" href="#539">539</a>     <a href="../../org/dom4j/Attribute.html">Attribute</a> attribute(String name);
<a name="540" href="#540">540</a> 
<a name="541" href="#541">541</a>     <em>/**<em>*</em></em>
<a name="542" href="#542">542</a> <em>     * DOCUMENT ME!</em>
<a name="543" href="#543">543</a> <em>     * </em>
<a name="544" href="#544">544</a> <em>     * @param qName</em>
<a name="545" href="#545">545</a> <em>     *            is the fully qualified name</em>
<a name="546" href="#546">546</a> <em>     * </em>
<a name="547" href="#547">547</a> <em>     * @return the attribute for the given fully qualified name or null if it</em>
<a name="548" href="#548">548</a> <em>     *         could not be found.</em>
<a name="549" href="#549">549</a> <em>     */</em>
<a name="550" href="#550">550</a>     <a href="../../org/dom4j/Attribute.html">Attribute</a> attribute(<a href="../../org/dom4j/QName.html">QName</a> qName);
<a name="551" href="#551">551</a> 
<a name="552" href="#552">552</a>     <em>/**<em>*</em></em>
<a name="553" href="#553">553</a> <em>     * &lt;p></em>
<a name="554" href="#554">554</a> <em>     * This returns the attribute value for the attribute with the given name</em>
<a name="555" href="#555">555</a> <em>     * and any namespace or null if there is no such attribute or the empty</em>
<a name="556" href="#556">556</a> <em>     * string if the attribute value is empty.</em>
<a name="557" href="#557">557</a> <em>     * &lt;/p></em>
<a name="558" href="#558">558</a> <em>     * </em>
<a name="559" href="#559">559</a> <em>     * @param name</em>
<a name="560" href="#560">560</a> <em>     *            is the name of the attribute value to be returnd</em>
<a name="561" href="#561">561</a> <em>     * </em>
<a name="562" href="#562">562</a> <em>     * @return the value of the attribute, null if the attribute does not exist</em>
<a name="563" href="#563">563</a> <em>     *         or the empty string</em>
<a name="564" href="#564">564</a> <em>     */</em>
<a name="565" href="#565">565</a>     String attributeValue(String name);
<a name="566" href="#566">566</a> 
<a name="567" href="#567">567</a>     <em>/**<em>*</em></em>
<a name="568" href="#568">568</a> <em>     * &lt;p></em>
<a name="569" href="#569">569</a> <em>     * This returns the attribute value for the attribute with the given name</em>
<a name="570" href="#570">570</a> <em>     * and any namespace or the default value if there is no such attribute</em>
<a name="571" href="#571">571</a> <em>     * value.</em>
<a name="572" href="#572">572</a> <em>     * &lt;/p></em>
<a name="573" href="#573">573</a> <em>     * </em>
<a name="574" href="#574">574</a> <em>     * @param name</em>
<a name="575" href="#575">575</a> <em>     *            is the name of the attribute value to be returnd</em>
<a name="576" href="#576">576</a> <em>     * @param defaultValue</em>
<a name="577" href="#577">577</a> <em>     *            is the default value to be returned if the attribute has no</em>
<a name="578" href="#578">578</a> <em>     *            value defined.</em>
<a name="579" href="#579">579</a> <em>     * </em>
<a name="580" href="#580">580</a> <em>     * @return the value of the attribute or the defaultValue if the attribute</em>
<a name="581" href="#581">581</a> <em>     *         has no value defined.</em>
<a name="582" href="#582">582</a> <em>     */</em>
<a name="583" href="#583">583</a>     String attributeValue(String name, String defaultValue);
<a name="584" href="#584">584</a> 
<a name="585" href="#585">585</a>     <em>/**<em>*</em></em>
<a name="586" href="#586">586</a> <em>     * &lt;p></em>
<a name="587" href="#587">587</a> <em>     * This returns the attribute value for the attribute with the given fully</em>
<a name="588" href="#588">588</a> <em>     * qualified name or null if there is no such attribute or the empty string</em>
<a name="589" href="#589">589</a> <em>     * if the attribute value is empty.</em>
<a name="590" href="#590">590</a> <em>     * &lt;/p></em>
<a name="591" href="#591">591</a> <em>     * </em>
<a name="592" href="#592">592</a> <em>     * @param qName</em>
<a name="593" href="#593">593</a> <em>     *            is the fully qualified name</em>
<a name="594" href="#594">594</a> <em>     * </em>
<a name="595" href="#595">595</a> <em>     * @return the value of the attribute, null if the attribute does not exist</em>
<a name="596" href="#596">596</a> <em>     *         or the empty string</em>
<a name="597" href="#597">597</a> <em>     */</em>
<a name="598" href="#598">598</a>     String attributeValue(<a href="../../org/dom4j/QName.html">QName</a> qName);
<a name="599" href="#599">599</a> 
<a name="600" href="#600">600</a>     <em>/**<em>*</em></em>
<a name="601" href="#601">601</a> <em>     * &lt;p></em>
<a name="602" href="#602">602</a> <em>     * This returns the attribute value for the attribute with the given fully</em>
<a name="603" href="#603">603</a> <em>     * qualified name or the default value if there is no such attribute value.</em>
<a name="604" href="#604">604</a> <em>     * &lt;/p></em>
<a name="605" href="#605">605</a> <em>     * </em>
<a name="606" href="#606">606</a> <em>     * @param qName</em>
<a name="607" href="#607">607</a> <em>     *            is the fully qualified name</em>
<a name="608" href="#608">608</a> <em>     * @param defaultValue</em>
<a name="609" href="#609">609</a> <em>     *            is the default value to be returned if the attribute has no</em>
<a name="610" href="#610">610</a> <em>     *            value defined.</em>
<a name="611" href="#611">611</a> <em>     * </em>
<a name="612" href="#612">612</a> <em>     * @return the value of the attribute or the defaultValue if the attribute</em>
<a name="613" href="#613">613</a> <em>     *         has no value defined.</em>
<a name="614" href="#614">614</a> <em>     */</em>
<a name="615" href="#615">615</a>     String attributeValue(<a href="../../org/dom4j/QName.html">QName</a> qName, String defaultValue);
<a name="616" href="#616">616</a> 
<a name="617" href="#617">617</a>     <em>/**<em>*</em></em>
<a name="618" href="#618">618</a> <em>     * &lt;p></em>
<a name="619" href="#619">619</a> <em>     * Sets the attribute value of the given local name.</em>
<a name="620" href="#620">620</a> <em>     * &lt;/p></em>
<a name="621" href="#621">621</a> <em>     * </em>
<a name="622" href="#622">622</a> <em>     * @param name</em>
<a name="623" href="#623">623</a> <em>     *            is the name of the attribute whose value is to be added or</em>
<a name="624" href="#624">624</a> <em>     *            updated</em>
<a name="625" href="#625">625</a> <em>     * @param value</em>
<a name="626" href="#626">626</a> <em>     *            is the attribute's value</em>
<a name="627" href="#627">627</a> <em>     * </em>
<a name="628" href="#628">628</a> <em>     * @deprecated As of version 0.5. Please use {@link</em>
<a name="629" href="#629">629</a> <em>     *             #addAttribute(String,String)} instead. WILL BE REMOVED IN</em>
<a name="630" href="#630">630</a> <em>     *             dom4j-1.6 !!</em>
<a name="631" href="#631">631</a> <em>     */</em>
<a name="632" href="#632">632</a>     <strong>void</strong> setAttributeValue(String name, String value);
<a name="633" href="#633">633</a> 
<a name="634" href="#634">634</a>     <em>/**<em>*</em></em>
<a name="635" href="#635">635</a> <em>     * &lt;p></em>
<a name="636" href="#636">636</a> <em>     * Sets the attribute value of the given fully qualified name.</em>
<a name="637" href="#637">637</a> <em>     * &lt;/p></em>
<a name="638" href="#638">638</a> <em>     * </em>
<a name="639" href="#639">639</a> <em>     * @param qName</em>
<a name="640" href="#640">640</a> <em>     *            is the fully qualified name of the attribute whose value is to</em>
<a name="641" href="#641">641</a> <em>     *            be added or updated</em>
<a name="642" href="#642">642</a> <em>     * @param value</em>
<a name="643" href="#643">643</a> <em>     *            is the attribute's value</em>
<a name="644" href="#644">644</a> <em>     * </em>
<a name="645" href="#645">645</a> <em>     * @deprecated As of version 0.5. Please use {@link</em>
<a name="646" href="#646">646</a> <em>     *             #addAttribute(QName,String)} instead. WILL BE REMOVED IN</em>
<a name="647" href="#647">647</a> <em>     *             dom4j-1.6 !!</em>
<a name="648" href="#648">648</a> <em>     */</em>
<a name="649" href="#649">649</a>     <strong>void</strong> setAttributeValue(<a href="../../org/dom4j/QName.html">QName</a> qName, String value);
<a name="650" href="#650">650</a> 
<a name="651" href="#651">651</a>     <em class="comment">// Content methods</em>
<a name="652" href="#652">652</a>     <em class="comment">// -------------------------------------------------------------------------</em>
<a name="653" href="#653">653</a> 
<a name="654" href="#654">654</a>     <em>/**<em>*</em></em>
<a name="655" href="#655">655</a> <em>     * Returns the first element for the given local name and any namespace.</em>
<a name="656" href="#656">656</a> <em>     * </em>
<a name="657" href="#657">657</a> <em>     * @param name</em>
<a name="658" href="#658">658</a> <em>     *            DOCUMENT ME!</em>
<a name="659" href="#659">659</a> <em>     * </em>
<a name="660" href="#660">660</a> <em>     * @return the first element with the given local name</em>
<a name="661" href="#661">661</a> <em>     */</em>
<a name="662" href="#662">662</a>     <a href="../../org/dom4j/Element.html">Element</a> element(String name);
<a name="663" href="#663">663</a> 
<a name="664" href="#664">664</a>     <em>/**<em>*</em></em>
<a name="665" href="#665">665</a> <em>     * Returns the first element for the given fully qualified name.</em>
<a name="666" href="#666">666</a> <em>     * </em>
<a name="667" href="#667">667</a> <em>     * @param qName</em>
<a name="668" href="#668">668</a> <em>     *            is the fully qualified name to search for</em>
<a name="669" href="#669">669</a> <em>     * </em>
<a name="670" href="#670">670</a> <em>     * @return the first element with the given fully qualified name</em>
<a name="671" href="#671">671</a> <em>     */</em>
<a name="672" href="#672">672</a>     <a href="../../org/dom4j/Element.html">Element</a> element(<a href="../../org/dom4j/QName.html">QName</a> qName);
<a name="673" href="#673">673</a> 
<a name="674" href="#674">674</a>     <em>/**<em>*</em></em>
<a name="675" href="#675">675</a> <em>     * &lt;p></em>
<a name="676" href="#676">676</a> <em>     * Returns the elements contained in this element. If this element does not</em>
<a name="677" href="#677">677</a> <em>     * contain any elements then this method returns an empty list. The list is</em>
<a name="678" href="#678">678</a> <em>     * backed by the element such that changes to the list will be reflected in</em>
<a name="679" href="#679">679</a> <em>     * the element though the reverse is not the case.</em>
<a name="680" href="#680">680</a> <em>     * &lt;/p></em>
<a name="681" href="#681">681</a> <em>     * </em>
<a name="682" href="#682">682</a> <em>     * @return a list of all the elements in this element.</em>
<a name="683" href="#683">683</a> <em>     */</em>
<a name="684" href="#684">684</a>     List elements();
<a name="685" href="#685">685</a> 
<a name="686" href="#686">686</a>     <em>/**<em>*</em></em>
<a name="687" href="#687">687</a> <em>     * &lt;p></em>
<a name="688" href="#688">688</a> <em>     * Returns the elements contained in this element with the given local name</em>
<a name="689" href="#689">689</a> <em>     * and any namespace. If no elements are found then this method returns an</em>
<a name="690" href="#690">690</a> <em>     * empty list. The list is backed by the element such that changes to the</em>
<a name="691" href="#691">691</a> <em>     * list will be reflected in the element though the reverse is not the case.</em>
<a name="692" href="#692">692</a> <em>     * &lt;/p></em>
<a name="693" href="#693">693</a> <em>     * </em>
<a name="694" href="#694">694</a> <em>     * @param name</em>
<a name="695" href="#695">695</a> <em>     *            DOCUMENT ME!</em>
<a name="696" href="#696">696</a> <em>     * </em>
<a name="697" href="#697">697</a> <em>     * @return a list of all the elements in this element for the given local</em>
<a name="698" href="#698">698</a> <em>     *         name</em>
<a name="699" href="#699">699</a> <em>     */</em>
<a name="700" href="#700">700</a>     List elements(String name);
<a name="701" href="#701">701</a> 
<a name="702" href="#702">702</a>     <em>/**<em>*</em></em>
<a name="703" href="#703">703</a> <em>     * &lt;p></em>
<a name="704" href="#704">704</a> <em>     * Returns the elements contained in this element with the given fully</em>
<a name="705" href="#705">705</a> <em>     * qualified name. If no elements are found then this method returns an</em>
<a name="706" href="#706">706</a> <em>     * empty list. The list is backed by the element such that changes to the</em>
<a name="707" href="#707">707</a> <em>     * list will be reflected in the element though the reverse is not the case.</em>
<a name="708" href="#708">708</a> <em>     * &lt;/p></em>
<a name="709" href="#709">709</a> <em>     * </em>
<a name="710" href="#710">710</a> <em>     * @param qName</em>
<a name="711" href="#711">711</a> <em>     *            is the fully qualified name to search for</em>
<a name="712" href="#712">712</a> <em>     * </em>
<a name="713" href="#713">713</a> <em>     * @return a list of all the elements in this element for the given fully</em>
<a name="714" href="#714">714</a> <em>     *         qualified name.</em>
<a name="715" href="#715">715</a> <em>     */</em>
<a name="716" href="#716">716</a>     List elements(<a href="../../org/dom4j/QName.html">QName</a> qName);
<a name="717" href="#717">717</a> 
<a name="718" href="#718">718</a>     <em>/**<em>*</em></em>
<a name="719" href="#719">719</a> <em>     * Returns an iterator over all this elements child elements.</em>
<a name="720" href="#720">720</a> <em>     * </em>
<a name="721" href="#721">721</a> <em>     * @return an iterator over the contained elements</em>
<a name="722" href="#722">722</a> <em>     */</em>
<a name="723" href="#723">723</a>     Iterator elementIterator();
<a name="724" href="#724">724</a> 
<a name="725" href="#725">725</a>     <em>/**<em>*</em></em>
<a name="726" href="#726">726</a> <em>     * Returns an iterator over the elements contained in this element which</em>
<a name="727" href="#727">727</a> <em>     * match the given local name and any namespace.</em>
<a name="728" href="#728">728</a> <em>     * </em>
<a name="729" href="#729">729</a> <em>     * @param name</em>
<a name="730" href="#730">730</a> <em>     *            DOCUMENT ME!</em>
<a name="731" href="#731">731</a> <em>     * </em>
<a name="732" href="#732">732</a> <em>     * @return an iterator over the contained elements matching the given local</em>
<a name="733" href="#733">733</a> <em>     *         name</em>
<a name="734" href="#734">734</a> <em>     */</em>
<a name="735" href="#735">735</a>     Iterator elementIterator(String name);
<a name="736" href="#736">736</a> 
<a name="737" href="#737">737</a>     <em>/**<em>*</em></em>
<a name="738" href="#738">738</a> <em>     * Returns an iterator over the elements contained in this element which</em>
<a name="739" href="#739">739</a> <em>     * match the given fully qualified name.</em>
<a name="740" href="#740">740</a> <em>     * </em>
<a name="741" href="#741">741</a> <em>     * @param qName</em>
<a name="742" href="#742">742</a> <em>     *            is the fully qualified name to search for</em>
<a name="743" href="#743">743</a> <em>     * </em>
<a name="744" href="#744">744</a> <em>     * @return an iterator over the contained elements matching the given fully</em>
<a name="745" href="#745">745</a> <em>     *         qualified name</em>
<a name="746" href="#746">746</a> <em>     */</em>
<a name="747" href="#747">747</a>     Iterator elementIterator(<a href="../../org/dom4j/QName.html">QName</a> qName);
<a name="748" href="#748">748</a> 
<a name="749" href="#749">749</a>     <em class="comment">// Helper methods</em>
<a name="750" href="#750">750</a>     <em class="comment">// -------------------------------------------------------------------------</em>
<a name="751" href="#751">751</a> 
<a name="752" href="#752">752</a>     <em>/**<em>*</em></em>
<a name="753" href="#753">753</a> <em>     * DOCUMENT ME!</em>
<a name="754" href="#754">754</a> <em>     * </em>
<a name="755" href="#755">755</a> <em>     * @return true if this element is the root element of a document and this</em>
<a name="756" href="#756">756</a> <em>     *         element supports the parent relationship else false.</em>
<a name="757" href="#757">757</a> <em>     */</em>
<a name="758" href="#758">758</a>     <strong>boolean</strong> isRootElement();
<a name="759" href="#759">759</a> 
<a name="760" href="#760">760</a>     <em>/**<em>*</em></em>
<a name="761" href="#761">761</a> <em>     * &lt;p></em>
<a name="762" href="#762">762</a> <em>     * Returns true if this &lt;code>Element&lt;/code> has mixed content. Mixed</em>
<a name="763" href="#763">763</a> <em>     * content means that an element contains both textual data and child</em>
<a name="764" href="#764">764</a> <em>     * elements.</em>
<a name="765" href="#765">765</a> <em>     * &lt;/p></em>
<a name="766" href="#766">766</a> <em>     * </em>
<a name="767" href="#767">767</a> <em>     * @return true if this element contains mixed content.</em>
<a name="768" href="#768">768</a> <em>     */</em>
<a name="769" href="#769">769</a>     <strong>boolean</strong> hasMixedContent();
<a name="770" href="#770">770</a> 
<a name="771" href="#771">771</a>     <em>/**<em>*</em></em>
<a name="772" href="#772">772</a> <em>     * &lt;p></em>
<a name="773" href="#773">773</a> <em>     * Returns true if this &lt;code>Element&lt;/code> has text only content.</em>
<a name="774" href="#774">774</a> <em>     * &lt;/p></em>
<a name="775" href="#775">775</a> <em>     * </em>
<a name="776" href="#776">776</a> <em>     * @return true if this element is empty or only contains text content.</em>
<a name="777" href="#777">777</a> <em>     */</em>
<a name="778" href="#778">778</a>     <strong>boolean</strong> isTextOnly();
<a name="779" href="#779">779</a> 
<a name="780" href="#780">780</a>     <em>/**<em>*</em></em>
<a name="781" href="#781">781</a> <em>     * Appends the attributes of the given element to me. This method behaves</em>
<a name="782" href="#782">782</a> <em>     * like the {@link java.util.Collection#addAll(java.util.Collection)}</em>
<a name="783" href="#783">783</a> <em>     * method.</em>
<a name="784" href="#784">784</a> <em>     * </em>
<a name="785" href="#785">785</a> <em>     * @param element</em>
<a name="786" href="#786">786</a> <em>     *            is the element whose attributes will be added to me.</em>
<a name="787" href="#787">787</a> <em>     */</em>
<a name="788" href="#788">788</a>     <strong>void</strong> appendAttributes(<a href="../../org/dom4j/Element.html">Element</a> element);
<a name="789" href="#789">789</a> 
<a name="790" href="#790">790</a>     <em>/**<em>*</em></em>
<a name="791" href="#791">791</a> <em>     * &lt;p></em>
<a name="792" href="#792">792</a> <em>     * Creates a deep copy of this element The new element is detached from its</em>
<a name="793" href="#793">793</a> <em>     * parent, and getParent() on the clone will return null.</em>
<a name="794" href="#794">794</a> <em>     * &lt;/p></em>
<a name="795" href="#795">795</a> <em>     * </em>
<a name="796" href="#796">796</a> <em>     * @return a new deep copy Element</em>
<a name="797" href="#797">797</a> <em>     */</em>
<a name="798" href="#798">798</a>     <a href="../../org/dom4j/Element.html">Element</a> createCopy();
<a name="799" href="#799">799</a> 
<a name="800" href="#800">800</a>     <em>/**<em>*</em></em>
<a name="801" href="#801">801</a> <em>     * &lt;p></em>
<a name="802" href="#802">802</a> <em>     * Creates a deep copy of this element with the given local name The new</em>
<a name="803" href="#803">803</a> <em>     * element is detached from its parent, and getParent() on the clone will</em>
<a name="804" href="#804">804</a> <em>     * return null.</em>
<a name="805" href="#805">805</a> <em>     * &lt;/p></em>
<a name="806" href="#806">806</a> <em>     * </em>
<a name="807" href="#807">807</a> <em>     * @param name</em>
<a name="808" href="#808">808</a> <em>     *            DOCUMENT ME!</em>
<a name="809" href="#809">809</a> <em>     * </em>
<a name="810" href="#810">810</a> <em>     * @return a new deep copy Element</em>
<a name="811" href="#811">811</a> <em>     */</em>
<a name="812" href="#812">812</a>     <a href="../../org/dom4j/Element.html">Element</a> createCopy(String name);
<a name="813" href="#813">813</a> 
<a name="814" href="#814">814</a>     <em>/**<em>*</em></em>
<a name="815" href="#815">815</a> <em>     * &lt;p></em>
<a name="816" href="#816">816</a> <em>     * Creates a deep copy of this element with the given fully qualified name.</em>
<a name="817" href="#817">817</a> <em>     * The new element is detached from its parent, and getParent() on the clone</em>
<a name="818" href="#818">818</a> <em>     * will return null.</em>
<a name="819" href="#819">819</a> <em>     * &lt;/p></em>
<a name="820" href="#820">820</a> <em>     * </em>
<a name="821" href="#821">821</a> <em>     * @param qName</em>
<a name="822" href="#822">822</a> <em>     *            DOCUMENT ME!</em>
<a name="823" href="#823">823</a> <em>     * </em>
<a name="824" href="#824">824</a> <em>     * @return a new deep copy Element</em>
<a name="825" href="#825">825</a> <em>     */</em>
<a name="826" href="#826">826</a>     <a href="../../org/dom4j/Element.html">Element</a> createCopy(<a href="../../org/dom4j/QName.html">QName</a> qName);
<a name="827" href="#827">827</a> 
<a name="828" href="#828">828</a>     String elementText(String name);
<a name="829" href="#829">829</a> 
<a name="830" href="#830">830</a>     String elementText(<a href="../../org/dom4j/QName.html">QName</a> qname);
<a name="831" href="#831">831</a> 
<a name="832" href="#832">832</a>     String elementTextTrim(String name);
<a name="833" href="#833">833</a> 
<a name="834" href="#834">834</a>     String elementTextTrim(<a href="../../org/dom4j/QName.html">QName</a> qname);
<a name="835" href="#835">835</a> 
<a name="836" href="#836">836</a>     <em>/**<em>*</em></em>
<a name="837" href="#837">837</a> <em>     * Returns a node at the given index suitable for an XPath result set. This</em>
<a name="838" href="#838">838</a> <em>     * means the resulting Node will either be null or it will support the</em>
<a name="839" href="#839">839</a> <em>     * parent relationship.</em>
<a name="840" href="#840">840</a> <em>     * </em>
<a name="841" href="#841">841</a> <em>     * @param index</em>
<a name="842" href="#842">842</a> <em>     *            DOCUMENT ME!</em>
<a name="843" href="#843">843</a> <em>     * </em>
<a name="844" href="#844">844</a> <em>     * @return the Node for the given index which will support the parent</em>
<a name="845" href="#845">845</a> <em>     *         relationship or null if there is not a node at the given index.</em>
<a name="846" href="#846">846</a> <em>     */</em>
<a name="847" href="#847">847</a>     <a href="../../org/dom4j/Node.html">Node</a> getXPathResult(<strong>int</strong> index);
<a name="848" href="#848">848</a> }
<a name="849" href="#849">849</a> 
<a name="850" href="#850">850</a> <em class="comment">/*</em>
<a name="851" href="#851">851</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="852" href="#852">852</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="853" href="#853">853</a> <em class="comment"> * following conditions are met:</em>
<a name="854" href="#854">854</a> <em class="comment"> * </em>
<a name="855" href="#855">855</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="856" href="#856">856</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="857" href="#857">857</a> <em class="comment"> * </em>
<a name="858" href="#858">858</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="859" href="#859">859</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="860" href="#860">860</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="861" href="#861">861</a> <em class="comment"> * </em>
<a name="862" href="#862">862</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="863" href="#863">863</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="864" href="#864">864</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="865" href="#865">865</a> <em class="comment"> * </em>
<a name="866" href="#866">866</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="867" href="#867">867</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="868" href="#868">868</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="869" href="#869">869</a> <em class="comment"> * </em>
<a name="870" href="#870">870</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="871" href="#871">871</a> <em class="comment"> * </em>
<a name="872" href="#872">872</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="873" href="#873">873</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="874" href="#874">874</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="875" href="#875">875</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="876" href="#876">876</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="877" href="#877">877</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="878" href="#878">878</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="879" href="#879">879</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="880" href="#880">880</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="881" href="#881">881</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="882" href="#882">882</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="883" href="#883">883</a> <em class="comment"> * </em>
<a name="884" href="#884">884</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="885" href="#885">885</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>