blob: 83eefc7e96b1df021422a8108c3e73b031a48105 [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>ArrayIterator xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../apidocs/org/apache/velocity/util/ArrayIterator.html">View Javadoc</a></div><pre>
<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.util;
<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.util.Iterator;
<a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.util.NoSuchElementException;
<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.lang.reflect.Array;
<a name="25" href="#25">25</a>
<a name="26" href="#26">26</a>
<a name="27" href="#27">27</a> <em class="jxr_javadoccomment">/**</em>
<a name="28" href="#28">28</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="29" href="#29">29</a> <em class="jxr_javadoccomment"> * An Iterator wrapper for an Object[]. This will</em>
<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * allow us to deal with all array like structures</em>
<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * in a consistent manner.</em>
<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * &lt;p&gt;</em>
<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * WARNING : this class's operations are NOT synchronized.</em>
<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * It is meant to be used in a single thread, newly created</em>
<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * for each use in the #foreach() directive.</em>
<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * If this is used or shared, synchronize in the</em>
<a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * next() method.</em>
<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> * &lt;/p&gt;</em>
<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> *</em>
<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:jvanzyl@apache.org" target="alexandria_uri">mailto:jvanzyl@apache.org</a>"&gt;Jason van Zyl&lt;/a&gt;</em>
<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @author &lt;a href="<a href="mailto:geirm@apache.org" target="alexandria_uri">mailto:geirm@apache.org</a>"&gt;Geir Magnusson Jr.&lt;/a&gt;</em>
<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @version $Id: ArrayIterator.java 463298 2006-10-12 16:10:32Z henning $</em>
<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
<a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/velocity/util/ArrayIterator.html">ArrayIterator</a> implements Iterator
<a name="46" href="#46">46</a> {
<a name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em>
<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * The objects to iterate.</em>
<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em>
<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> Object array;
<a name="51" href="#51">51</a>
<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em>
<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * The current position and size in the array.</em>
<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em>
<a name="55" href="#55">55</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> pos;
<a name="56" href="#56">56</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> size;
<a name="57" href="#57">57</a>
<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em>
<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * Creates a new iterator instance for the specified array.</em>
<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em>
<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @param array The array for which an iterator is desired.</em>
<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em>
<a name="63" href="#63">63</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/util/ArrayIterator.html">ArrayIterator</a>(Object array)
<a name="64" href="#64">64</a> {
<a name="65" href="#65">65</a> <em class="jxr_comment">/*</em>
<a name="66" href="#66">66</a> <em class="jxr_comment"> * if this isn't an array, then throw. Note that this is</em>
<a name="67" href="#67">67</a> <em class="jxr_comment"> * for internal use - so this should never happen - if it does</em>
<a name="68" href="#68">68</a> <em class="jxr_comment"> * we screwed up.</em>
<a name="69" href="#69">69</a> <em class="jxr_comment"> */</em>
<a name="70" href="#70">70</a>
<a name="71" href="#71">71</a> <strong class="jxr_keyword">if</strong> ( !array.getClass().isArray() )
<a name="72" href="#72">72</a> {
<a name="73" href="#73">73</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalArgumentException(
<a name="74" href="#74">74</a> <span class="jxr_string">"Programmer error : internal ArrayIterator invoked w/o array"</span>);
<a name="75" href="#75">75</a> }
<a name="76" href="#76">76</a>
<a name="77" href="#77">77</a> <strong class="jxr_keyword">this</strong>.array = array;
<a name="78" href="#78">78</a> pos = 0;
<a name="79" href="#79">79</a> size = Array.getLength( <strong class="jxr_keyword">this</strong>.array );
<a name="80" href="#80">80</a> }
<a name="81" href="#81">81</a>
<a name="82" href="#82">82</a> <em class="jxr_javadoccomment">/**</em>
<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * Move to next element in the array.</em>
<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> *</em>
<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @return The next object in the array.</em>
<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em>
<a name="87" href="#87">87</a> <strong class="jxr_keyword">public</strong> Object next()
<a name="88" href="#88">88</a> {
<a name="89" href="#89">89</a> <strong class="jxr_keyword">if</strong> (pos &lt; size )
<a name="90" href="#90">90</a> <strong class="jxr_keyword">return</strong> Array.get( array, pos++);
<a name="91" href="#91">91</a>
<a name="92" href="#92">92</a> <em class="jxr_comment">/*</em>
<a name="93" href="#93">93</a> <em class="jxr_comment"> * we screwed up...</em>
<a name="94" href="#94">94</a> <em class="jxr_comment"> */</em>
<a name="95" href="#95">95</a>
<a name="96" href="#96">96</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NoSuchElementException(<span class="jxr_string">"No more elements: "</span> + pos +
<a name="97" href="#97">97</a> <span class="jxr_string">" / "</span> + size);
<a name="98" href="#98">98</a> }
<a name="99" href="#99">99</a>
<a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em>
<a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Check to see if there is another element in the array.</em>
<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> *</em>
<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @return Whether there is another element.</em>
<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> */</em>
<a name="105" href="#105">105</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasNext()
<a name="106" href="#106">106</a> {
<a name="107" href="#107">107</a> <strong class="jxr_keyword">return</strong> (pos &lt; size );
<a name="108" href="#108">108</a> }
<a name="109" href="#109">109</a>
<a name="110" href="#110">110</a> <em class="jxr_javadoccomment">/**</em>
<a name="111" href="#111">111</a> <em class="jxr_javadoccomment"> * No op--merely added to satify the &lt;code&gt;Iterator&lt;/code&gt; interface.</em>
<a name="112" href="#112">112</a> <em class="jxr_javadoccomment"> */</em>
<a name="113" href="#113">113</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> remove()
<a name="114" href="#114">114</a> {
<a name="115" href="#115">115</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnsupportedOperationException();
<a name="116" href="#116">116</a> }
<a name="117" href="#117">117</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>