/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/IteratorUtils.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 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 | <!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>IteratorUtils (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="IteratorUtils (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>Prev Class</li>
<li><a href="../../../../org/apache/commons/collections/ListUtils.html" title="class in org.apache.commons.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/collections/IteratorUtils.html" target="_top">Frames</a></li>
<li><a href="IteratorUtils.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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</div>
<h2 title="Class IteratorUtils" class="title">Class IteratorUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.IteratorUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">IteratorUtils</span>
extends java.lang.Object</pre>
<div class="block">Provides static utility methods and decorators for <code>Iterator</code>
instances. The implementations are provided in the
<code>org.apache.commons.collections.iterators</code> subpackage.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.1</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: IteratorUtils.java,v 1.4.2.2 2004/05/22 12:14:01 scolebourne Exp $</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:scolebourne@joda.org">Stephen Colebourne</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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"> </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>static java.util.Enumeration</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#asEnumeration(java.util.Iterator)">asEnumeration</a></strong>(java.util.Iterator iterator)</code>
<div class="block">Gets an enumeration that wraps an iterator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#asIterator(java.util.Enumeration)">asIterator</a></strong>(java.util.Enumeration enumeration)</code>
<div class="block">Gets an iterator that provides an iterator view of the given enumeration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#asIterator(java.util.Enumeration, java.util.Collection)">asIterator</a></strong>(java.util.Enumeration enumeration,
java.util.Collection removeCollection)</code>
<div class="block">Gets an iterator that provides an iterator view of the given enumeration
that will remove elements from the specified collection.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#chainedIterator(java.util.Collection)">chainedIterator</a></strong>(java.util.Collection iterators)</code>
<div class="block">Gets an iterator that iterates through a collections of <code>Iterator</code>s
one after another.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#chainedIterator(java.util.Iterator[])">chainedIterator</a></strong>(java.util.Iterator[] iterators)</code>
<div class="block">Gets an iterator that iterates through an array of <code>Iterator</code>s
one after another.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#chainedIterator(java.util.Iterator, java.util.Iterator)">chainedIterator</a></strong>(java.util.Iterator iterator1,
java.util.Iterator iterator2)</code>
<div class="block">Gets an iterator that iterates through two <code>Iterator</code>s
one after another.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#collatedIterator(java.util.Comparator, java.util.Collection)">collatedIterator</a></strong>(java.util.Comparator comparator,
java.util.Collection iterators)</code>
<div class="block">Gets an iterator that provides an ordered iteration over the elements
contained in a collection of <code>Iterator</code>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#collatedIterator(java.util.Comparator, java.util.Iterator[])">collatedIterator</a></strong>(java.util.Comparator comparator,
java.util.Iterator[] iterators)</code>
<div class="block">Gets an iterator that provides an ordered iteration over the elements
contained in an array of <code>Iterator</code>s.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#collatedIterator(java.util.Comparator, java.util.Iterator, java.util.Iterator)">collatedIterator</a></strong>(java.util.Comparator comparator,
java.util.Iterator iterator1,
java.util.Iterator iterator2)</code>
<div class="block">Gets an iterator that provides an ordered iteration over the elements
contained in a collection of ordered <code>Iterator</code>s.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#filteredIterator(java.util.Iterator, org.apache.commons.collections.Predicate)">filteredIterator</a></strong>(java.util.Iterator iterator,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> predicate)</code>
<div class="block">Gets an iterator that filters another iterator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.ListIterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#filteredListIterator(java.util.ListIterator, org.apache.commons.collections.Predicate)">filteredListIterator</a></strong>(java.util.ListIterator listIterator,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> predicate)</code>
<div class="block">Gets a list iterator that filters another list iterator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#getIterator(java.lang.Object)">getIterator</a></strong>(java.lang.Object obj)</code>
<div class="block">Gets a suitable Iterator for the given object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.ListIterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#singletonListIterator(java.lang.Object)">singletonListIterator</a></strong>(java.lang.Object object)</code>
<div class="block">Gets a singleton list iterator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.Object[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#toArray(java.util.Iterator)">toArray</a></strong>(java.util.Iterator iterator)</code>
<div class="block">Gets an array based on an iterator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.Object[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#toArray(java.util.Iterator, java.lang.Class)">toArray</a></strong>(java.util.Iterator iterator,
java.lang.Class arrayClass)</code>
<div class="block">Gets an array based on an iterator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#toList(java.util.Iterator)">toList</a></strong>(java.util.Iterator iterator)</code>
<div class="block">Gets a list based on an iterator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#toList(java.util.Iterator, int)">toList</a></strong>(java.util.Iterator iterator,
int estimatedSize)</code>
<div class="block">Gets a list based on an iterator.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.ListIterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#toListIterator(java.util.Iterator)">toListIterator</a></strong>(java.util.Iterator iterator)</code>
<div class="block">Gets a list iterator based on a simple iterator.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.util.Iterator</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/IteratorUtils.html#transformedIterator(java.util.Iterator, org.apache.commons.collections.Transformer)">transformedIterator</a></strong>(java.util.Iterator iterator,
<a href="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</a> transform)</code>
<div class="block">Gets an iterator that transforms the elements of another iterator.</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 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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="asEnumeration(java.util.Iterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asEnumeration</h4>
<pre>public static java.util.Enumeration asEnumeration(java.util.Iterator iterator)</pre>
<div class="block">Gets an enumeration that wraps an iterator.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - the iterator to use, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterator is null</dd></dl>
</li>
</ul>
<a name="asIterator(java.util.Enumeration)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asIterator</h4>
<pre>public static java.util.Iterator asIterator(java.util.Enumeration enumeration)</pre>
<div class="block">Gets an iterator that provides an iterator view of the given enumeration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enumeration</code> - the enumeration to use</dd></dl>
</li>
</ul>
<a name="asIterator(java.util.Enumeration, java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>asIterator</h4>
<pre>public static java.util.Iterator asIterator(java.util.Enumeration enumeration,
java.util.Collection removeCollection)</pre>
<div class="block">Gets an iterator that provides an iterator view of the given enumeration
that will remove elements from the specified collection.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>enumeration</code> - the enumeration to use</dd><dd><code>collection</code> - the collection to remove elements form</dd></dl>
</li>
</ul>
<a name="chainedIterator(java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chainedIterator</h4>
<pre>public static java.util.Iterator chainedIterator(java.util.Collection iterators)</pre>
<div class="block">Gets an iterator that iterates through a collections of <code>Iterator</code>s
one after another.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterators</code> - the iterators to use, not null or empty or contain nulls</dd>
<dt><span class="strong">Returns:</span></dt><dd>a combination iterator over the iterators</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterators collection is null or contains a null</dd>
<dd><code>java.lang.ClassCastException</code> - if the iterators collection contains the wrong object type</dd></dl>
</li>
</ul>
<a name="chainedIterator(java.util.Iterator[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chainedIterator</h4>
<pre>public static java.util.Iterator chainedIterator(java.util.Iterator[] iterators)</pre>
<div class="block">Gets an iterator that iterates through an array of <code>Iterator</code>s
one after another.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterators</code> - the iterators to use, not null or empty or contain nulls</dd>
<dt><span class="strong">Returns:</span></dt><dd>a combination iterator over the iterators</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterators array is null or contains a null</dd></dl>
</li>
</ul>
<a name="chainedIterator(java.util.Iterator, java.util.Iterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>chainedIterator</h4>
<pre>public static java.util.Iterator chainedIterator(java.util.Iterator iterator1,
java.util.Iterator iterator2)</pre>
<div class="block">Gets an iterator that iterates through two <code>Iterator</code>s
one after another.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator1</code> - the first iterators to use, not null</dd><dd><code>iterator2</code> - the first iterators to use, not null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a combination iterator over the iterators</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either iterator is null</dd></dl>
</li>
</ul>
<a name="collatedIterator(java.util.Comparator, java.util.Collection)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collatedIterator</h4>
<pre>public static java.util.Iterator collatedIterator(java.util.Comparator comparator,
java.util.Collection iterators)</pre>
<div class="block">Gets an iterator that provides an ordered iteration over the elements
contained in a collection of <code>Iterator</code>s.
<p>
Given two ordered <code>Iterator</code>s <code>A</code> and <code>B</code>,
the <code>Iterator.next()</code> method will return the lesser of
<code>A.next()</code> and <code>B.next()</code> and so on.
<p>
The comparator is optional. If null is specified then natural order is used.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comparator</code> - the comparator to use, may be null for natural order</dd><dd><code>iterators</code> - the iterators to use, not null or empty or contain nulls</dd>
<dt><span class="strong">Returns:</span></dt><dd>a combination iterator over the iterators</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterators collection is null or contains a null</dd>
<dd><code>java.lang.ClassCastException</code> - if the iterators collection contains the wrong object type</dd></dl>
</li>
</ul>
<a name="collatedIterator(java.util.Comparator, java.util.Iterator[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collatedIterator</h4>
<pre>public static java.util.Iterator collatedIterator(java.util.Comparator comparator,
java.util.Iterator[] iterators)</pre>
<div class="block">Gets an iterator that provides an ordered iteration over the elements
contained in an array of <code>Iterator</code>s.
<p>
Given two ordered <code>Iterator</code>s <code>A</code> and <code>B</code>,
the <code>Iterator.next()</code> method will return the lesser of
<code>A.next()</code> and <code>B.next()</code> and so on.
<p>
The comparator is optional. If null is specified then natural order is used.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comparator</code> - the comparator to use, may be null for natural order</dd><dd><code>iterators</code> - the iterators to use, not null or empty or contain nulls</dd>
<dt><span class="strong">Returns:</span></dt><dd>a combination iterator over the iterators</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterators array is null or contains a null</dd></dl>
</li>
</ul>
<a name="collatedIterator(java.util.Comparator, java.util.Iterator, java.util.Iterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>collatedIterator</h4>
<pre>public static java.util.Iterator collatedIterator(java.util.Comparator comparator,
java.util.Iterator iterator1,
java.util.Iterator iterator2)</pre>
<div class="block">Gets an iterator that provides an ordered iteration over the elements
contained in a collection of ordered <code>Iterator</code>s.
<p>
Given two ordered <code>Iterator</code>s <code>A</code> and <code>B</code>,
the <code>Iterator.next()</code> method will return the lesser of
<code>A.next()</code> and <code>B.next()</code>.
<p>
The comparator is optional. If null is specified then natural order is used.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comparator</code> - the comparator to use, may be null for natural order</dd><dd><code>iterator1</code> - the first iterators to use, not null</dd><dd><code>iterator2</code> - the first iterators to use, not null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a combination iterator over the iterators</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either iterator is null</dd></dl>
</li>
</ul>
<a name="filteredIterator(java.util.Iterator, org.apache.commons.collections.Predicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filteredIterator</h4>
<pre>public static java.util.Iterator filteredIterator(java.util.Iterator iterator,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> predicate)</pre>
<div class="block">Gets an iterator that filters another iterator.
<p>
The returned iterator will only return objects that match the specified
filtering predicate.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - the iterator to use, not null</dd><dd><code>predicate</code> - the predicate to use as a filter, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either parameter is null</dd></dl>
</li>
</ul>
<a name="filteredListIterator(java.util.ListIterator, org.apache.commons.collections.Predicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>filteredListIterator</h4>
<pre>public static java.util.ListIterator filteredListIterator(java.util.ListIterator listIterator,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> predicate)</pre>
<div class="block">Gets a list iterator that filters another list iterator.
<p>
The returned iterator will only return objects that match the specified
filtering predicate.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>listIterator</code> - the list iterator to use, not null</dd><dd><code>predicate</code> - the predicate to use as a filter, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either parameter is null</dd></dl>
</li>
</ul>
<a name="getIterator(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getIterator</h4>
<pre>public static java.util.Iterator getIterator(java.lang.Object obj)</pre>
<div class="block">Gets a suitable Iterator for the given object.
<p>
This method can handles objects as follows
<ul>
<li>null - empty iterator
<li>Iterator - returned directly
<li>Enumeration - wrapped
<li>Collection - iterator from collection returned
<li>Map - values iterator returned
<li>Dictionary - values (elements) enumeration returned as iterator
<li>array - iterator over array returned
<li>object with iterator() public method accessed by reflection
<li>object - singleton iterator
</ul></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - the object to convert to an iterator</dd>
<dt><span class="strong">Returns:</span></dt><dd>a suitable iterator, never null</dd></dl>
</li>
</ul>
<a name="singletonListIterator(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>singletonListIterator</h4>
<pre>public static java.util.ListIterator singletonListIterator(java.lang.Object object)</pre>
<div class="block">Gets a singleton list iterator.
<p>
This iterator is a valid list iterator object that will iterate over
the specified object.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>object</code> - the single object over which to iterate</dd>
<dt><span class="strong">Returns:</span></dt><dd>a singleton list iterator over the object</dd></dl>
</li>
</ul>
<a name="toArray(java.util.Iterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public static java.lang.Object[] toArray(java.util.Iterator iterator)</pre>
<div class="block">Gets an array based on an iterator.
<p>
As the wrapped Iterator is traversed, an ArrayList of its values is
created. At the end, this is converted to an array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - the iterator to use, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterator parameter is null</dd></dl>
</li>
</ul>
<a name="toArray(java.util.Iterator, java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toArray</h4>
<pre>public static java.lang.Object[] toArray(java.util.Iterator iterator,
java.lang.Class arrayClass)</pre>
<div class="block">Gets an array based on an iterator.
<p>
As the wrapped Iterator is traversed, an ArrayList of its values is
created. At the end, this is converted to an array.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - the iterator to use, not null</dd><dd><code>arrayClass</code> - the class of array to create</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterator parameter is null</dd>
<dd><code>java.lang.NullPointerException</code> - if arrayClass is null</dd>
<dd><code>java.lang.ClassCastException</code> - if the arrayClass is invalid</dd></dl>
</li>
</ul>
<a name="toList(java.util.Iterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toList</h4>
<pre>public static java.util.List toList(java.util.Iterator iterator)</pre>
<div class="block">Gets a list based on an iterator.
<p>
As the wrapped Iterator is traversed, an ArrayList of its values is
created. At the end, the list is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - the iterator to use, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterator parameter is null</dd></dl>
</li>
</ul>
<a name="toList(java.util.Iterator, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toList</h4>
<pre>public static java.util.List toList(java.util.Iterator iterator,
int estimatedSize)</pre>
<div class="block">Gets a list based on an iterator.
<p>
As the wrapped Iterator is traversed, an ArrayList of its values is
created. At the end, the list is returned.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - the iterator to use, not null</dd><dd><code>estimatedSize</code> - the initial size of the ArrayList</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterator parameter is null</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the size is less than 1</dd></dl>
</li>
</ul>
<a name="toListIterator(java.util.Iterator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toListIterator</h4>
<pre>public static java.util.ListIterator toListIterator(java.util.Iterator iterator)</pre>
<div class="block">Gets a list iterator based on a simple iterator.
<p>
As the wrapped Iterator is traversed, a LinkedList of its values is
cached, permitting all required operations of ListIterator.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - the iterator to use, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if iterator parameter is null</dd></dl>
</li>
</ul>
<a name="transformedIterator(java.util.Iterator, org.apache.commons.collections.Transformer)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>transformedIterator</h4>
<pre>public static java.util.Iterator transformedIterator(java.util.Iterator iterator,
<a href="../../../../org/apache/commons/collections/Transformer.html" title="interface in org.apache.commons.collections">Transformer</a> transform)</pre>
<div class="block">Gets an iterator that transforms the elements of another iterator.
<p>
The transformation occurs during the next() method and the underlying
iterator is unaffected by the transformation.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>iterator</code> - the iterator to use, not null</dd><dd><code>transform</code> - the transform to use, not null</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either parameter 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>Prev Class</li>
<li><a href="../../../../org/apache/commons/collections/ListUtils.html" title="class in org.apache.commons.collections"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/collections/IteratorUtils.html" target="_top">Frames</a></li>
<li><a href="IteratorUtils.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: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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 © 2001-2004 Apache Software Foundation. Documenation generated April 29 2013</small>.</small></p>
</body>
</html>
|