This file is indexed.

/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/iterators/CollatingIterator.html is in libcommons-collections-java-doc 2.1.1-11.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_21) on Mon Apr 29 13:52:00 UTC 2013 -->
<title>CollatingIterator (Jakarta Commons Collections Package)</title>
<meta name="date" content="2013-04-29">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="CollatingIterator (Jakarta Commons Collections Package)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/collections/iterators/ArrayIterator.html" title="class in org.apache.commons.collections.iterators"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/collections/iterators/EmptyIterator.html" title="class in org.apache.commons.collections.iterators"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/collections/iterators/CollatingIterator.html" target="_top">Frames</a></li>
<li><a href="CollatingIterator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.collections.iterators</div>
<h2 title="Class CollatingIterator" class="title">Class CollatingIterator</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.iterators.CollatingIterator</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.util.Iterator</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">CollatingIterator</span>
extends java.lang.Object
implements java.util.Iterator</pre>
<div class="block">Provides an ordered iteration over the elements contained in
 a collection of ordered <code>Iterator</code>s.  In other words,
 given two ordered <code>Iterator</code>s <code>A</code> and <code>B</code>,
 my <a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#next()"><code>next()</code></a> method will return the lesser of 
 <code>A.next()</code> and <code>B.next()</code>.</div>
<dl><dt><span class="strong">Since:</span></dt>
  <dd>2.1</dd>
<dt><span class="strong">Version:</span></dt>
  <dd>$Revision: 1.3.2.1 $ $Date: 2004/05/22 12:14:04 $</dd>
<dt><span class="strong">Author:</span></dt>
  <dd>Rodney Waldhoff, <a href="mailto:scolebourne@joda.org">Stephen Colebourne</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#CollatingIterator()">CollatingIterator</a></strong>()</code>
<div class="block">Constructs a new <Code>CollatingIterator</Code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#CollatingIterator(java.util.Comparator)">CollatingIterator</a></strong>(java.util.Comparator&nbsp;comp)</code>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will used the
 specified comparator for ordering.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#CollatingIterator(java.util.Comparator, java.util.Collection)">CollatingIterator</a></strong>(java.util.Comparator&nbsp;comp,
                 java.util.Collection&nbsp;iterators)</code>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will use the
 specified comparator to provide ordered iteration over the collection
 of iterators.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#CollatingIterator(java.util.Comparator, int)">CollatingIterator</a></strong>(java.util.Comparator&nbsp;comp,
                 int&nbsp;initIterCapacity)</code>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will used the
 specified comparator for ordering and have the specified initial
 capacity.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#CollatingIterator(java.util.Comparator, java.util.Iterator[])">CollatingIterator</a></strong>(java.util.Comparator&nbsp;comp,
                 java.util.Iterator[]&nbsp;iterators)</code>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will use the
 specified comparator to provide ordered iteration over the array
 of iterators.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#CollatingIterator(java.util.Comparator, java.util.Iterator, java.util.Iterator)">CollatingIterator</a></strong>(java.util.Comparator&nbsp;comp,
                 java.util.Iterator&nbsp;a,
                 java.util.Iterator&nbsp;b)</code>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will use the
 specified comparator to provide ordered iteration over the two
 given iterators.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#addIterator(java.util.Iterator)">addIterator</a></strong>(java.util.Iterator&nbsp;iterator)</code>
<div class="block">Add the given <code>Iterator</code> to my collection to collate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.Comparator</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#getComparator()">getComparator</a></strong>()</code>
<div class="block">Get the <code>Comparator</code> by which I collate.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#getIterators()">getIterators</a></strong>()</code>
<div class="block">Get the list of Iterators (unmodifiable)</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#hasNext()">hasNext</a></strong>()</code>
<div class="block">Returns <Code>true</Code> if any child iterator has remaining elements.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#next()">next</a></strong>()</code>
<div class="block">Returns the next ordered element from a child iterator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#remove()">remove</a></strong>()</code>
<div class="block">Removes the last returned element from the child iterator that 
  produced it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#setComparator(java.util.Comparator)">setComparator</a></strong>(java.util.Comparator&nbsp;comp)</code>
<div class="block">Set the <code>Comparator</code> by which I collate.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#setIterator(int, java.util.Iterator)">setIterator</a></strong>(int&nbsp;index,
           java.util.Iterator&nbsp;iterator)</code>
<div class="block">Set the Iterator at the given index</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="CollatingIterator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CollatingIterator</h4>
<pre>public&nbsp;CollatingIterator()</pre>
<div class="block">Constructs a new <Code>CollatingIterator</Code>.  Natural sort order
 will be used, and child iterators will have to be manually added 
 using the <a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#addIterator(java.util.Iterator)"><code>addIterator(Iterator)</code></a> method.</div>
</li>
</ul>
<a name="CollatingIterator(java.util.Comparator)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CollatingIterator</h4>
<pre>public&nbsp;CollatingIterator(java.util.Comparator&nbsp;comp)</pre>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will used the
 specified comparator for ordering.  Child iterators will have to be 
 manually added using the <a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#addIterator(java.util.Iterator)"><code>addIterator(Iterator)</code></a> method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - the comparator to use for ordering, or <Code>null</Code>
    to use natural sort order</dd></dl>
</li>
</ul>
<a name="CollatingIterator(java.util.Comparator, java.util.Collection)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CollatingIterator</h4>
<pre>public&nbsp;CollatingIterator(java.util.Comparator&nbsp;comp,
                 java.util.Collection&nbsp;iterators)</pre>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will use the
 specified comparator to provide ordered iteration over the collection
 of iterators.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - the comparator to use to sort, or null to use natural
    sort order</dd><dd><code>iterators</code> - the collection of iterators</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the iterators collection is or contains null</dd>
