?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
a whole bunch of stuff
[ephemerata.git] / KezvhLib / lib / org.apache.commons.collections / apidocs / org / apache / commons / collections / iterators / ObjectArrayListIterator.html
blob9fbfd3d1ffc42c5dd2e2e792208234a217abead9
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <!--NewPage-->
3 <HTML>
4 <HEAD>
5 <!-- Generated by javadoc (build 1.5.0_07) on Fri Apr 11 15:39:20 BST 2008 -->
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7 <TITLE>
8 ObjectArrayListIterator (Commons Collections 3.2.1 API)
9 </TITLE>
10
11 <META NAME="keywords" CONTENT="org.apache.commons.collections.iterators.ObjectArrayListIterator class">
12
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
14
15 <SCRIPT type="text/javascript">
16 function windowTitle()
17 {
18 parent.document.title="ObjectArrayListIterator (Commons Collections 3.2.1 API)";
19 }
20 </SCRIPT>
21 <NOSCRIPT>
22 </NOSCRIPT>
23
24 </HEAD>
25
26 <BODY BGCOLOR="white" onload="windowTitle();">
27
28
29 <!-- ========= START OF TOP NAVBAR ======= -->
30 <A NAME="navbar_top"><!-- --></A>
31 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
32 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
33 <TR>
34 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
35 <A NAME="navbar_top_firstrow"><!-- --></A>
36 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
37 <TR ALIGN="center" VALIGN="top">
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ObjectArrayListIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
46 </TR>
47 </TABLE>
48 </TD>
49 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
50 </EM>
51 </TD>
52 </TR>
53
54 <TR>
55 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
56 &nbsp;<A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html" title="class in org.apache.commons.collections.iterators"><B>PREV CLASS</B></A>&nbsp;
57 &nbsp;<A HREF="../../../../../org/apache/commons/collections/iterators/ObjectGraphIterator.html" title="class in org.apache.commons.collections.iterators"><B>NEXT CLASS</B></A></FONT></TD>
58 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59 <A HREF="../../../../../index.html?org/apache/commons/collections/iterators/ObjectArrayListIterator.html" target="_top"><B>FRAMES</B></A> &nbsp;
60 &nbsp;<A HREF="ObjectArrayListIterator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
61 &nbsp;<SCRIPT type="text/javascript">
62 <!--
63 if(window==top) {
64 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
65 }
66 //-->
67 </SCRIPT>
68 <NOSCRIPT>
69 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
70 </NOSCRIPT>
71
72
73 </FONT></TD>
74 </TR>
75 <TR>
76 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
78 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
79 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
80 </TR>
81 </TABLE>
82 <A NAME="skip-navbar_top"></A>
83 <!-- ========= END OF TOP NAVBAR ========= -->
84
85 <HR>
86 <!-- ======== START OF CLASS DATA ======== -->
87 <H2>
88 <FONT SIZE="-1">
89 org.apache.commons.collections.iterators</FONT>
90 <BR>
91 Class ObjectArrayListIterator</H2>
92 <PRE>
93 java.lang.Object
94 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html" title="class in org.apache.commons.collections.iterators">org.apache.commons.collections.iterators.ObjectArrayIterator</A>
95 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.commons.collections.iterators.ObjectArrayListIterator</B>
96 </PRE>
97 <DL>
98 <DT><B>All Implemented Interfaces:</B> <DD>java.util.Iterator, java.util.ListIterator, <A HREF="../../../../../org/apache/commons/collections/ResettableIterator.html" title="interface in org.apache.commons.collections">ResettableIterator</A>, <A HREF="../../../../../org/apache/commons/collections/ResettableListIterator.html" title="interface in org.apache.commons.collections">ResettableListIterator</A></DD>
99 </DL>
100 <HR>
101 <DL>
102 <DT><PRE>public class <B>ObjectArrayListIterator</B><DT>extends <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html" title="class in org.apache.commons.collections.iterators">ObjectArrayIterator</A><DT>implements java.util.ListIterator, <A HREF="../../../../../org/apache/commons/collections/ResettableListIterator.html" title="interface in org.apache.commons.collections">ResettableListIterator</A></DL>
103 </PRE>
104
105 <P>
106 Implements a <CODE>ListIterator</CODE> over an array of objects.
107 <p>
108 This iterator does not support <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#add(java.lang.Object)"><CODE>add(java.lang.Object)</CODE></A> or <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#remove()"><CODE>ObjectArrayIterator.remove()</CODE></A>, as the object array
109 cannot be structurally modified. The <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#set(java.lang.Object)"><CODE>set(java.lang.Object)</CODE></A> method is supported however.
110 <p>
111 The iterator implements a <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#reset()"><CODE>reset()</CODE></A> method, allowing the reset of the iterator
112 back to the start if required.
113 <P>
114
115 <P>
116 <DL>
117 <DT><B>Since:</B></DT>
118 <DD>Commons Collections 3.0</DD>
119 <DT><B>Version:</B></DT>
120 <DD>$Revision: 647116 $ $Date: 2008-04-11 12:23:08 +0100 (Fri, 11 Apr 2008) $</DD>
121 <DT><B>Author:</B></DT>
122 <DD>Neil O'Toole, Stephen Colebourne, Phil Steitz</DD>
123 <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html" title="class in org.apache.commons.collections.iterators"><CODE>ObjectArrayIterator</CODE></A>,
124 <CODE>Iterator</CODE>,
125 <CODE>ListIterator</CODE></DL>
126 <HR>
127
128 <P>
129 <!-- =========== FIELD SUMMARY =========== -->
130
131 <A NAME="field_summary"><!-- --></A>
132 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
133 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
134 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
135 <B>Field Summary</B></FONT></TH>
136 </TR>
137 <TR BGCOLOR="white" CLASS="TableRowColor">
138 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
139 <CODE>protected &nbsp;int</CODE></FONT></TD>
140 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#lastItemIndex">lastItemIndex</A></B></CODE>
141
142 <BR>
143 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Holds the index of the last item returned by a call to <code>next()</code>
144 or <code>previous()</code>.</TD>
145 </TR>
146 </TABLE>
147 &nbsp;<A NAME="fields_inherited_from_class_org.apache.commons.collections.iterators.ObjectArrayIterator"><!-- --></A>
148 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
149 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
150 <TH ALIGN="left"><B>Fields inherited from class org.apache.commons.collections.iterators.<A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html" title="class in org.apache.commons.collections.iterators">ObjectArrayIterator</A></B></TH>
151 </TR>
152 <TR BGCOLOR="white" CLASS="TableRowColor">
153 <TD><CODE><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#array">array</A>, <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#endIndex">endIndex</A>, <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#index">index</A>, <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#startIndex">startIndex</A></CODE></TD>
154 </TR>
155 </TABLE>
156 &nbsp;
157 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
158
159 <A NAME="constructor_summary"><!-- --></A>
160 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
161 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
162 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
163 <B>Constructor Summary</B></FONT></TH>
164 </TR>
165 <TR BGCOLOR="white" CLASS="TableRowColor">
166 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#ObjectArrayListIterator()">ObjectArrayListIterator</A></B>()</CODE>
167
168 <BR>
169 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor for use with <code>setArray</code>.</TD>
170 </TR>
171 <TR BGCOLOR="white" CLASS="TableRowColor">
172 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#ObjectArrayListIterator(java.lang.Object[])">ObjectArrayListIterator</A></B>(java.lang.Object[]&nbsp;array)</CODE>
173
174 <BR>
175 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an ObjectArrayListIterator that will iterate over the values in the
176 specified array.</TD>
177 </TR>
178 <TR BGCOLOR="white" CLASS="TableRowColor">
179 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#ObjectArrayListIterator(java.lang.Object[], int)">ObjectArrayListIterator</A></B>(java.lang.Object[]&nbsp;array,
180 int&nbsp;start)</CODE>
181
182 <BR>
183 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs an ObjectArrayListIterator that will iterate over the values in the
184 specified array from a specific start index.</TD>
185 </TR>
186 <TR BGCOLOR="white" CLASS="TableRowColor">
187 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#ObjectArrayListIterator(java.lang.Object[], int, int)">ObjectArrayListIterator</A></B>(java.lang.Object[]&nbsp;array,
188 int&nbsp;start,
189 int&nbsp;end)</CODE>
190
191 <BR>
192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Construct an ObjectArrayListIterator that will iterate over a range of values
193 in the specified array.</TD>
194 </TR>
195 </TABLE>
196 &nbsp;
197 <!-- ========== METHOD SUMMARY =========== -->
198
199 <A NAME="method_summary"><!-- --></A>
200 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
201 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
202 <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
203 <B>Method Summary</B></FONT></TH>
204 </TR>
205 <TR BGCOLOR="white" CLASS="TableRowColor">
206 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207 <CODE>&nbsp;void</CODE></FONT></TD>
208 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#add(java.lang.Object)">add</A></B>(java.lang.Object&nbsp;obj)</CODE>
209
210 <BR>
211 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This iterator does not support modification of its backing array's size, and so will
212 always throw an <CODE>UnsupportedOperationException</CODE> when this method is invoked.</TD>
213 </TR>
214 <TR BGCOLOR="white" CLASS="TableRowColor">
215 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216 <CODE>&nbsp;boolean</CODE></FONT></TD>
217 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#hasPrevious()">hasPrevious</A></B>()</CODE>
218
219 <BR>
220 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if there are previous elements to return from the array.</TD>
221 </TR>
222 <TR BGCOLOR="white" CLASS="TableRowColor">
223 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
224 <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
225 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#next()">next</A></B>()</CODE>
226
227 <BR>
228 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the next element from the array.</TD>
229 </TR>
230 <TR BGCOLOR="white" CLASS="TableRowColor">
231 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232 <CODE>&nbsp;int</CODE></FONT></TD>
233 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#nextIndex()">nextIndex</A></B>()</CODE>
234
235 <BR>
236 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the next index to be retrieved.</TD>
237 </TR>
238 <TR BGCOLOR="white" CLASS="TableRowColor">
239 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
240 <CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
241 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#previous()">previous</A></B>()</CODE>
242
243 <BR>
244 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the previous element from the array.</TD>
245 </TR>
246 <TR BGCOLOR="white" CLASS="TableRowColor">
247 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
248 <CODE>&nbsp;int</CODE></FONT></TD>
249 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#previousIndex()">previousIndex</A></B>()</CODE>
250
251 <BR>
252 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the index of the item to be retrieved if <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#previous()"><CODE>previous()</CODE></A> is called.</TD>
253 </TR>
254 <TR BGCOLOR="white" CLASS="TableRowColor">
255 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
256 <CODE>&nbsp;void</CODE></FONT></TD>
257 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#reset()">reset</A></B>()</CODE>
258
259 <BR>
260 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Resets the iterator back to the start index.</TD>
261 </TR>
262 <TR BGCOLOR="white" CLASS="TableRowColor">
263 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
264 <CODE>&nbsp;void</CODE></FONT></TD>
265 <TD><CODE><B><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#set(java.lang.Object)">set</A></B>(java.lang.Object&nbsp;obj)</CODE>
266
267 <BR>
268 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the element under the cursor.</TD>
269 </TR>
270 </TABLE>
271 &nbsp;<A NAME="methods_inherited_from_class_org.apache.commons.collections.iterators.ObjectArrayIterator"><!-- --></A>
272 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
273 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
274 <TH ALIGN="left"><B>Methods inherited from class org.apache.commons.collections.iterators.<A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html" title="class in org.apache.commons.collections.iterators">ObjectArrayIterator</A></B></TH>
275 </TR>
276 <TR BGCOLOR="white" CLASS="TableRowColor">
277 <TD><CODE><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#getArray()">getArray</A>, <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#getEndIndex()">getEndIndex</A>, <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#getStartIndex()">getStartIndex</A>, <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#hasNext()">hasNext</A>, <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#remove()">remove</A>, <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#setArray(java.lang.Object[])">setArray</A></CODE></TD>
278 </TR>
279 </TABLE>
280 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
281 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
282 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
283 <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
284 </TR>
285 <TR BGCOLOR="white" CLASS="TableRowColor">
286 <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
287 </TR>
288 </TABLE>
289 &nbsp;
290 <P>
291
292 <!-- ============ FIELD DETAIL =========== -->
293
294 <A NAME="field_detail"><!-- --></A>
295 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
296 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
297 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
298 <B>Field Detail</B></FONT></TH>
299 </TR>
300 </TABLE>
301
302 <A NAME="lastItemIndex"><!-- --></A><H3>
303 lastItemIndex</H3>
304 <PRE>
305 protected int <B>lastItemIndex</B></PRE>
306 <DL>
307 <DD>Holds the index of the last item returned by a call to <code>next()</code>
308 or <code>previous()</code>. This is set to <code>-1</code> if neither method
309 has yet been invoked. <code>lastItemIndex</code> is used to to implement the
310 <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#set(java.lang.Object)"><CODE>set(java.lang.Object)</CODE></A> method.
311 <P>
312 <DL>
313 </DL>
314 </DL>
315
316 <!-- ========= CONSTRUCTOR DETAIL ======== -->
317
318 <A NAME="constructor_detail"><!-- --></A>
319 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
320 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
321 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
322 <B>Constructor Detail</B></FONT></TH>
323 </TR>
324 </TABLE>
325
326 <A NAME="ObjectArrayListIterator()"><!-- --></A><H3>
327 ObjectArrayListIterator</H3>
328 <PRE>
329 public <B>ObjectArrayListIterator</B>()</PRE>
330 <DL>
331 <DD>Constructor for use with <code>setArray</code>.
332 <p>
333 Using this constructor, the iterator is equivalent to an empty iterator
334 until <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#setArray(java.lang.Object[])"><CODE>ObjectArrayIterator.setArray(java.lang.Object[])</CODE></A> is called to establish the array to iterate over.
335 <P>
336 </DL>
337 <HR>
338
339 <A NAME="ObjectArrayListIterator(java.lang.Object[])"><!-- --></A><H3>
340 ObjectArrayListIterator</H3>
341 <PRE>
342 public <B>ObjectArrayListIterator</B>(java.lang.Object[]&nbsp;array)</PRE>
343 <DL>
344 <DD>Constructs an ObjectArrayListIterator that will iterate over the values in the
345 specified array.
346 <P>
347 <DL>
348 <DT><B>Parameters:</B><DD><CODE>array</CODE> - the array to iterate over
349 <DT><B>Throws:</B>
350 <DD><CODE>java.lang.NullPointerException</CODE> - if <code>array</code> is <code>null</code></DL>
351 </DL>
352 <HR>
353
354 <A NAME="ObjectArrayListIterator(java.lang.Object[], int)"><!-- --></A><H3>
355 ObjectArrayListIterator</H3>
356 <PRE>
357 public <B>ObjectArrayListIterator</B>(java.lang.Object[]&nbsp;array,
358 int&nbsp;start)</PRE>
359 <DL>
360 <DD>Constructs an ObjectArrayListIterator that will iterate over the values in the
361 specified array from a specific start index.
362 <P>
363 <DL>
364 <DT><B>Parameters:</B><DD><CODE>array</CODE> - the array to iterate over<DD><CODE>start</CODE> - the index to start iterating at
365 <DT><B>Throws:</B>
366 <DD><CODE>java.lang.NullPointerException</CODE> - if <code>array</code> is <code>null</code>
367 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the start index is out of bounds</DL>
368 </DL>
369 <HR>
370
371 <A NAME="ObjectArrayListIterator(java.lang.Object[], int, int)"><!-- --></A><H3>
372 ObjectArrayListIterator</H3>
373 <PRE>
374 public <B>ObjectArrayListIterator</B>(java.lang.Object[]&nbsp;array,
375 int&nbsp;start,
376 int&nbsp;end)</PRE>
377 <DL>
378 <DD>Construct an ObjectArrayListIterator that will iterate over a range of values
379 in the specified array.
380 <P>
381 <DL>
382 <DT><B>Parameters:</B><DD><CODE>array</CODE> - the array to iterate over<DD><CODE>start</CODE> - the index to start iterating at<DD><CODE>end</CODE> - the index (exclusive) to finish iterating at
383 <DT><B>Throws:</B>
384 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the start or end index is out of bounds
385 <DD><CODE>java.lang.IllegalArgumentException</CODE> - if end index is before the start
386 <DD><CODE>java.lang.NullPointerException</CODE> - if <code>array</code> is <code>null</code></DL>
387 </DL>
388
389 <!-- ============ METHOD DETAIL ========== -->
390
391 <A NAME="method_detail"><!-- --></A>
392 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
393 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
394 <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
395 <B>Method Detail</B></FONT></TH>
396 </TR>
397 </TABLE>
398
399 <A NAME="hasPrevious()"><!-- --></A><H3>
400 hasPrevious</H3>
401 <PRE>
402 public boolean <B>hasPrevious</B>()</PRE>
403 <DL>
404 <DD>Returns true if there are previous elements to return from the array.
405 <P>
406 <DD><DL>
407 <DT><B>Specified by:</B><DD><CODE>hasPrevious</CODE> in interface <CODE>java.util.ListIterator</CODE></DL>
408 </DD>
409 <DD><DL>
410
411 <DT><B>Returns:</B><DD>true if there is a previous element to return</DL>
412 </DD>
413 </DL>
414 <HR>
415
416 <A NAME="previous()"><!-- --></A><H3>
417 previous</H3>
418 <PRE>
419 public java.lang.Object <B>previous</B>()</PRE>
420 <DL>
421 <DD>Gets the previous element from the array.
422 <P>
423 <DD><DL>
424 <DT><B>Specified by:</B><DD><CODE>previous</CODE> in interface <CODE>java.util.ListIterator</CODE></DL>
425 </DD>
426 <DD><DL>
427
428 <DT><B>Returns:</B><DD>the previous element
429 <DT><B>Throws:</B>
430 <DD><CODE>java.util.NoSuchElementException</CODE> - if there is no previous element</DL>
431 </DD>
432 </DL>
433 <HR>
434
435 <A NAME="next()"><!-- --></A><H3>
436 next</H3>
437 <PRE>
438 public java.lang.Object <B>next</B>()</PRE>
439 <DL>
440 <DD>Gets the next element from the array.
441 <P>
442 <DD><DL>
443 <DT><B>Specified by:</B><DD><CODE>next</CODE> in interface <CODE>java.util.Iterator</CODE><DT><B>Specified by:</B><DD><CODE>next</CODE> in interface <CODE>java.util.ListIterator</CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#next()">next</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html" title="class in org.apache.commons.collections.iterators">ObjectArrayIterator</A></CODE></DL>
444 </DD>
445 <DD><DL>
446
447 <DT><B>Returns:</B><DD>the next element
448 <DT><B>Throws:</B>
449 <DD><CODE>java.util.NoSuchElementException</CODE> - if there is no next element</DL>
450 </DD>
451 </DL>
452 <HR>
453
454 <A NAME="nextIndex()"><!-- --></A><H3>
455 nextIndex</H3>
456 <PRE>
457 public int <B>nextIndex</B>()</PRE>
458 <DL>
459 <DD>Gets the next index to be retrieved.
460 <P>
461 <DD><DL>
462 <DT><B>Specified by:</B><DD><CODE>nextIndex</CODE> in interface <CODE>java.util.ListIterator</CODE></DL>
463 </DD>
464 <DD><DL>
465
466 <DT><B>Returns:</B><DD>the index of the item to be retrieved next</DL>
467 </DD>
468 </DL>
469 <HR>
470
471 <A NAME="previousIndex()"><!-- --></A><H3>
472 previousIndex</H3>
473 <PRE>
474 public int <B>previousIndex</B>()</PRE>
475 <DL>
476 <DD>Gets the index of the item to be retrieved if <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#previous()"><CODE>previous()</CODE></A> is called.
477 <P>
478 <DD><DL>
479 <DT><B>Specified by:</B><DD><CODE>previousIndex</CODE> in interface <CODE>java.util.ListIterator</CODE></DL>
480 </DD>
481 <DD><DL>
482
483 <DT><B>Returns:</B><DD>the index of the item to be retrieved next</DL>
484 </DD>
485 </DL>
486 <HR>
487
488 <A NAME="add(java.lang.Object)"><!-- --></A><H3>
489 add</H3>
490 <PRE>
491 public void <B>add</B>(java.lang.Object&nbsp;obj)</PRE>
492 <DL>
493 <DD>This iterator does not support modification of its backing array's size, and so will
494 always throw an <CODE>UnsupportedOperationException</CODE> when this method is invoked.
495 <P>
496 <DD><DL>
497 <DT><B>Specified by:</B><DD><CODE>add</CODE> in interface <CODE>java.util.ListIterator</CODE></DL>
498 </DD>
499 <DD><DL>
500 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to add
501 <DT><B>Throws:</B>
502 <DD><CODE>java.lang.UnsupportedOperationException</CODE> - always thrown.</DL>
503 </DD>
504 </DL>
505 <HR>
506
507 <A NAME="set(java.lang.Object)"><!-- --></A><H3>
508 set</H3>
509 <PRE>
510 public void <B>set</B>(java.lang.Object&nbsp;obj)</PRE>
511 <DL>
512 <DD>Sets the element under the cursor.
513 <p>
514 This method sets the element that was returned by the last call
515 to <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#next()"><CODE>next()</CODE></A> of <A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayListIterator.html#previous()"><CODE>previous()</CODE></A>.
516
517 <b>Note:</b> <CODE>ListIterator</CODE> implementations that support <code>add()</code>
518 and <code>remove()</code> only allow <code>set()</code> to be called once per call
519 to <code>next()</code> or <code>previous</code> (see the <CODE>ListIterator</CODE>
520 javadoc for more details). Since this implementation does not support
521 <code>add()</code> or <code>remove()</code>, <code>set()</code> may be
522 called as often as desired.
523 <P>
524 <DD><DL>
525 <DT><B>Specified by:</B><DD><CODE>set</CODE> in interface <CODE>java.util.ListIterator</CODE></DL>
526 </DD>
527 <DD><DL>
528 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to set into the array
529 <DT><B>Throws:</B>
530 <DD><CODE>java.lang.IllegalStateException</CODE> - if next() has not yet been called.
531 <DD><CODE>java.lang.ClassCastException</CODE> - if the object type is unsuitable for the array</DL>
532 </DD>
533 </DL>
534 <HR>
535
536 <A NAME="reset()"><!-- --></A><H3>
537 reset</H3>
538 <PRE>
539 public void <B>reset</B>()</PRE>
540 <DL>
541 <DD>Resets the iterator back to the start index.
542 <P>
543 <DD><DL>
544 <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/collections/ResettableIterator.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/collections/ResettableIterator.html" title="interface in org.apache.commons.collections">ResettableIterator</A></CODE><DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/commons/collections/ResettableListIterator.html#reset()">reset</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/commons/collections/ResettableListIterator.html" title="interface in org.apache.commons.collections">ResettableListIterator</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html#reset()">reset</A></CODE> in class <CODE><A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html" title="class in org.apache.commons.collections.iterators">ObjectArrayIterator</A></CODE></DL>
545 </DD>
546 <DD><DL>
547 </DL>
548 </DD>
549 </DL>
550 <!-- ========= END OF CLASS DATA ========= -->
551 <HR>
552
553
554 <!-- ======= START OF BOTTOM NAVBAR ====== -->
555 <A NAME="navbar_bottom"><!-- --></A>
556 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
557 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
558 <TR>
559 <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
560 <A NAME="navbar_bottom_firstrow"><!-- --></A>
561 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
562 <TR ALIGN="center" VALIGN="top">
563 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
564 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
565 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
566 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ObjectArrayListIterator.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
567 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
568 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
569 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
570 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
571 </TR>
572 </TABLE>
573 </TD>
574 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
575 </EM>
576 </TD>
577 </TR>
578
579 <TR>
580 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
581 &nbsp;<A HREF="../../../../../org/apache/commons/collections/iterators/ObjectArrayIterator.html" title="class in org.apache.commons.collections.iterators"><B>PREV CLASS</B></A>&nbsp;
582 &nbsp;<A HREF="../../../../../org/apache/commons/collections/iterators/ObjectGraphIterator.html" title="class in org.apache.commons.collections.iterators"><B>NEXT CLASS</B></A></FONT></TD>
583 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
584 <A HREF="../../../../../index.html?org/apache/commons/collections/iterators/ObjectArrayListIterator.html" target="_top"><B>FRAMES</B></A> &nbsp;
585 &nbsp;<A HREF="ObjectArrayListIterator.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
586 &nbsp;<SCRIPT type="text/javascript">
587 <!--
588 if(window==top) {
589 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
590 }
591 //-->
592 </SCRIPT>
593 <NOSCRIPT>
594 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
595 </NOSCRIPT>
596
597
598 </FONT></TD>
599 </TR>
600 <TR>
601 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
602 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
603 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
604 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
605 </TR>
606 </TABLE>
607 <A NAME="skip-navbar_bottom"></A>
608 <!-- ======== END OF BOTTOM NAVBAR ======= -->
609
610 <HR>
611 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
612 </BODY>
613 </HTML>
ephemerata