blob: ce144c18d11a35262ee6640288fd943f28f51279 [file] [log] [blame]
<!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>NodeList xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/apache/anakia/NodeList.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.anakia;
<a name="2" href="#2">2</a>
<a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
<a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
<a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
<a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
<a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
<a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
<a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
<a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
<a name="12" href="#12">12</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
<a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
<a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
<a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
<a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
<a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
<a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License. </em>
<a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
<a name="21" href="#21">21</a>
<a name="22" href="#22">22</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.StringWriter;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.Writer;
<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList;
<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Collection;
<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Iterator;
<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.List;
<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.ListIterator;
<a name="30" href="#30">30</a>
<a name="31" href="#31">31</a> <strong class="jxr_keyword">import</strong> org.jdom.Attribute;
<a name="32" href="#32">32</a> <strong class="jxr_keyword">import</strong> org.jdom.CDATA;
<a name="33" href="#33">33</a> <strong class="jxr_keyword">import</strong> org.jdom.Comment;
<a name="34" href="#34">34</a> <strong class="jxr_keyword">import</strong> org.jdom.DocType;
<a name="35" href="#35">35</a> <strong class="jxr_keyword">import</strong> org.jdom.Document;
<a name="36" href="#36">36</a> <strong class="jxr_keyword">import</strong> org.jdom.Element;
<a name="37" href="#37">37</a> <strong class="jxr_keyword">import</strong> org.jdom.EntityRef;
<a name="38" href="#38">38</a> <strong class="jxr_keyword">import</strong> org.jdom.ProcessingInstruction;
<a name="39" href="#39">39</a> <strong class="jxr_keyword">import</strong> org.jdom.Text;
<a name="40" href="#40">40</a> <strong class="jxr_keyword">import</strong> org.jdom.output.XMLOutputter;
<a name="41" href="#41">41</a>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment">/**</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * Provides a class for wrapping a list of JDOM objects primarily for use in template</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * engines and other kinds of text transformation tools.</em>
<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * It has a {@link #toString()} method that will output the XML serialized form of the</em>
<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> * nodes it contains - again focusing on template engine usage, as well as the</em>
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment"> * {@link #selectNodes(String)} method that helps selecting a different set of nodes</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * starting from the nodes in this list. The class also implements the {@link java.util.List}</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> * interface by simply delegating calls to the contained list (the {@link #subList(int, int)}</em>
<a name="50" href="#50">50</a> <em class="jxr_javadoccomment"> * method is implemented by delegating to the contained list and wrapping the returned</em>
<a name="51" href="#51">51</a> <em class="jxr_javadoccomment"> * sublist into a &lt;code&gt;NodeList&lt;/code&gt;).</em>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment"> *</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:szegedia@freemail.hu" target="alexandria_uri">mailto:szegedia@freemail.hu</a>"&gt;Attila Szegedi&lt;/a&gt;</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * @version $Id: NodeList.java 524478 2007-03-31 20:51:49Z wglass $</em>
<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em>
<a name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a> implements List, Cloneable
<a name="57" href="#57">57</a> {
<a name="58" href="#58">58</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../org/apache/anakia/NodeList.html">AttributeXMLOutputter</a> DEFAULT_OUTPUTTER =
<a name="59" href="#59">59</a> <strong class="jxr_keyword">new</strong> <a href="../../../org/apache/anakia/NodeList.html">AttributeXMLOutputter</a>();
<a name="60" href="#60">60</a>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The contained nodes */</em>
<a name="62" href="#62">62</a> <strong class="jxr_keyword">private</strong> List nodes;
<a name="63" href="#63">63</a>
<a name="64" href="#64">64</a> <em class="jxr_javadoccomment">/**</em>
<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> * Creates an empty node list.</em>
<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> */</em>
<a name="67" href="#67">67</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a>()
<a name="68" href="#68">68</a> {
<a name="69" href="#69">69</a> nodes = <strong class="jxr_keyword">new</strong> ArrayList();
<a name="70" href="#70">70</a> }
<a name="71" href="#71">71</a>
<a name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em>
<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * Creates a node list that holds a single {@link Document} node.</em>
<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> * @param document</em>
<a name="75" href="#75">75</a> <em class="jxr_javadoccomment"> */</em>
<a name="76" href="#76">76</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a>(Document document)
<a name="77" href="#77">77</a> {
<a name="78" href="#78">78</a> <strong class="jxr_keyword">this</strong>((Object)document);
<a name="79" href="#79">79</a> }
<a name="80" href="#80">80</a>
<a name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * Creates a node list that holds a single {@link Element} node.</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param element</em>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> */</em>
<a name="85" href="#85">85</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a>(Element element)
<a name="86" href="#86">86</a> {
<a name="87" href="#87">87</a> <strong class="jxr_keyword">this</strong>((Object)element);
<a name="88" href="#88">88</a> }
<a name="89" href="#89">89</a>
<a name="90" href="#90">90</a> <strong class="jxr_keyword">private</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a>(Object object)
<a name="91" href="#91">91</a> {
<a name="92" href="#92">92</a> <strong class="jxr_keyword">if</strong>(object == <strong class="jxr_keyword">null</strong>)
<a name="93" href="#93">93</a> {
<a name="94" href="#94">94</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a name="95" href="#95">95</a> <span class="jxr_string">"Cannot construct NodeList with null."</span>);
<a name="96" href="#96">96</a> }
<a name="97" href="#97">97</a> nodes = <strong class="jxr_keyword">new</strong> ArrayList(1);
<a name="98" href="#98">98</a> nodes.add(object);
<a name="99" href="#99">99</a> }
<a name="100" href="#100">100</a>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">/**</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * Creates a node list that holds a list of nodes.</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @param nodes the list of nodes this template should hold. The created</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * template will copy the passed nodes list, so changes to the passed list</em>
<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * will not affect the model.</em>
<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> */</em>
<a name="107" href="#107">107</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a>(List nodes)
<a name="108" href="#108">108</a> {
<a name="109" href="#109">109</a> <strong class="jxr_keyword">this</strong>(nodes, <strong class="jxr_keyword">true</strong>);
<a name="110" href="#110">110</a> }
<a name="111" href="#111">111</a>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment">/**</em>
<a name="113" href="#113">113</a> <em class="jxr_javadoccomment"> * Creates a node list that holds a list of nodes.</em>
<a name="114" href="#114">114</a> <em class="jxr_javadoccomment"> * @param nodes the list of nodes this template should hold.</em>
<a name="115" href="#115">115</a> <em class="jxr_javadoccomment"> * @param copy if true, the created template will copy the passed nodes</em>
<a name="116" href="#116">116</a> <em class="jxr_javadoccomment"> * list, so changes to the passed list will not affect the model. If false,</em>
<a name="117" href="#117">117</a> <em class="jxr_javadoccomment"> * the model will reference the passed list and will sense changes in it,</em>
<a name="118" href="#118">118</a> <em class="jxr_javadoccomment"> * altough no operations on the list will be synchronized.</em>
<a name="119" href="#119">119</a> <em class="jxr_javadoccomment"> */</em>
<a name="120" href="#120">120</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a>(List nodes, <strong class="jxr_keyword">boolean</strong> copy)
<a name="121" href="#121">121</a> {
<a name="122" href="#122">122</a> <strong class="jxr_keyword">if</strong>(nodes == <strong class="jxr_keyword">null</strong>)
<a name="123" href="#123">123</a> {
<a name="124" href="#124">124</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a name="125" href="#125">125</a> <span class="jxr_string">"Cannot initialize NodeList with null list"</span>);
<a name="126" href="#126">126</a> }
<a name="127" href="#127">127</a> <strong class="jxr_keyword">this</strong>.nodes = copy ? <strong class="jxr_keyword">new</strong> ArrayList(nodes) : nodes;
<a name="128" href="#128">128</a> }
<a name="129" href="#129">129</a>
<a name="130" href="#130">130</a> <em class="jxr_javadoccomment">/**</em>
<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> * Retrieves the underlying list used to store the nodes. Note however, that</em>
<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * you can fully use the underlying list through the &lt;code&gt;List&lt;/code&gt; interface</em>
<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * of this class itself. You would probably access the underlying list only for</em>
<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> * synchronization purposes.</em>
<a name="135" href="#135">135</a> <em class="jxr_javadoccomment"> * @return The internal node List.</em>
<a name="136" href="#136">136</a> <em class="jxr_javadoccomment"> */</em>
<a name="137" href="#137">137</a> <strong class="jxr_keyword">public</strong> List getList()
<a name="138" href="#138">138</a> {
<a name="139" href="#139">139</a> <strong class="jxr_keyword">return</strong> nodes;
<a name="140" href="#140">140</a> }
<a name="141" href="#141">141</a>
<a name="142" href="#142">142</a> <em class="jxr_javadoccomment">/**</em>
<a name="143" href="#143">143</a> <em class="jxr_javadoccomment"> * This method returns the string resulting from concatenation of string</em>
<a name="144" href="#144">144</a> <em class="jxr_javadoccomment"> * representations of its nodes. Each node is rendered using its XML</em>
<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * serialization format. This greatly simplifies creating XML-transformation</em>
<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> * templates, as to output a node contained in variable x as XML fragment,</em>
<a name="147" href="#147">147</a> <em class="jxr_javadoccomment"> * you simply write ${x} in the template (or whatever your template engine</em>
<a name="148" href="#148">148</a> <em class="jxr_javadoccomment"> * uses as its expression syntax).</em>
<a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * @return The Nodelist as printable object.</em>
<a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> */</em>
<a name="151" href="#151">151</a> <strong class="jxr_keyword">public</strong> String toString()
<a name="152" href="#152">152</a> {
<a name="153" href="#153">153</a> <strong class="jxr_keyword">if</strong>(nodes.isEmpty())
<a name="154" href="#154">154</a> {
<a name="155" href="#155">155</a> <strong class="jxr_keyword">return</strong> <span class="jxr_string">""</span>;
<a name="156" href="#156">156</a> }
<a name="157" href="#157">157</a>
<a name="158" href="#158">158</a> StringWriter sw = <strong class="jxr_keyword">new</strong> StringWriter(nodes.size() * 128);
<a name="159" href="#159">159</a> <strong class="jxr_keyword">try</strong>
<a name="160" href="#160">160</a> {
<a name="161" href="#161">161</a> <strong class="jxr_keyword">for</strong>(Iterator i = nodes.iterator(); i.hasNext();)
<a name="162" href="#162">162</a> {
<a name="163" href="#163">163</a> Object node = i.next();
<a name="164" href="#164">164</a> <strong class="jxr_keyword">if</strong>(node instanceof Element)
<a name="165" href="#165">165</a> {
<a name="166" href="#166">166</a> DEFAULT_OUTPUTTER.output((Element)node, sw);
<a name="167" href="#167">167</a> }
<a name="168" href="#168">168</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>(node instanceof Attribute)
<a name="169" href="#169">169</a> {
<a name="170" href="#170">170</a> DEFAULT_OUTPUTTER.output((Attribute)node, sw);
<a name="171" href="#171">171</a> }
<a name="172" href="#172">172</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>(node instanceof Text)
<a name="173" href="#173">173</a> {
<a name="174" href="#174">174</a> DEFAULT_OUTPUTTER.output((Text)node, sw);
<a name="175" href="#175">175</a> }
<a name="176" href="#176">176</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>(node instanceof Document)
<a name="177" href="#177">177</a> {
<a name="178" href="#178">178</a> DEFAULT_OUTPUTTER.output((Document)node, sw);
<a name="179" href="#179">179</a> }
<a name="180" href="#180">180</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>(node instanceof ProcessingInstruction)
<a name="181" href="#181">181</a> {
<a name="182" href="#182">182</a> DEFAULT_OUTPUTTER.output((ProcessingInstruction)node, sw);
<a name="183" href="#183">183</a> }
<a name="184" href="#184">184</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>(node instanceof Comment)
<a name="185" href="#185">185</a> {
<a name="186" href="#186">186</a> DEFAULT_OUTPUTTER.output((Comment)node, sw);
<a name="187" href="#187">187</a> }
<a name="188" href="#188">188</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>(node instanceof CDATA)
<a name="189" href="#189">189</a> {
<a name="190" href="#190">190</a> DEFAULT_OUTPUTTER.output((CDATA)node, sw);
<a name="191" href="#191">191</a> }
<a name="192" href="#192">192</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>(node instanceof DocType)
<a name="193" href="#193">193</a> {
<a name="194" href="#194">194</a> DEFAULT_OUTPUTTER.output((DocType)node, sw);
<a name="195" href="#195">195</a> }
<a name="196" href="#196">196</a> <strong class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>(node instanceof EntityRef)
<a name="197" href="#197">197</a> {
<a name="198" href="#198">198</a> DEFAULT_OUTPUTTER.output((EntityRef)node, sw);
<a name="199" href="#199">199</a> }
<a name="200" href="#200">200</a> <strong class="jxr_keyword">else</strong>
<a name="201" href="#201">201</a> {
<a name="202" href="#202">202</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a name="203" href="#203">203</a> <span class="jxr_string">"Cannot process a "</span> +
<a name="204" href="#204">204</a> (node == <strong class="jxr_keyword">null</strong>
<a name="205" href="#205">205</a> ? <span class="jxr_string">"null node"</span>
<a name="206" href="#206">206</a> : <span class="jxr_string">"node of class "</span> + node.getClass().getName()));
<a name="207" href="#207">207</a> }
<a name="208" href="#208">208</a> }
<a name="209" href="#209">209</a> }
<a name="210" href="#210">210</a> <strong class="jxr_keyword">catch</strong>(IOException e)
<a name="211" href="#211">211</a> {
<a name="212" href="#212">212</a> <em class="jxr_comment">// Cannot happen as we work with a StringWriter in memory</em>
<a name="213" href="#213">213</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Error();
<a name="214" href="#214">214</a> }
<a name="215" href="#215">215</a> <strong class="jxr_keyword">return</strong> sw.toString();
<a name="216" href="#216">216</a> }
<a name="217" href="#217">217</a>
<a name="218" href="#218">218</a> <em class="jxr_javadoccomment">/**</em>
<a name="219" href="#219">219</a> <em class="jxr_javadoccomment"> * Returns a NodeList that contains the same nodes as this node list.</em>
<a name="220" href="#220">220</a> <em class="jxr_javadoccomment"> * @return A clone of this list.</em>
<a name="221" href="#221">221</a> <em class="jxr_javadoccomment"> * @throws CloneNotSupportedException if the contained list's class does</em>
<a name="222" href="#222">222</a> <em class="jxr_javadoccomment"> * not have an accessible no-arg constructor.</em>
<a name="223" href="#223">223</a> <em class="jxr_javadoccomment"> */</em>
<a name="224" href="#224">224</a> <strong class="jxr_keyword">public</strong> Object clone()
<a name="225" href="#225">225</a> <strong class="jxr_keyword">throws</strong> CloneNotSupportedException
<a name="226" href="#226">226</a> {
<a name="227" href="#227">227</a> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a> clonedList = (NodeList)<strong class="jxr_keyword">super</strong>.clone();
<a name="228" href="#228">228</a> clonedList.cloneNodes();
<a name="229" href="#229">229</a> <strong class="jxr_keyword">return</strong> clonedList;
<a name="230" href="#230">230</a> }
<a name="231" href="#231">231</a>
<a name="232" href="#232">232</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong> cloneNodes()
<a name="233" href="#233">233</a> <strong class="jxr_keyword">throws</strong> CloneNotSupportedException
<a name="234" href="#234">234</a> {
<a name="235" href="#235">235</a> Class listClass = nodes.getClass();
<a name="236" href="#236">236</a> <strong class="jxr_keyword">try</strong>
<a name="237" href="#237">237</a> {
<a name="238" href="#238">238</a> List clonedNodes = (List)listClass.newInstance();
<a name="239" href="#239">239</a> clonedNodes.addAll(nodes);
<a name="240" href="#240">240</a> nodes = clonedNodes;
<a name="241" href="#241">241</a> }
<a name="242" href="#242">242</a> <strong class="jxr_keyword">catch</strong>(IllegalAccessException e)
<a name="243" href="#243">243</a> {
<a name="244" href="#244">244</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> CloneNotSupportedException(<span class="jxr_string">"Cannot clone NodeList since"</span>
<a name="245" href="#245">245</a> + <span class="jxr_string">" there is no accessible no-arg constructor on class "</span>
<a name="246" href="#246">246</a> + listClass.getName());
<a name="247" href="#247">247</a> }
<a name="248" href="#248">248</a> <strong class="jxr_keyword">catch</strong>(InstantiationException e)
<a name="249" href="#249">249</a> {
<a name="250" href="#250">250</a> <em class="jxr_comment">// Cannot happen as listClass represents a concrete, non-primitive,</em>
<a name="251" href="#251">251</a> <em class="jxr_comment">// non-array, non-void class - there's an instance of it in "nodes"</em>
<a name="252" href="#252">252</a> <em class="jxr_comment">// which proves these assumptions.</em>
<a name="253" href="#253">253</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> Error();
<a name="254" href="#254">254</a> }
<a name="255" href="#255">255</a> }
<a name="256" href="#256">256</a>
<a name="257" href="#257">257</a> <em class="jxr_javadoccomment">/**</em>
<a name="258" href="#258">258</a> <em class="jxr_javadoccomment"> * Returns the hash code of the contained list.</em>
<a name="259" href="#259">259</a> <em class="jxr_javadoccomment"> * @return The hashcode of the list.</em>
<a name="260" href="#260">260</a> <em class="jxr_javadoccomment"> */</em>
<a name="261" href="#261">261</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> hashCode()
<a name="262" href="#262">262</a> {
<a name="263" href="#263">263</a> <strong class="jxr_keyword">return</strong> nodes.hashCode();
<a name="264" href="#264">264</a> }
<a name="265" href="#265">265</a>
<a name="266" href="#266">266</a> <em class="jxr_javadoccomment">/**</em>
<a name="267" href="#267">267</a> <em class="jxr_javadoccomment"> * Tests for equality with another object.</em>
<a name="268" href="#268">268</a> <em class="jxr_javadoccomment"> * @param o the object to test for equality</em>
<a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * @return true if the other object is also a NodeList and their contained</em>
<a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> * {@link List} objects evaluate as equals.</em>
<a name="271" href="#271">271</a> <em class="jxr_javadoccomment"> */</em>
<a name="272" href="#272">272</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> equals(Object o)
<a name="273" href="#273">273</a> {
<a name="274" href="#274">274</a> <strong class="jxr_keyword">return</strong> o instanceof <a href="../../../org/apache/anakia/NodeList.html">NodeList</a>
<a name="275" href="#275">275</a> ? ((NodeList)o).nodes.equals(nodes)
<a name="276" href="#276">276</a> : false;
<a name="277" href="#277">277</a> }
<a name="278" href="#278">278</a>
<a name="279" href="#279">279</a> <em class="jxr_javadoccomment">/**</em>
<a name="280" href="#280">280</a> <em class="jxr_javadoccomment"> * Applies an XPath expression to the node list and returns the resulting</em>
<a name="281" href="#281">281</a> <em class="jxr_javadoccomment"> * node list. In order for this method to work, your application must have</em>
<a name="282" href="#282">282</a> <em class="jxr_javadoccomment"> * access to &lt;a href="<a href="http://code.werken.com" target="alexandria_uri">http://code.werken.com</a>"&gt;werken.xpath&lt;/a&gt; library</em>
<a name="283" href="#283">283</a> <em class="jxr_javadoccomment"> * classes. The implementation does cache the parsed format of XPath</em>
<a name="284" href="#284">284</a> <em class="jxr_javadoccomment"> * expressions in a weak hash map, keyed by the string representation of</em>
<a name="285" href="#285">285</a> <em class="jxr_javadoccomment"> * the XPath expression. As the string object passed as the argument is</em>
<a name="286" href="#286">286</a> <em class="jxr_javadoccomment"> * usually kept in the parsed template, this ensures that each XPath</em>
<a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * expression is parsed only once during the lifetime of the template that</em>
<a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> * first invoked it.</em>
<a name="289" href="#289">289</a> <em class="jxr_javadoccomment"> * @param xpathString the XPath expression you wish to apply</em>
<a name="290" href="#290">290</a> <em class="jxr_javadoccomment"> * @return a NodeList representing the nodes that are the result of</em>
<a name="291" href="#291">291</a> <em class="jxr_javadoccomment"> * application of the XPath to the current node list. It can be empty.</em>
<a name="292" href="#292">292</a> <em class="jxr_javadoccomment"> */</em>
<a name="293" href="#293">293</a> <strong class="jxr_keyword">public</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a> selectNodes(String xpathString)
<a name="294" href="#294">294</a> {
<a name="295" href="#295">295</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a>(XPathCache.getXPath(xpathString).applyTo(nodes), false);
<a name="296" href="#296">296</a> }
<a name="297" href="#297">297</a>
<a name="298" href="#298">298</a> <em class="jxr_comment">// List methods implemented hereafter</em>
<a name="299" href="#299">299</a>
<a name="300" href="#300">300</a> <em class="jxr_javadoccomment">/**</em>
<a name="301" href="#301">301</a> <em class="jxr_javadoccomment"> * @see java.util.List#add(java.lang.Object)</em>
<a name="302" href="#302">302</a> <em class="jxr_javadoccomment"> */</em>
<a name="303" href="#303">303</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> add(Object o)
<a name="304" href="#304">304</a> {
<a name="305" href="#305">305</a> <strong class="jxr_keyword">return</strong> nodes.add(o);
<a name="306" href="#306">306</a> }
<a name="307" href="#307">307</a>
<a name="308" href="#308">308</a> <em class="jxr_javadoccomment">/**</em>
<a name="309" href="#309">309</a> <em class="jxr_javadoccomment"> * @see java.util.List#add(int, java.lang.Object)</em>
<a name="310" href="#310">310</a> <em class="jxr_javadoccomment"> */</em>
<a name="311" href="#311">311</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> add(<strong class="jxr_keyword">int</strong> index, Object o)
<a name="312" href="#312">312</a> {
<a name="313" href="#313">313</a> nodes.add(index, o);
<a name="314" href="#314">314</a> }
<a name="315" href="#315">315</a>
<a name="316" href="#316">316</a> <em class="jxr_javadoccomment">/**</em>
<a name="317" href="#317">317</a> <em class="jxr_javadoccomment"> * @see java.util.List#addAll(java.util.Collection)</em>
<a name="318" href="#318">318</a> <em class="jxr_javadoccomment"> */</em>
<a name="319" href="#319">319</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addAll(Collection c)
<a name="320" href="#320">320</a> {
<a name="321" href="#321">321</a> <strong class="jxr_keyword">return</strong> nodes.addAll(c);
<a name="322" href="#322">322</a> }
<a name="323" href="#323">323</a>
<a name="324" href="#324">324</a> <em class="jxr_javadoccomment">/**</em>
<a name="325" href="#325">325</a> <em class="jxr_javadoccomment"> * @see java.util.List#addAll(int, java.util.Collection)</em>
<a name="326" href="#326">326</a> <em class="jxr_javadoccomment"> */</em>
<a name="327" href="#327">327</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> addAll(<strong class="jxr_keyword">int</strong> index, Collection c)
<a name="328" href="#328">328</a> {
<a name="329" href="#329">329</a> <strong class="jxr_keyword">return</strong> nodes.addAll(index, c);
<a name="330" href="#330">330</a> }
<a name="331" href="#331">331</a>
<a name="332" href="#332">332</a> <em class="jxr_javadoccomment">/**</em>
<a name="333" href="#333">333</a> <em class="jxr_javadoccomment"> * @see java.util.List#clear()</em>
<a name="334" href="#334">334</a> <em class="jxr_javadoccomment"> */</em>
<a name="335" href="#335">335</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> clear()
<a name="336" href="#336">336</a> {
<a name="337" href="#337">337</a> nodes.clear();
<a name="338" href="#338">338</a> }
<a name="339" href="#339">339</a>
<a name="340" href="#340">340</a> <em class="jxr_javadoccomment">/**</em>
<a name="341" href="#341">341</a> <em class="jxr_javadoccomment"> * @see java.util.List#contains(java.lang.Object)</em>
<a name="342" href="#342">342</a> <em class="jxr_javadoccomment"> */</em>
<a name="343" href="#343">343</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> contains(Object o)
<a name="344" href="#344">344</a> {
<a name="345" href="#345">345</a> <strong class="jxr_keyword">return</strong> nodes.contains(o);
<a name="346" href="#346">346</a> }
<a name="347" href="#347">347</a>
<a name="348" href="#348">348</a> <em class="jxr_javadoccomment">/**</em>
<a name="349" href="#349">349</a> <em class="jxr_javadoccomment"> * @see java.util.List#containsAll(java.util.Collection)</em>
<a name="350" href="#350">350</a> <em class="jxr_javadoccomment"> */</em>
<a name="351" href="#351">351</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> containsAll(Collection c)
<a name="352" href="#352">352</a> {
<a name="353" href="#353">353</a> <strong class="jxr_keyword">return</strong> nodes.containsAll(c);
<a name="354" href="#354">354</a> }
<a name="355" href="#355">355</a>
<a name="356" href="#356">356</a> <em class="jxr_javadoccomment">/**</em>
<a name="357" href="#357">357</a> <em class="jxr_javadoccomment"> * @see java.util.List#get(int)</em>
<a name="358" href="#358">358</a> <em class="jxr_javadoccomment"> */</em>
<a name="359" href="#359">359</a> <strong class="jxr_keyword">public</strong> Object get(<strong class="jxr_keyword">int</strong> index)
<a name="360" href="#360">360</a> {
<a name="361" href="#361">361</a> <strong class="jxr_keyword">return</strong> nodes.get(index);
<a name="362" href="#362">362</a> }
<a name="363" href="#363">363</a>
<a name="364" href="#364">364</a> <em class="jxr_javadoccomment">/**</em>
<a name="365" href="#365">365</a> <em class="jxr_javadoccomment"> * @see java.util.List#indexOf(java.lang.Object)</em>
<a name="366" href="#366">366</a> <em class="jxr_javadoccomment"> */</em>
<a name="367" href="#367">367</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> indexOf(Object o)
<a name="368" href="#368">368</a> {
<a name="369" href="#369">369</a> <strong class="jxr_keyword">return</strong> nodes.indexOf(o);
<a name="370" href="#370">370</a> }
<a name="371" href="#371">371</a>
<a name="372" href="#372">372</a> <em class="jxr_javadoccomment">/**</em>
<a name="373" href="#373">373</a> <em class="jxr_javadoccomment"> * @see java.util.List#isEmpty()</em>
<a name="374" href="#374">374</a> <em class="jxr_javadoccomment"> */</em>
<a name="375" href="#375">375</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isEmpty()
<a name="376" href="#376">376</a> {
<a name="377" href="#377">377</a> <strong class="jxr_keyword">return</strong> nodes.isEmpty();
<a name="378" href="#378">378</a> }
<a name="379" href="#379">379</a>
<a name="380" href="#380">380</a> <em class="jxr_javadoccomment">/**</em>
<a name="381" href="#381">381</a> <em class="jxr_javadoccomment"> * @see java.util.List#iterator()</em>
<a name="382" href="#382">382</a> <em class="jxr_javadoccomment"> */</em>
<a name="383" href="#383">383</a> <strong class="jxr_keyword">public</strong> Iterator iterator()
<a name="384" href="#384">384</a> {
<a name="385" href="#385">385</a> <strong class="jxr_keyword">return</strong> nodes.iterator();
<a name="386" href="#386">386</a> }
<a name="387" href="#387">387</a>
<a name="388" href="#388">388</a> <em class="jxr_javadoccomment">/**</em>
<a name="389" href="#389">389</a> <em class="jxr_javadoccomment"> * @see java.util.List#lastIndexOf(java.lang.Object)</em>
<a name="390" href="#390">390</a> <em class="jxr_javadoccomment"> */</em>
<a name="391" href="#391">391</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> lastIndexOf(Object o)
<a name="392" href="#392">392</a> {
<a name="393" href="#393">393</a> <strong class="jxr_keyword">return</strong> nodes.lastIndexOf(o);
<a name="394" href="#394">394</a> }
<a name="395" href="#395">395</a>
<a name="396" href="#396">396</a> <em class="jxr_javadoccomment">/**</em>
<a name="397" href="#397">397</a> <em class="jxr_javadoccomment"> * @see java.util.List#listIterator()</em>
<a name="398" href="#398">398</a> <em class="jxr_javadoccomment"> */</em>
<a name="399" href="#399">399</a> <strong class="jxr_keyword">public</strong> ListIterator listIterator()
<a name="400" href="#400">400</a> {
<a name="401" href="#401">401</a> <strong class="jxr_keyword">return</strong> nodes.listIterator();
<a name="402" href="#402">402</a> }
<a name="403" href="#403">403</a>
<a name="404" href="#404">404</a> <em class="jxr_javadoccomment">/**</em>
<a name="405" href="#405">405</a> <em class="jxr_javadoccomment"> * @see java.util.List#listIterator(int)</em>
<a name="406" href="#406">406</a> <em class="jxr_javadoccomment"> */</em>
<a name="407" href="#407">407</a> <strong class="jxr_keyword">public</strong> ListIterator listIterator(<strong class="jxr_keyword">int</strong> index)
<a name="408" href="#408">408</a> {
<a name="409" href="#409">409</a> <strong class="jxr_keyword">return</strong> nodes.listIterator(index);
<a name="410" href="#410">410</a> }
<a name="411" href="#411">411</a>
<a name="412" href="#412">412</a> <em class="jxr_javadoccomment">/**</em>
<a name="413" href="#413">413</a> <em class="jxr_javadoccomment"> * @see java.util.List#remove(int)</em>
<a name="414" href="#414">414</a> <em class="jxr_javadoccomment"> */</em>
<a name="415" href="#415">415</a> <strong class="jxr_keyword">public</strong> Object remove(<strong class="jxr_keyword">int</strong> index)
<a name="416" href="#416">416</a> {
<a name="417" href="#417">417</a> <strong class="jxr_keyword">return</strong> nodes.remove(index);
<a name="418" href="#418">418</a> }
<a name="419" href="#419">419</a>
<a name="420" href="#420">420</a> <em class="jxr_javadoccomment">/**</em>
<a name="421" href="#421">421</a> <em class="jxr_javadoccomment"> * @see java.util.List#remove(java.lang.Object)</em>
<a name="422" href="#422">422</a> <em class="jxr_javadoccomment"> */</em>
<a name="423" href="#423">423</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> remove(Object o)
<a name="424" href="#424">424</a> {
<a name="425" href="#425">425</a> <strong class="jxr_keyword">return</strong> nodes.remove(o);
<a name="426" href="#426">426</a> }
<a name="427" href="#427">427</a>
<a name="428" href="#428">428</a> <em class="jxr_javadoccomment">/**</em>
<a name="429" href="#429">429</a> <em class="jxr_javadoccomment"> * @see java.util.List#removeAll(java.util.Collection)</em>
<a name="430" href="#430">430</a> <em class="jxr_javadoccomment"> */</em>
<a name="431" href="#431">431</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> removeAll(Collection c)
<a name="432" href="#432">432</a> {
<a name="433" href="#433">433</a> <strong class="jxr_keyword">return</strong> nodes.removeAll(c);
<a name="434" href="#434">434</a> }
<a name="435" href="#435">435</a>
<a name="436" href="#436">436</a> <em class="jxr_javadoccomment">/**</em>
<a name="437" href="#437">437</a> <em class="jxr_javadoccomment"> * @see java.util.List#retainAll(java.util.Collection)</em>
<a name="438" href="#438">438</a> <em class="jxr_javadoccomment"> */</em>
<a name="439" href="#439">439</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> retainAll(Collection c)
<a name="440" href="#440">440</a> {
<a name="441" href="#441">441</a> <strong class="jxr_keyword">return</strong> nodes.retainAll(c);
<a name="442" href="#442">442</a> }
<a name="443" href="#443">443</a>
<a name="444" href="#444">444</a> <em class="jxr_javadoccomment">/**</em>
<a name="445" href="#445">445</a> <em class="jxr_javadoccomment"> * @see java.util.List#set(int, java.lang.Object)</em>
<a name="446" href="#446">446</a> <em class="jxr_javadoccomment"> */</em>
<a name="447" href="#447">447</a> <strong class="jxr_keyword">public</strong> Object set(<strong class="jxr_keyword">int</strong> index, Object o)
<a name="448" href="#448">448</a> {
<a name="449" href="#449">449</a> <strong class="jxr_keyword">return</strong> nodes.set(index, o);
<a name="450" href="#450">450</a> }
<a name="451" href="#451">451</a>
<a name="452" href="#452">452</a> <em class="jxr_javadoccomment">/**</em>
<a name="453" href="#453">453</a> <em class="jxr_javadoccomment"> * @see java.util.List#size()</em>
<a name="454" href="#454">454</a> <em class="jxr_javadoccomment"> */</em>
<a name="455" href="#455">455</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> size()
<a name="456" href="#456">456</a> {
<a name="457" href="#457">457</a> <strong class="jxr_keyword">return</strong> nodes.size();
<a name="458" href="#458">458</a> }
<a name="459" href="#459">459</a>
<a name="460" href="#460">460</a> <em class="jxr_javadoccomment">/**</em>
<a name="461" href="#461">461</a> <em class="jxr_javadoccomment"> * @see java.util.List#subList(int, int)</em>
<a name="462" href="#462">462</a> <em class="jxr_javadoccomment"> */</em>
<a name="463" href="#463">463</a> <strong class="jxr_keyword">public</strong> List subList(<strong class="jxr_keyword">int</strong> fromIndex, <strong class="jxr_keyword">int</strong> toIndex)
<a name="464" href="#464">464</a> {
<a name="465" href="#465">465</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">new</strong> <a href="../../../org/apache/anakia/NodeList.html">NodeList</a>(nodes.subList(fromIndex, toIndex));
<a name="466" href="#466">466</a> }
<a name="467" href="#467">467</a>
<a name="468" href="#468">468</a> <em class="jxr_javadoccomment">/**</em>
<a name="469" href="#469">469</a> <em class="jxr_javadoccomment"> * @see java.util.List#toArray()</em>
<a name="470" href="#470">470</a> <em class="jxr_javadoccomment"> */</em>
<a name="471" href="#471">471</a> <strong class="jxr_keyword">public</strong> Object[] toArray()
<a name="472" href="#472">472</a> {
<a name="473" href="#473">473</a> <strong class="jxr_keyword">return</strong> nodes.toArray();
<a name="474" href="#474">474</a> }
<a name="475" href="#475">475</a>
<a name="476" href="#476">476</a> <em class="jxr_javadoccomment">/**</em>
<a name="477" href="#477">477</a> <em class="jxr_javadoccomment"> * @see java.util.List#toArray(java.lang.Object[])</em>
<a name="478" href="#478">478</a> <em class="jxr_javadoccomment"> */</em>
<a name="479" href="#479">479</a> <strong class="jxr_keyword">public</strong> Object[] toArray(Object[] a)
<a name="480" href="#480">480</a> {
<a name="481" href="#481">481</a> <strong class="jxr_keyword">return</strong> nodes.toArray(a);
<a name="482" href="#482">482</a> }
<a name="483" href="#483">483</a>
<a name="484" href="#484">484</a> <em class="jxr_javadoccomment">/**</em>
<a name="485" href="#485">485</a> <em class="jxr_javadoccomment"> * A special subclass of XMLOutputter that will be used to output</em>
<a name="486" href="#486">486</a> <em class="jxr_javadoccomment"> * Attribute nodes. As a subclass of XMLOutputter it can use its protected</em>
<a name="487" href="#487">487</a> <em class="jxr_javadoccomment"> * method escapeAttributeEntities() to serialize the attribute</em>
<a name="488" href="#488">488</a> <em class="jxr_javadoccomment"> * appropriately.</em>
<a name="489" href="#489">489</a> <em class="jxr_javadoccomment"> */</em>
<a name="490" href="#490">490</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../org/apache/anakia/NodeList.html">AttributeXMLOutputter</a> <strong class="jxr_keyword">extends</strong> XMLOutputter
<a name="491" href="#491">491</a> {
<a name="492" href="#492">492</a> <em class="jxr_javadoccomment">/**</em>
<a name="493" href="#493">493</a> <em class="jxr_javadoccomment"> * @param attribute</em>
<a name="494" href="#494">494</a> <em class="jxr_javadoccomment"> * @param out</em>
<a name="495" href="#495">495</a> <em class="jxr_javadoccomment"> * @throws IOException</em>
<a name="496" href="#496">496</a> <em class="jxr_javadoccomment"> */</em>
<a name="497" href="#497">497</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> output(Attribute attribute, Writer out)
<a name="498" href="#498">498</a> <strong class="jxr_keyword">throws</strong> IOException
<a name="499" href="#499">499</a> {
<a name="500" href="#500">500</a> out.write(<span class="jxr_string">" "</span>);
<a name="501" href="#501">501</a> out.write(attribute.getQualifiedName());
<a name="502" href="#502">502</a> out.write(<span class="jxr_string">"="</span>);
<a name="503" href="#503">503</a>
<a name="504" href="#504">504</a> out.write(<span class="jxr_string">"\&quot;"</span>);
<a name="505" href="#505">505</a> out.write(escapeAttributeEntities(attribute.getValue()));
<a name="506" href="#506">506</a> out.write(<span class="jxr_string">"\&quot;"</span>);
<a name="507" href="#507">507</a> }
<a name="508" href="#508">508</a> }
<a name="509" href="#509">509</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>