/usr/share/doc/libcommons-collections-java/api/org/apache/commons/collections/comparators/ComparatorChain.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 | <!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>ComparatorChain (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="ComparatorChain (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/comparators/ComparableComparator.html" title="class in org.apache.commons.collections.comparators"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/collections/comparators/NullComparator.html" title="class in org.apache.commons.collections.comparators"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/collections/comparators/ComparatorChain.html" target="_top">Frames</a></li>
<li><a href="ComparatorChain.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.comparators</div>
<h2 title="Class ComparatorChain" class="title">Class ComparatorChain</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.collections.comparators.ComparatorChain</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable, java.util.Comparator</dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ComparatorChain</span>
extends java.lang.Object
implements java.util.Comparator, java.io.Serializable</pre>
<div class="block"><p>A ComparatorChain is a Comparator that wraps one or
more Comparators in sequence. The ComparatorChain
calls each Comparator in sequence until either 1)
any single Comparator returns a non-zero result
(and that result is then returned),
or 2) the ComparatorChain is exhausted (and zero is
returned). This type of sorting is very similar
to multi-column sorting in SQL, and this class
allows Java classes to emulate that kind of behaviour
when sorting a List.</p>
<p>To further facilitate SQL-like sorting, the order of
any single Comparator in the list can be reversed.</p>
<p>Calling a method that adds new Comparators or
changes the ascend/descend sort <i>after compare(Object,
Object) has been called</i> will result in an
UnsupportedOperationException. However, <i>take care</i>
to not alter the underlying List of Comparators
or the BitSet that defines the sort order.</p>
<p>Instances of ComparatorChain are not synchronized.
The class is not thread-safe at construction time, but
it <i>is</i> thread-safe to perform multiple comparisons
after all the setup operations are complete.</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Morgan Delagrange</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../serialized-form.html#org.apache.commons.collections.comparators.ComparatorChain">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#comparatorChain">comparatorChain</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#isLocked">isLocked</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.BitSet</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#orderingBits">orderingBits</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/comparators/ComparatorChain.html#ComparatorChain()">ComparatorChain</a></strong>()</code>
<div class="block">Construct a ComparatorChain with no Comparators.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#ComparatorChain(java.util.Comparator)">ComparatorChain</a></strong>(java.util.Comparator comparator)</code>
<div class="block">Construct a ComparatorChain with a single Comparator,
sorting in the forward order</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#ComparatorChain(java.util.Comparator, boolean)">ComparatorChain</a></strong>(java.util.Comparator comparator,
boolean reverse)</code>
<div class="block">Construct a Comparator chain with a single Comparator,
sorting in the given order</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#ComparatorChain(java.util.List)">ComparatorChain</a></strong>(java.util.List list)</code>
<div class="block">Construct a ComparatorChain from the Comparators in the
List.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#ComparatorChain(java.util.List, java.util.BitSet)">ComparatorChain</a></strong>(java.util.List list,
java.util.BitSet bits)</code>
<div class="block">Construct a ComparatorChain from the Comparators in the
given List.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#addComparator(java.util.Comparator)">addComparator</a></strong>(java.util.Comparator comparator)</code>
<div class="block">Add a Comparator to the end of the chain using the
forward sort order</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#addComparator(java.util.Comparator, boolean)">addComparator</a></strong>(java.util.Comparator comparator,
boolean reverse)</code>
<div class="block">Add a Comparator to the end of the chain using the
given sort order</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#compare(java.lang.Object, java.lang.Object)">compare</a></strong>(java.lang.Object o1,
java.lang.Object o2)</code>
<div class="block">Perform comaparisons on the Objects as per
Comparator.compare(o1,o2).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#isLocked()">isLocked</a></strong>()</code>
<div class="block">Determine if modifications can still be made to the
ComparatorChain.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#setComparator(int, java.util.Comparator)">setComparator</a></strong>(int index,
java.util.Comparator comparator)</code>
<div class="block">Replace the Comparator at the given index, maintaining
the existing sort order.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#setComparator(int, java.util.Comparator, boolean)">setComparator</a></strong>(int index,
java.util.Comparator comparator,
boolean reverse)</code>
<div class="block">Replace the Comparator at the given index in the
ComparatorChain, using the given sort order</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#setForwardSort(int)">setForwardSort</a></strong>(int index)</code>
<div class="block">Change the sort order at the given index in the
ComparatorChain to a forward sort.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#setReverseSort(int)">setReverseSort</a></strong>(int index)</code>
<div class="block">Change the sort order at the given index in the
ComparatorChain to a reverse sort.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#size()">size</a></strong>()</code>
<div class="block">Number of Comparators in the current ComparatorChain.</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>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.util.Comparator">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.Comparator</h3>
<code>equals</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="comparatorChain">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>comparatorChain</h4>
<pre>protected java.util.List comparatorChain</pre>
</li>
</ul>
<a name="isLocked">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLocked</h4>
<pre>protected boolean isLocked</pre>
</li>
</ul>
<a name="orderingBits">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>orderingBits</h4>
<pre>protected java.util.BitSet orderingBits</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ComparatorChain()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ComparatorChain</h4>
<pre>public ComparatorChain()</pre>
<div class="block">Construct a ComparatorChain with no Comparators.
You must add at least one Comparator before calling
the compare(Object,Object) method, or an
UnsupportedOperationException is thrown</div>
</li>
</ul>
<a name="ComparatorChain(java.util.Comparator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ComparatorChain</h4>
<pre>public ComparatorChain(java.util.Comparator comparator)</pre>
<div class="block">Construct a ComparatorChain with a single Comparator,
sorting in the forward order</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comparator</code> - First comparator in the Comparator chain</dd></dl>
</li>
</ul>
<a name="ComparatorChain(java.util.Comparator, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ComparatorChain</h4>
<pre>public ComparatorChain(java.util.Comparator comparator,
boolean reverse)</pre>
<div class="block">Construct a Comparator chain with a single Comparator,
sorting in the given order</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comparator</code> - First Comparator in the ComparatorChain</dd><dd><code>reverse</code> - false = forward sort; true = reverse sort</dd></dl>
</li>
</ul>
<a name="ComparatorChain(java.util.List)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ComparatorChain</h4>
<pre>public ComparatorChain(java.util.List list)</pre>
<div class="block">Construct a ComparatorChain from the Comparators in the
List. All Comparators will default to the forward
sort order.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - List of Comparators</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/collections/comparators/ComparatorChain.html#ComparatorChain(java.util.List, java.util.BitSet)"><code>ComparatorChain(List,BitSet)</code></a></dd></dl>
</li>
</ul>
<a name="ComparatorChain(java.util.List, java.util.BitSet)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ComparatorChain</h4>
<pre>public ComparatorChain(java.util.List list,
java.util.BitSet bits)</pre>
<div class="block">Construct a ComparatorChain from the Comparators in the
given List. The sort order of each column will be
drawn from the given BitSet. When determining the sort
order for Comparator at index <i>i</i> in the List,
the ComparatorChain will call BitSet.get(<i>i</i>).
If that method returns <i>false</i>, the forward
sort order is used; a return value of <i>true</i>
indicates reverse sort order.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>list</code> - List of Comparators. NOTE: This constructor does not perform a
defensive copy of the list</dd><dd><code>bits</code> - Sort order for each Comparator. Extra bits are ignored,
unless extra Comparators are added by another method.</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="addComparator(java.util.Comparator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addComparator</h4>
<pre>public void addComparator(java.util.Comparator comparator)</pre>
<div class="block">Add a Comparator to the end of the chain using the
forward sort order</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comparator</code> - Comparator with the forward sort order</dd></dl>
</li>
</ul>
<a name="addComparator(java.util.Comparator, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addComparator</h4>
<pre>public void addComparator(java.util.Comparator comparator,
boolean reverse)</pre>
<div class="block">Add a Comparator to the end of the chain using the
given sort order</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>comparator</code> - Comparator to add to the end of the chain</dd><dd><code>reverse</code> - false = forward sort order; true = reverse sort order</dd></dl>
</li>
</ul>
<a name="compare(java.lang.Object, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compare</h4>
<pre>public int compare(java.lang.Object o1,
java.lang.Object o2)
throws java.lang.UnsupportedOperationException</pre>
<div class="block">Perform comaparisons on the Objects as per
Comparator.compare(o1,o2).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>compare</code> in interface <code>java.util.Comparator</code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>o1</code> - object 1</dd><dd><code>o2</code> - object 2</dd>
<dt><span class="strong">Returns:</span></dt><dd>-1, 0, or 1</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.UnsupportedOperationException</code> - if the ComparatorChain does not contain at least one
Comparator</dd></dl>
</li>
</ul>
<a name="isLocked()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isLocked</h4>
<pre>public boolean isLocked()</pre>
<div class="block">Determine if modifications can still be made to the
ComparatorChain. ComparatorChains cannot be modified
once they have performed a comparison.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>true = ComparatorChain cannot be modified; false =
ComparatorChain can still be modified.</dd></dl>
</li>
</ul>
<a name="setComparator(int, java.util.Comparator)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setComparator</h4>
<pre>public void setComparator(int index,
java.util.Comparator comparator)
throws java.lang.IndexOutOfBoundsException</pre>
<div class="block">Replace the Comparator at the given index, maintaining
the existing sort order.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index of the Comparator to replace</dd><dd><code>comparator</code> - Comparator to place at the given index</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IndexOutOfBoundsException</code> - if index < 0 or index > size()</dd></dl>
</li>
</ul>
<a name="setComparator(int, java.util.Comparator, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setComparator</h4>
<pre>public void setComparator(int index,
java.util.Comparator comparator,
boolean reverse)</pre>
<div class="block">Replace the Comparator at the given index in the
ComparatorChain, using the given sort order</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index of the Comparator to replace</dd><dd><code>comparator</code> - Comparator to set</dd><dd><code>reverse</code> - false = forward sort order; true = reverse sort order</dd></dl>
</li>
</ul>
<a name="setForwardSort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForwardSort</h4>
<pre>public void setForwardSort(int index)</pre>
<div class="block">Change the sort order at the given index in the
ComparatorChain to a forward sort.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - Index of the ComparatorChain</dd></dl>
</li>
</ul>
<a name="setReverseSort(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReverseSort</h4>
<pre>public void setReverseSort(int index)</pre>
<div class="block">Change the sort order at the given index in the
ComparatorChain to a reverse sort.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - Index of the ComparatorChain</dd></dl>
</li>
</ul>
<a name="size()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<div class="block">Number of Comparators in the current ComparatorChain.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Comparator count</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/comparators/ComparableComparator.html" title="class in org.apache.commons.collections.comparators"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/collections/comparators/NullComparator.html" title="class in org.apache.commons.collections.comparators"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/collections/comparators/ComparatorChain.html" target="_top">Frames</a></li>
<li><a href="ComparatorChain.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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>
|