Show ElementStack.html syntax highlighted
<!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>ElementStack xref</title>
<link type="text/css" rel="stylesheet" href="../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../apidocs/org/dom4j/io/ElementStack.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/io/package-summary.html">org.dom4j.io</a>;
<a name="9" href="#9">9</a>
<a name="10" href="#10">10</a> <strong>import</strong> org.dom4j.Element;
<a name="11" href="#11">11</a> <strong>import</strong> org.dom4j.ElementHandler;
<a name="12" href="#12">12</a> <strong>import</strong> org.dom4j.ElementPath;
<a name="13" href="#13">13</a>
<a name="14" href="#14">14</a> <em>/**<em>*</em></em>
<a name="15" href="#15">15</a> <em> * <p></em>
<a name="16" href="#16">16</a> <em> * <code>ElementStack</code> is used internally inside the {@link</em>
<a name="17" href="#17">17</a> <em> * SAXContentHandler} to maintain a stack of {@link Element}instances. It opens</em>
<a name="18" href="#18">18</a> <em> * an integration possibility allowing derivations to prune the tree when a node</em>
<a name="19" href="#19">19</a> <em> * is complete.</em>
<a name="20" href="#20">20</a> <em> * </p></em>
<a name="21" href="#21">21</a> <em> * </em>
<a name="22" href="#22">22</a> <em> * @author <a href="<a href="mailto:james.strachan@metastuff.com" target="alexandria_uri">mailto:james.strachan@metastuff.com</a>">James Strachan </a></em>
<a name="23" href="#23">23</a> <em> * @version $Revision: 1.1 $</em>
<a name="24" href="#24">24</a> <em> */</em>
<a name="25" href="#25">25</a> <strong>class</strong> <a href="../../../org/dom4j/io/ElementStack.html">ElementStack</a> implements <a href="../../../org/dom4j/ElementPath.html">ElementPath</a> {
<a name="26" href="#26">26</a> <em>/**<em>* stack of <code>Element</code> objects */</em></em>
<a name="27" href="#27">27</a> <strong>protected</strong> <a href="../../../org/dom4j/Element.html">Element</a>[] stack;
<a name="28" href="#28">28</a>
<a name="29" href="#29">29</a> <em>/**<em>* index of the item at the top of the stack or -1 if the stack is empty */</em></em>
<a name="30" href="#30">30</a> <strong>protected</strong> <strong>int</strong> lastElementIndex = -1;
<a name="31" href="#31">31</a>
<a name="32" href="#32">32</a> <strong>private</strong> <a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a> handler = <strong>null</strong>;
<a name="33" href="#33">33</a>
<a name="34" href="#34">34</a> <strong>public</strong> <a href="../../../org/dom4j/io/ElementStack.html">ElementStack</a>() {
<a name="35" href="#35">35</a> <strong>this</strong>(50);
<a name="36" href="#36">36</a> }
<a name="37" href="#37">37</a>
<a name="38" href="#38">38</a> <strong>public</strong> <a href="../../../org/dom4j/io/ElementStack.html">ElementStack</a>(<strong>int</strong> defaultCapacity) {
<a name="39" href="#39">39</a> stack = <strong>new</strong> <a href="../../../org/dom4j/Element.html">Element</a>[defaultCapacity];
<a name="40" href="#40">40</a> }
<a name="41" href="#41">41</a>
<a name="42" href="#42">42</a> <strong>public</strong> <strong>void</strong> setDispatchHandler(<a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a> dispatchHandler) {
<a name="43" href="#43">43</a> <strong>this</strong>.handler = dispatchHandler;
<a name="44" href="#44">44</a> }
<a name="45" href="#45">45</a>
<a name="46" href="#46">46</a> <strong>public</strong> <a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a> getDispatchHandler() {
<a name="47" href="#47">47</a> <strong>return</strong> <strong>this</strong>.handler;
<a name="48" href="#48">48</a> }
<a name="49" href="#49">49</a>
<a name="50" href="#50">50</a> <em>/**<em>*</em></em>
<a name="51" href="#51">51</a> <em> * Peeks at the top element on the stack without changing the contents of</em>
<a name="52" href="#52">52</a> <em> * the stack.</em>
<a name="53" href="#53">53</a> <em> */</em>
<a name="54" href="#54">54</a> <strong>public</strong> <strong>void</strong> clear() {
<a name="55" href="#55">55</a> lastElementIndex = -1;
<a name="56" href="#56">56</a> }
<a name="57" href="#57">57</a>
<a name="58" href="#58">58</a> <em>/**<em>*</em></em>
<a name="59" href="#59">59</a> <em> * Peeks at the top element on the stack without changing the contents of</em>
<a name="60" href="#60">60</a> <em> * the stack.</em>
<a name="61" href="#61">61</a> <em> * </em>
<a name="62" href="#62">62</a> <em> * @return the current element on the stack</em>
<a name="63" href="#63">63</a> <em> */</em>
<a name="64" href="#64">64</a> <strong>public</strong> <a href="../../../org/dom4j/Element.html">Element</a> peekElement() {
<a name="65" href="#65">65</a> <strong>if</strong> (lastElementIndex < 0) {
<a name="66" href="#66">66</a> <strong>return</strong> <strong>null</strong>;
<a name="67" href="#67">67</a> }
<a name="68" href="#68">68</a>
<a name="69" href="#69">69</a> <strong>return</strong> stack[lastElementIndex];
<a name="70" href="#70">70</a> }
<a name="71" href="#71">71</a>
<a name="72" href="#72">72</a> <em>/**<em>*</em></em>
<a name="73" href="#73">73</a> <em> * Pops the element off the stack</em>
<a name="74" href="#74">74</a> <em> * </em>
<a name="75" href="#75">75</a> <em> * @return the element that has just been popped off the stack</em>
<a name="76" href="#76">76</a> <em> */</em>
<a name="77" href="#77">77</a> <strong>public</strong> <a href="../../../org/dom4j/Element.html">Element</a> popElement() {
<a name="78" href="#78">78</a> <strong>if</strong> (lastElementIndex < 0) {
<a name="79" href="#79">79</a> <strong>return</strong> <strong>null</strong>;
<a name="80" href="#80">80</a> }
<a name="81" href="#81">81</a>
<a name="82" href="#82">82</a> <strong>return</strong> stack[lastElementIndex--];
<a name="83" href="#83">83</a> }
<a name="84" href="#84">84</a>
<a name="85" href="#85">85</a> <em>/**<em>*</em></em>
<a name="86" href="#86">86</a> <em> * Pushes a new element onto the stack</em>
<a name="87" href="#87">87</a> <em> * </em>
<a name="88" href="#88">88</a> <em> * @param element</em>
<a name="89" href="#89">89</a> <em> * DOCUMENT ME!</em>
<a name="90" href="#90">90</a> <em> */</em>
<a name="91" href="#91">91</a> <strong>public</strong> <strong>void</strong> pushElement(<a href="../../../org/dom4j/Element.html">Element</a> element) {
<a name="92" href="#92">92</a> <strong>int</strong> length = stack.length;
<a name="93" href="#93">93</a>
<a name="94" href="#94">94</a> <strong>if</strong> (++lastElementIndex >= length) {
<a name="95" href="#95">95</a> reallocate(length * 2);
<a name="96" href="#96">96</a> }
<a name="97" href="#97">97</a>
<a name="98" href="#98">98</a> stack[lastElementIndex] = element;
<a name="99" href="#99">99</a> }
<a name="100" href="#100">100</a>
<a name="101" href="#101">101</a> <em>/**<em>*</em></em>
<a name="102" href="#102">102</a> <em> * Reallocates the stack to the given size</em>
<a name="103" href="#103">103</a> <em> * </em>
<a name="104" href="#104">104</a> <em> * @param size</em>
<a name="105" href="#105">105</a> <em> * DOCUMENT ME!</em>
<a name="106" href="#106">106</a> <em> */</em>
<a name="107" href="#107">107</a> <strong>protected</strong> <strong>void</strong> reallocate(<strong>int</strong> size) {
<a name="108" href="#108">108</a> <a href="../../../org/dom4j/Element.html">Element</a>[] oldStack = stack;
<a name="109" href="#109">109</a> stack = <strong>new</strong> <a href="../../../org/dom4j/Element.html">Element</a>[size];
<a name="110" href="#110">110</a> System.arraycopy(oldStack, 0, stack, 0, oldStack.length);
<a name="111" href="#111">111</a> }
<a name="112" href="#112">112</a>
<a name="113" href="#113">113</a> <em class="comment">// The ElementPath Interface</em>
<a name="114" href="#114">114</a> <em class="comment">//</em>
<a name="115" href="#115">115</a> <strong>public</strong> <strong>int</strong> size() {
<a name="116" href="#116">116</a> <strong>return</strong> lastElementIndex + 1;
<a name="117" href="#117">117</a> }
<a name="118" href="#118">118</a>
<a name="119" href="#119">119</a> <strong>public</strong> <a href="../../../org/dom4j/Element.html">Element</a> getElement(<strong>int</strong> depth) {
<a name="120" href="#120">120</a> <a href="../../../org/dom4j/Element.html">Element</a> element;
<a name="121" href="#121">121</a>
<a name="122" href="#122">122</a> <strong>try</strong> {
<a name="123" href="#123">123</a> element = (Element) stack[depth];
<a name="124" href="#124">124</a> } <strong>catch</strong> (ArrayIndexOutOfBoundsException e) {
<a name="125" href="#125">125</a> element = <strong>null</strong>;
<a name="126" href="#126">126</a> }
<a name="127" href="#127">127</a>
<a name="128" href="#128">128</a> <strong>return</strong> element;
<a name="129" href="#129">129</a> }
<a name="130" href="#130">130</a>
<a name="131" href="#131">131</a> <strong>public</strong> String getPath() {
<a name="132" href="#132">132</a> <strong>if</strong> (handler == <strong>null</strong>) {
<a name="133" href="#133">133</a> setDispatchHandler(<strong>new</strong> <a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a>());
<a name="134" href="#134">134</a> }
<a name="135" href="#135">135</a>
<a name="136" href="#136">136</a> <strong>return</strong> handler.getPath();
<a name="137" href="#137">137</a> }
<a name="138" href="#138">138</a>
<a name="139" href="#139">139</a> <strong>public</strong> <a href="../../../org/dom4j/Element.html">Element</a> getCurrent() {
<a name="140" href="#140">140</a> <strong>return</strong> peekElement();
<a name="141" href="#141">141</a> }
<a name="142" href="#142">142</a>
<a name="143" href="#143">143</a> <strong>public</strong> <strong>void</strong> addHandler(String path, <a href="../../../org/dom4j/ElementHandler.html">ElementHandler</a> elementHandler) {
<a name="144" href="#144">144</a> <strong>this</strong>.handler.addHandler(getHandlerPath(path), elementHandler);
<a name="145" href="#145">145</a> }
<a name="146" href="#146">146</a>
<a name="147" href="#147">147</a> <strong>public</strong> <strong>void</strong> removeHandler(String path) {
<a name="148" href="#148">148</a> <strong>this</strong>.handler.removeHandler(getHandlerPath(path));
<a name="149" href="#149">149</a> }
<a name="150" href="#150">150</a>
<a name="151" href="#151">151</a> <em>/**<em>*</em></em>
<a name="152" href="#152">152</a> <em> * DOCUMENT ME!</em>
<a name="153" href="#153">153</a> <em> * </em>
<a name="154" href="#154">154</a> <em> * @param path</em>
<a name="155" href="#155">155</a> <em> * DOCUMENT ME!</em>
<a name="156" href="#156">156</a> <em> * </em>
<a name="157" href="#157">157</a> <em> * @return true when an <code>ElementHandler</code> is registered for the</em>
<a name="158" href="#158">158</a> <em> * specified path.</em>
<a name="159" href="#159">159</a> <em> */</em>
<a name="160" href="#160">160</a> <strong>public</strong> <strong>boolean</strong> containsHandler(String path) {
<a name="161" href="#161">161</a> <strong>return</strong> <strong>this</strong>.handler.containsHandler(path);
<a name="162" href="#162">162</a> }
<a name="163" href="#163">163</a>
<a name="164" href="#164">164</a> <strong>private</strong> String getHandlerPath(String path) {
<a name="165" href="#165">165</a> String handlerPath;
<a name="166" href="#166">166</a>
<a name="167" href="#167">167</a> <strong>if</strong> (<strong>this</strong>.handler == <strong>null</strong>) {
<a name="168" href="#168">168</a> setDispatchHandler(<strong>new</strong> <a href="../../../org/dom4j/io/DispatchHandler.html">DispatchHandler</a>());
<a name="169" href="#169">169</a> }
<a name="170" href="#170">170</a>
<a name="171" href="#171">171</a> <strong>if</strong> (path.startsWith(<span class="string">"/"</span>)) {
<a name="172" href="#172">172</a> handlerPath = path;
<a name="173" href="#173">173</a> } <strong>else</strong> <strong>if</strong> (getPath().equals(<span class="string">"/"</span>)) {
<a name="174" href="#174">174</a> handlerPath = getPath() + path;
<a name="175" href="#175">175</a> } <strong>else</strong> {
<a name="176" href="#176">176</a> handlerPath = getPath() + <span class="string">"/"</span> + path;
<a name="177" href="#177">177</a> }
<a name="178" href="#178">178</a>
<a name="179" href="#179">179</a> <strong>return</strong> handlerPath;
<a name="180" href="#180">180</a> }
<a name="181" href="#181">181</a> }
<a name="182" href="#182">182</a>
<a name="183" href="#183">183</a> <em class="comment">/*</em>
<a name="184" href="#184">184</a> <em class="comment"> * Redistribution and use of this software and associated documentation</em>
<a name="185" href="#185">185</a> <em class="comment"> * ("Software"), with or without modification, are permitted provided that the</em>
<a name="186" href="#186">186</a> <em class="comment"> * following conditions are met:</em>
<a name="187" href="#187">187</a> <em class="comment"> * </em>
<a name="188" href="#188">188</a> <em class="comment"> * 1. Redistributions of source code must retain copyright statements and</em>
<a name="189" href="#189">189</a> <em class="comment"> * notices. Redistributions must also contain a copy of this document.</em>
<a name="190" href="#190">190</a> <em class="comment"> * </em>
<a name="191" href="#191">191</a> <em class="comment"> * 2. Redistributions in binary form must reproduce the above copyright notice,</em>
<a name="192" href="#192">192</a> <em class="comment"> * this list of conditions and the following disclaimer in the documentation</em>
<a name="193" href="#193">193</a> <em class="comment"> * and/or other materials provided with the distribution.</em>
<a name="194" href="#194">194</a> <em class="comment"> * </em>
<a name="195" href="#195">195</a> <em class="comment"> * 3. The name "DOM4J" must not be used to endorse or promote products derived</em>
<a name="196" href="#196">196</a> <em class="comment"> * from this Software without prior written permission of MetaStuff, Ltd. For</em>
<a name="197" href="#197">197</a> <em class="comment"> * written permission, please contact dom4j-info@metastuff.com.</em>
<a name="198" href="#198">198</a> <em class="comment"> * </em>
<a name="199" href="#199">199</a> <em class="comment"> * 4. Products derived from this Software may not be called "DOM4J" nor may</em>
<a name="200" href="#200">200</a> <em class="comment"> * "DOM4J" appear in their names without prior written permission of MetaStuff,</em>
<a name="201" href="#201">201</a> <em class="comment"> * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.</em>
<a name="202" href="#202">202</a> <em class="comment"> * </em>
<a name="203" href="#203">203</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="204" href="#204">204</a> <em class="comment"> * </em>
<a name="205" href="#205">205</a> <em class="comment"> * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND</em>
<a name="206" href="#206">206</a> <em class="comment"> * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE</em>
<a name="207" href="#207">207</a> <em class="comment"> * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE</em>
<a name="208" href="#208">208</a> <em class="comment"> * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE</em>
<a name="209" href="#209">209</a> <em class="comment"> * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR</em>
<a name="210" href="#210">210</a> <em class="comment"> * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF</em>
<a name="211" href="#211">211</a> <em class="comment"> * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS</em>
<a name="212" href="#212">212</a> <em class="comment"> * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN</em>
<a name="213" href="#213">213</a> <em class="comment"> * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)</em>
<a name="214" href="#214">214</a> <em class="comment"> * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE</em>
<a name="215" href="#215">215</a> <em class="comment"> * POSSIBILITY OF SUCH DAMAGE.</em>
<a name="216" href="#216">216</a> <em class="comment"> * </em>
<a name="217" href="#217">217</a> <em class="comment"> * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.</em>
<a name="218" href="#218">218</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>
See more files for this project here