/usr/share/doc/libglazedlists-java-doc/api/ca/odell/glazedlists/PluggableList.html is in libglazedlists-java-doc 1.9.0+dfsg-2.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>PluggableList (Glazed Lists)</title>
<meta name="date" content="2016-02-14">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PluggableList (Glazed Lists)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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="class-use/PluggableList.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../ca/odell/glazedlists/ObservableElementList.Connector.html" title="interface in ca.odell.glazedlists"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../ca/odell/glazedlists/PopularityList.html" title="class in ca.odell.glazedlists"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ca/odell/glazedlists/PluggableList.html" target="_top">Frames</a></li>
<li><a href="PluggableList.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="#fields.inherited.from.class.ca.odell.glazedlists.TransformedList">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>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">ca.odell.glazedlists</div>
<h2 title="Class PluggableList" class="title">Class PluggableList<E></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../ca/odell/glazedlists/AbstractEventList.html" title="class in ca.odell.glazedlists">ca.odell.glazedlists.AbstractEventList</a><E></li>
<li>
<ul class="inheritance">
<li><a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists">ca.odell.glazedlists.TransformedList</a><E,E></li>
<li>
<ul class="inheritance">
<li>ca.odell.glazedlists.PluggableList<E></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../ca/odell/glazedlists/event/ListEventListener.html" title="interface in ca.odell.glazedlists.event">ListEventListener</a><E>, <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists">EventList</a><E>, java.lang.Iterable<E>, java.util.Collection<E>, java.util.EventListener, java.util.List<E></dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">PluggableList<E></span>
extends <a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists">TransformedList</a><E,E></pre>
<div class="block">An <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> which delegates all List methods to a given source
<a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> that may be replaced at runtime using
<a href="../../../ca/odell/glazedlists/PluggableList.html#setSource-ca.odell.glazedlists.EventList-"><code>setSource(EventList)</code></a>.
<p>Note that the source <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> must use the same
<a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event"><code>ListEventPublisher</code></a> and <a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent"><code>ReadWriteLock</code></a>, particularly if this
<a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> is to be used by multiple threads concurrently. To
construct an <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> that shares the <a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event"><code>ListEventPublisher</code></a>
and <a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent"><code>ReadWriteLock</code></a> with this <a href="../../../ca/odell/glazedlists/PluggableList.html" title="class in ca.odell.glazedlists"><code>PluggableList</code></a>, use
<a href="../../../ca/odell/glazedlists/PluggableList.html#createSourceList--"><code>createSourceList()</code></a>.
<p><strong><font color="#FF0000">Warning:</font></strong> This class is
thread ready but not thread safe. See <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> for an example
of thread safe code.
<p><table border="1" width="100%" cellpadding="3" cellspacing="0">
<tr class="TableHeadingColor"><td colspan=2><font size="+2"><b>EventList Overview</b></font></td></tr>
<tr><td class="TableSubHeadingColor"><b>Writable:</b></td><td>yes</td></tr>
<tr><td class="TableSubHeadingColor"><b>Concurrency:</b></td><td><strong>only <a href="../../../ca/odell/glazedlists/PluggableList.html#setSource-ca.odell.glazedlists.EventList-"><code>setSource(EventList)</code></a></strong></td></tr>
<tr><td class="TableSubHeadingColor"><b>Performance:</b></td><td>delegates to source EventList</td></tr>
<tr><td class="TableSubHeadingColor"><b>Memory:</b></td><td>N/A</td></tr>
<tr><td class="TableSubHeadingColor"><b>Unit Tests:</b></td><td>N/A</td></tr>
<tr><td class="TableSubHeadingColor"><b>Issues:</b></td><td></td></tr>
</table></div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>James Lemieux</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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.ca.odell.glazedlists.TransformedList">
<!-- -->
</a>
<h3>Fields inherited from class ca.odell.glazedlists.<a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists">TransformedList</a></h3>
<code><a href="../../../ca/odell/glazedlists/TransformedList.html#source">source</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.ca.odell.glazedlists.AbstractEventList">
<!-- -->
</a>
<h3>Fields inherited from class ca.odell.glazedlists.<a href="../../../ca/odell/glazedlists/AbstractEventList.html" title="class in ca.odell.glazedlists">AbstractEventList</a></h3>
<code><a href="../../../ca/odell/glazedlists/AbstractEventList.html#publisher">publisher</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#readWriteLock">readWriteLock</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#updates">updates</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" 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><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/PluggableList.html#PluggableList-ca.odell.glazedlists.EventList-">PluggableList</a></span>(<a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists">EventList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>> source)</code>
<div class="block">Constructs a PluggableList which delegates all List methods to the given
<code>source</code>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/PluggableList.html#PluggableList-ca.odell.glazedlists.event.ListEventPublisher-ca.odell.glazedlists.util.concurrent.ReadWriteLock-">PluggableList</a></span>(<a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event">ListEventPublisher</a> publisher,
<a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent">ReadWriteLock</a> lock)</code>
<div class="block">Constructs a PluggableList which uses the given <code>publisher</code>
and <code>lock</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists">EventList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/PluggableList.html#createSourceList--">createSourceList</a></span>()</code>
<div class="block">Creates a new <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> that shares its
<a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent"><code>ReadWriteLock</code></a> and
<a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event"><code>ListEventPublisher</code></a> with this
<a href="../../../ca/odell/glazedlists/PluggableList.html" title="class in ca.odell.glazedlists"><code>PluggableList</code></a>.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/PluggableList.html#dispose--">dispose</a></span>()</code>
<div class="block">Releases the resources consumed by this <a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists"><code>TransformedList</code></a> so that it
may eventually be garbage collected.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/PluggableList.html#isWritable--">isWritable</a></span>()</code>
<div class="block">Gets whether the source <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> is writable via this API.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/PluggableList.html#listChanged-ca.odell.glazedlists.event.ListEvent-">listChanged</a></span>(<a href="../../../ca/odell/glazedlists/event/ListEvent.html" title="class in ca.odell.glazedlists.event">ListEvent</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>> listChanges)</code>
<div class="block">When the underlying list changes, this notification allows the
object to repaint itself or update itself as necessary.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/PluggableList.html#setSource-ca.odell.glazedlists.EventList-">setSource</a></span>(<a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists">EventList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>> source)</code>
<div class="block">Sets the source EventList to which this PluggableList will delegate all
calls.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.ca.odell.glazedlists.TransformedList">
<!-- -->
</a>
<h3>Methods inherited from class ca.odell.glazedlists.<a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists">TransformedList</a></h3>
<code><a href="../../../ca/odell/glazedlists/TransformedList.html#add-int-E-">add</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html#addAll-int-java.util.Collection-">addAll</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html#clear--">clear</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html#get-int-">get</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html#getSourceIndex-int-">getSourceIndex</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html#remove-int-">remove</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html#removeAll-java.util.Collection-">removeAll</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html#retainAll-java.util.Collection-">retainAll</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html#set-int-E-">set</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html#size--">size</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.ca.odell.glazedlists.AbstractEventList">
<!-- -->
</a>
<h3>Methods inherited from class ca.odell.glazedlists.<a href="../../../ca/odell/glazedlists/AbstractEventList.html" title="class in ca.odell.glazedlists">AbstractEventList</a></h3>
<code><a href="../../../ca/odell/glazedlists/AbstractEventList.html#add-E-">add</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#addAll-java.util.Collection-">addAll</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#addListEventListener-ca.odell.glazedlists.event.ListEventListener-">addListEventListener</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#contains-java.lang.Object-">contains</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#containsAll-java.util.Collection-">containsAll</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#equals-java.lang.Object-">equals</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#getPublisher--">getPublisher</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#getReadWriteLock--">getReadWriteLock</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#hashCode--">hashCode</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#indexOf-java.lang.Object-">indexOf</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#isEmpty--">isEmpty</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#iterator--">iterator</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#lastIndexOf-java.lang.Object-">lastIndexOf</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#listIterator--">listIterator</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#listIterator-int-">listIterator</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#remove-java.lang.Object-">remove</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#removeListEventListener-ca.odell.glazedlists.event.ListEventListener-">removeListEventListener</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#subList-int-int-">subList</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#toArray--">toArray</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#toArray-T:A-">toArray</a>, <a href="../../../ca/odell/glazedlists/AbstractEventList.html#toString--">toString</a></code></li>
</ul>
<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, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.List">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.List</h3>
<code>replaceAll, sort, spliterator</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.util.Collection">
<!-- -->
</a>
<h3>Methods inherited from interface java.util.Collection</h3>
<code>parallelStream, removeIf, stream</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Iterable">
<!-- -->
</a>
<h3>Methods inherited from interface java.lang.Iterable</h3>
<code>forEach</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="PluggableList-ca.odell.glazedlists.event.ListEventPublisher-ca.odell.glazedlists.util.concurrent.ReadWriteLock-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PluggableList</h4>
<pre>public PluggableList(<a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event">ListEventPublisher</a> publisher,
<a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent">ReadWriteLock</a> lock)</pre>
<div class="block">Constructs a PluggableList which uses the given <code>publisher</code>
and <code>lock</code>. The PluggableList will default to use a
<a href="../../../ca/odell/glazedlists/BasicEventList.html" title="class in ca.odell.glazedlists"><code>BasicEventList</code></a> that also uses the same <code>publisher</code>
and <code>lock</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>publisher</code> - the <a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event"><code>ListEventPublisher</code></a> to use within the <a href="../../../ca/odell/glazedlists/PluggableList.html" title="class in ca.odell.glazedlists"><code>PluggableList</code></a></dd>
<dd><code>lock</code> - the <a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent"><code>ReadWriteLock</code></a> to use within the <a href="../../../ca/odell/glazedlists/PluggableList.html" title="class in ca.odell.glazedlists"><code>PluggableList</code></a></dd>
</dl>
</li>
</ul>
<a name="PluggableList-ca.odell.glazedlists.EventList-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>PluggableList</h4>
<pre>public PluggableList(<a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists">EventList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>> source)</pre>
<div class="block">Constructs a PluggableList which delegates all List methods to the given
<code>source</code>. At some future time, the source EventList may be
replaced using <a href="../../../ca/odell/glazedlists/PluggableList.html#setSource-ca.odell.glazedlists.EventList-"><code>setSource(EventList)</code></a> and this PluggableList will
produce a <a href="../../../ca/odell/glazedlists/event/ListEvent.html" title="class in ca.odell.glazedlists.event"><code>ListEvent</code></a> describing the change in data.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the source of data to this PluggableList</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="createSourceList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createSourceList</h4>
<pre>public <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists">EventList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>> createSourceList()</pre>
<div class="block">Creates a new <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> that shares its
<a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent"><code>ReadWriteLock</code></a> and
<a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event"><code>ListEventPublisher</code></a> with this
<a href="../../../ca/odell/glazedlists/PluggableList.html" title="class in ca.odell.glazedlists"><code>PluggableList</code></a>. This is necessary when this <a href="../../../ca/odell/glazedlists/PluggableList.html" title="class in ca.odell.glazedlists"><code>PluggableList</code></a>
will be used by multiple threads.
<p>Note that the created <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> must be explicitly set as the
source of this <a href="../../../ca/odell/glazedlists/PluggableList.html" title="class in ca.odell.glazedlists"><code>PluggableList</code></a> using <a href="../../../ca/odell/glazedlists/PluggableList.html#setSource-ca.odell.glazedlists.EventList-"><code>setSource(EventList)</code></a>.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a new EventList appropriate for use as the
<a href="../../../ca/odell/glazedlists/PluggableList.html#setSource-ca.odell.glazedlists.EventList-"><code>source</code></a> of this PluggableList</dd>
</dl>
</li>
</ul>
<a name="setSource-ca.odell.glazedlists.EventList-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSource</h4>
<pre>public void setSource(<a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists">EventList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>> source)</pre>
<div class="block">Sets the source EventList to which this PluggableList will delegate all
calls. This method is the entire reason that PluggableList exists. It
allows the data source of the remaining pipeline to be altered.
<p>
To ensure correct behaviour when this <a href="../../../ca/odell/glazedlists/PluggableList.html" title="class in ca.odell.glazedlists"><code>PluggableList</code></a> is used by
multiple threads, the given <code>source</code> <strong>must</strong>
share the same <a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent"><code>ReadWriteLock</code></a> and
<a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event"><code>ListEventPublisher</code></a> with this PluggableList.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>source</code> - the new source of data for this PluggableList, and all
downstream EventLists</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.IllegalStateException</code> - if this PluggableList is already disposed</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if any of the following are true
<ul>
<li>the given source is null</li>
<li>the given source has a different ListEventPublisher than this PluggableList</li>
<li>the given source has a different ReadWriteLock than this PluggableList</li>
</ul></dd>
</dl>
</li>
</ul>
<a name="isWritable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isWritable</h4>
<pre>protected boolean isWritable()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../ca/odell/glazedlists/TransformedList.html#isWritable--">TransformedList</a></code></span></div>
<div class="block">Gets whether the source <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> is writable via this API.
<p>Extending classes must override this method in order to make themselves
writable.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../ca/odell/glazedlists/TransformedList.html#isWritable--">isWritable</a></code> in class <code><a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists">TransformedList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>,<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>></code></dd>
</dl>
</li>
</ul>
<a name="listChanged-ca.odell.glazedlists.event.ListEvent-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>listChanged</h4>
<pre>public void listChanged(<a href="../../../ca/odell/glazedlists/event/ListEvent.html" title="class in ca.odell.glazedlists.event">ListEvent</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>> listChanges)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../ca/odell/glazedlists/TransformedList.html#listChanged-ca.odell.glazedlists.event.ListEvent-">TransformedList</a></code></span></div>
<div class="block">When the underlying list changes, this notification allows the
object to repaint itself or update itself as necessary.
<p>It is mandatory that the calling thread has obtained the write lock
on the source list. This is because the calling thread will have written
to the source list to cause this event. This condition guarantees that
no writes can occur while the listener is handling this event.
It is an error to write to the source list while processing an event.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../ca/odell/glazedlists/event/ListEventListener.html#listChanged-ca.odell.glazedlists.event.ListEvent-">listChanged</a></code> in interface <code><a href="../../../ca/odell/glazedlists/event/ListEventListener.html" title="interface in ca.odell.glazedlists.event">ListEventListener</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../ca/odell/glazedlists/TransformedList.html#listChanged-ca.odell.glazedlists.event.ListEvent-">listChanged</a></code> in class <code><a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists">TransformedList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>,<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listChanges</code> - a <a href="../../../ca/odell/glazedlists/event/ListEvent.html" title="class in ca.odell.glazedlists.event"><code>ListEvent</code></a> describing the changes to the list</dd>
</dl>
</li>
</ul>
<a name="dispose--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dispose</h4>
<pre>public void dispose()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../ca/odell/glazedlists/TransformedList.html#dispose--">TransformedList</a></code></span></div>
<div class="block">Releases the resources consumed by this <a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists"><code>TransformedList</code></a> so that it
may eventually be garbage collected.
<p>A <a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists"><code>TransformedList</code></a> will be garbage collected without a call to
<a href="../../../ca/odell/glazedlists/TransformedList.html#dispose--"><code>TransformedList.dispose()</code></a>, but not before its source <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> is garbage
collected. By calling <a href="../../../ca/odell/glazedlists/TransformedList.html#dispose--"><code>TransformedList.dispose()</code></a>, you allow the <a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists"><code>TransformedList</code></a>
to be garbage collected before its source <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a>. This is
necessary for situations where a <a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists"><code>TransformedList</code></a> is short-lived but
its source <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> is long-lived.
<p><strong><font color="#FF0000">Warning:</font></strong> It is an error
to call any method on a <a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists"><code>TransformedList</code></a> after it has been disposed.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../ca/odell/glazedlists/EventList.html#dispose--">dispose</a></code> in interface <code><a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists">EventList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>></code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../ca/odell/glazedlists/TransformedList.html#dispose--">dispose</a></code> in class <code><a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists">TransformedList</a><<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>,<a href="../../../ca/odell/glazedlists/PluggableList.html" title="type parameter in PluggableList">E</a>></code></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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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="class-use/PluggableList.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../ca/odell/glazedlists/ObservableElementList.Connector.html" title="interface in ca.odell.glazedlists"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../ca/odell/glazedlists/PopularityList.html" title="class in ca.odell.glazedlists"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ca/odell/glazedlists/PluggableList.html" target="_top">Frames</a></li>
<li><a href="PluggableList.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="#fields.inherited.from.class.ca.odell.glazedlists.TransformedList">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>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><a href="http://www.glazedlists.com" target="_top">Glazed Lists</a>, Copyright © 2003 publicobject.com, O'Dell Engineering.<br>Documentation build by buildd at 2016-02-14 5:12</small></p>
</body>
</html>
|