/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/ListUtils.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 | <!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>ListUtils (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="ListUtils (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/IteratorUtils.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/LRUMap.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/ListUtils.html" target="_top">Frames</a></li>
<li><a href="ListUtils.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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 ListUtils" class="title">Class ListUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.ListUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ListUtils</span>
extends java.lang.Object</pre>
<div class="block">Contains static utility methods and decorators for <code>List</code>
instances.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>1.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd><a href="mailto:fede@apache.org">Federico Barbieri</a>, <a href="mailto:donaldp@apache.org">Peter Donald</a>, Paul Jack, Stephen Colebourne</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"> </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/ListUtils.html#ListUtils()">ListUtils</a></strong>()</code>
<div class="block">Please don't ever instantiate a <Code>ListUtils</Code>.</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"> </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.List</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/collections/ListUtils.html#fixedSizeList(java.util.List)">fixedSizeList</a></strong>(java.util.List list)</code>
<div class="block">Returns a fixed-sized list backed by the given list.</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/ListUtils.html#intersection(java.util.List, java.util.List)">intersection</a></strong>(java.util.List list1,
java.util.List list2)</code>
<div class="block">Returns a new list containing all elements that are contained in
both given lists.</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/ListUtils.html#lazyList(java.util.List, org.apache.commons.collections.Factory)">lazyList</a></strong>(java.util.List list,
<a href="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</a> factory)</code>
<div class="block">Returns a "lazy" list whose elements will be created on demand.</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/ListUtils.html#predicatedList(java.util.List, org.apache.commons.collections.Predicate)">predicatedList</a></strong>(java.util.List list,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> predicate)</code>
<div class="block">Returns a predicated list backed by the given list.</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/ListUtils.html#subtract(java.util.List, java.util.List)">subtract</a></strong>(java.util.List list1,
java.util.List list2)</code>
<div class="block">Subtracts all elements in the second list from the first list,
placing the results in a new list.</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/ListUtils.html#sum(java.util.List, java.util.List)">sum</a></strong>(java.util.List list1,
java.util.List list2)</code>
<div class="block">Returns the sum of the given lists.</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/ListUtils.html#union(java.util.List, java.util.List)">union</a></strong>(java.util.List list1,
java.util.List list2)</code>
<div class="block">Returns a new list containing the second list appended to the
first list.</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ListUtils()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ListUtils</h4>
<pre>public ListUtils()</pre>
<div class="block">Please don't ever instantiate a <Code>ListUtils</Code>.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fixedSizeList(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fixedSizeList</h4>
<pre>public static java.util.List fixedSizeList(java.util.List list)</pre>
<div class="block">Returns a fixed-sized list backed by the given list.
Elements may not be added or removed from the returned list, but
existing elements can be changed (for instance, via the
<code>List.set(int,Object)</code> method).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - the list whose size to fix, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a fixed-size list backed by that list</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the List is null</dd></dl>
</li>
</ul>
<a name="intersection(java.util.List, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>intersection</h4>
<pre>public static java.util.List intersection(java.util.List list1,
java.util.List list2)</pre>
<div class="block">Returns a new list containing all elements that are contained in
both given lists.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list1</code> - the first list</dd><dd><code>list2</code> - the second list</dd>
<dt><span class="strong">Returns:</span></dt><dd>the intersection of those two lists</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either list is null</dd></dl>
</li>
</ul>
<a name="lazyList(java.util.List, org.apache.commons.collections.Factory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lazyList</h4>
<pre>public static java.util.List lazyList(java.util.List list,
<a href="../../../../org/apache/commons/collections/Factory.html" title="interface in org.apache.commons.collections">Factory</a> factory)</pre>
<div class="block">Returns a "lazy" list whose elements will be created on demand.<P>
<p>
When the index passed to the returned list's <code>get</code>
method is greater than the list's size, then the factory will be used
to create a new object and that object will be inserted at that index.
<p>
For instance:
<pre>
Factory factory = new Factory() {
public Object create() {
return new Date();
}
}
List lazy = ListUtils.lazyList(new ArrayList(), factory);
Object obj = lazy.get(3);
</pre>
After the above code is executed, <code>obj</code> will contain
a new <code>Date</code> instance. Furthermore, that <code>Date</code>
instance is the fourth element in the list. The first, second,
and third element are all set to <code>null</code>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - the list to make lazy, must not be null</dd><dd><code>factory</code> - the factory for creating new objects, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a lazy list backed by the given list</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the List or Factory is null</dd></dl>
</li>
</ul>
<a name="predicatedList(java.util.List, org.apache.commons.collections.Predicate)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>predicatedList</h4>
<pre>public static java.util.List predicatedList(java.util.List list,
<a href="../../../../org/apache/commons/collections/Predicate.html" title="interface in org.apache.commons.collections">Predicate</a> predicate)</pre>
<div class="block">Returns a predicated list backed by the given list. Only objects
that pass the test in the given predicate can be added to the list.
It is important not to use the original list after invoking this
method, as it is a backdoor for adding unvalidated objects.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - the list to predicate, must not be null</dd><dd><code>predicate</code> - the predicate for the list, must not be null</dd>
<dt><span class="strong">Returns:</span></dt><dd>a predicated list backed by the given list</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if the List or Predicate is null</dd></dl>
</li>
</ul>
<a name="subtract(java.util.List, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>subtract</h4>
<pre>public static java.util.List subtract(java.util.List list1,
java.util.List list2)</pre>
<div class="block">Subtracts all elements in the second list from the first list,
placing the results in a new list.
This differs from <code>List.removeAll(Collection)</code> in that
cardinality is respected; if <Code>list1</Code> contains two
occurrences of <Code>null</Code> and <Code>list2</Code> only
contains one occurrence, then the returned list will still contain
one occurrence.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list1</code> - the list to subtract from</dd><dd><code>list2</code> - the lsit to subtract</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new list containing the results</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either list is null</dd></dl>
</li>
</ul>
<a name="sum(java.util.List, java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>sum</h4>
<pre>public static java.util.List sum(java.util.List list1,
java.util.List list2)</pre>
<div class="block">Returns the sum of the given lists. This is their intersection
subtracted from their union.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list1</code> - the first list</dd><dd><code>list2</code> - the second list</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new list containing the sum of those lists</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either list is null</dd></dl>
</li>
</ul>
<a name="union(java.util.List, java.util.List)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>union</h4>
<pre>public static java.util.List union(java.util.List list1,
java.util.List list2)</pre>
<div class="block">Returns a new list containing the second list appended to the
first list. The <code>List.addAll(Collection)</code> operation is
used to append the two given lists into a new list.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list1</code> - the first list</dd><dd><code>list2</code> - the second list</dd>
<dt><span class="strong">Returns:</span></dt><dd>a new list containing the union of those lists</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if either list 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/IteratorUtils.html" title="class in org.apache.commons.collections"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/collections/LRUMap.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/ListUtils.html" target="_top">Frames</a></li>
<li><a href="ListUtils.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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>
|