<dd><code>java.lang.ClassCastException</code> - if the iterators collection contains an
         element that's not an <code>Iterator</code></dd></dl>
</li>
</ul>
<a name="CollatingIterator(java.util.Comparator, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CollatingIterator</h4>
<pre>public&nbsp;CollatingIterator(java.util.Comparator&nbsp;comp,
                 int&nbsp;initIterCapacity)</pre>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will used the
 specified comparator for ordering and have the specified initial
 capacity.  Child iterators will have to be 
 manually added using the <a href="../../../../../org/apache/commons/collections/iterators/CollatingIterator.html#addIterator(java.util.Iterator)"><code>addIterator(Iterator)</code></a> method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - the comparator to use for ordering, or <Code>null</Code>
    to use natural sort order</dd><dd><code>initIterCapacity</code> - the initial capacity for the internal list
    of child iterators</dd></dl>
</li>
</ul>
<a name="CollatingIterator(java.util.Comparator, java.util.Iterator[])">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CollatingIterator</h4>
<pre>public&nbsp;CollatingIterator(java.util.Comparator&nbsp;comp,
                 java.util.Iterator[]&nbsp;iterators)</pre>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will use the
 specified comparator to provide ordered iteration over the array
 of iterators.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - the comparator to use to sort, or null to use natural
    sort order</dd><dd><code>iterators</code> - the array of iterators</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterators array is or contains null</dd></dl>
</li>
</ul>
<a name="CollatingIterator(java.util.Comparator, java.util.Iterator, java.util.Iterator)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CollatingIterator</h4>
<pre>public&nbsp;CollatingIterator(java.util.Comparator&nbsp;comp,
                 java.util.Iterator&nbsp;a,
                 java.util.Iterator&nbsp;b)</pre>
<div class="block">Constructs a new <Code>CollatingIterator</Code> that will use the
 specified comparator to provide ordered iteration over the two
 given iterators.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comp</code> - the comparator to use to sort, or null to use natural
    sort order</dd><dd><code>a</code> - the first child ordered iterator</dd><dd><code>b</code> - the second child ordered iterator</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either iterator is null</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="addIterator(java.util.Iterator)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addIterator</h4>
<pre>public&nbsp;void&nbsp;addIterator(java.util.Iterator&nbsp;iterator)</pre>
<div class="block">Add the given <code>Iterator</code> to my collection to collate.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if I've already started iterating</dd>
<dd><code>java.lang.NullPointerException</code> - if the iterator is null</dd></dl>
</li>
</ul>
<a name="getComparator()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getComparator</h4>
<pre>public&nbsp;java.util.Comparator&nbsp;getComparator()</pre>
<div class="block">Get the <code>Comparator</code> by which I collate.</div>
</li>
</ul>
<a name="getIterators()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIterators</h4>
<pre>public&nbsp;java.util.List&nbsp;getIterators()</pre>
<div class="block">Get the list of Iterators (unmodifiable)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the unmodifiable list of iterators added</dd></dl>
</li>
</ul>
<a name="hasNext()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNext</h4>
<pre>public&nbsp;boolean&nbsp;hasNext()</pre>
<div class="block">Returns <Code>true</Code> if any child iterator has remaining elements.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>hasNext</code>&nbsp;in interface&nbsp;<code>java.util.Iterator</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if this iterator has remaining elements</dd></dl>
</li>
</ul>
<a name="next()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>next</h4>
<pre>public&nbsp;java.lang.Object&nbsp;next()
                      throws java.util.NoSuchElementException</pre>
<div class="block">Returns the next ordered element from a child iterator.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>next</code>&nbsp;in interface&nbsp;<code>java.util.Iterator</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the next ordered element</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.util.NoSuchElementException</code> - if no child iterator has any more
    elements</dd></dl>
</li>
</ul>
<a name="remove()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>public&nbsp;void&nbsp;remove()</pre>
<div class="block">Removes the last returned element from the child iterator that 
  produced it.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>remove</code>&nbsp;in interface&nbsp;<code>java.util.Iterator</code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if there is no last returned element,
    or if the last returned element has already been removed</dd></dl>
</li>
</ul>
<a name="setComparator(java.util.Comparator)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setComparator</h4>
<pre>public&nbsp;void&nbsp;setComparator(java.util.Comparator&nbsp;comp)</pre>
<div class="block">Set the <code>Comparator</code> by which I collate.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if I've already started iterating</dd></dl>
</li>
</ul>
<a name="setIterator(int, java.util.Iterator)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setIterator</h4>
<pre>public&nbsp;void&nbsp;setIterator(int&nbsp;index,
               java.util.Iterator&nbsp;iterator)
                 throws java.lang.IndexOutOfBoundsException</pre>
<div class="block">Set the Iterator at the given index</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index of the Iterator to replace</dd><dd><code>iterator</code> - Iterator to place at the given index</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if index &lt; 0 or index &gt; size()</dd>
<dd><code>java.lang.IllegalStateException</code> - if I've already started iterating</dd>
<dd><code>java.lang.NullPointerException</code> - if the iterator is null</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/collections/iterators/ArrayIterator.html" title="class in org.apache.commons.collections.iterators"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/collections/iterators/EmptyIterator.html" title="class in org.apache.commons.collections.iterators"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/collections/iterators/CollatingIterator.html" target="_top">Frames</a></li>
<li><a href="CollatingIterator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><small>Copyright &copy; 2001-2004 Apache Software Foundation. Documenation generated April 29 2013</small>.</small></p>
</body>
</html>