/usr/share/doc/libglazedlists-java-doc/api/ca/odell/glazedlists/EventList.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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>EventList (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="EventList (Glazed Lists)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/EventList.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/DisposableMap.html" title="interface in ca.odell.glazedlists"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../ca/odell/glazedlists/Filterator.html" title="interface in ca.odell.glazedlists"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ca/odell/glazedlists/EventList.html" target="_top">Frames</a></li>
<li><a href="EventList.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">ca.odell.glazedlists</div>
<h2 title="Interface EventList" class="title">Interface EventList<E></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.util.Collection<E>, java.lang.Iterable<E>, java.util.List<E></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../ca/odell/glazedlists/AbstractEventList.html" title="class in ca.odell.glazedlists">AbstractEventList</a>, <a href="../../../ca/odell/glazedlists/BasicEventList.html" title="class in ca.odell.glazedlists">BasicEventList</a>, <a href="../../../ca/odell/glazedlists/io/CachingList.html" title="class in ca.odell.glazedlists.io">CachingList</a>, <a href="../../../ca/odell/glazedlists/CollectionList.html" title="class in ca.odell.glazedlists">CollectionList</a>, <a href="../../../ca/odell/glazedlists/CompositeList.html" title="class in ca.odell.glazedlists">CompositeList</a>, <a href="../../../ca/odell/glazedlists/DebugList.html" title="class in ca.odell.glazedlists">DebugList</a>, <a href="../../../ca/odell/glazedlists/io/FileList.html" title="class in ca.odell.glazedlists.io">FileList</a>, <a href="../../../ca/odell/glazedlists/FilterList.html" title="class in ca.odell.glazedlists">FilterList</a>, <a href="../../../ca/odell/glazedlists/FreezableList.html" title="class in ca.odell.glazedlists">FreezableList</a>, <a href="../../../ca/odell/glazedlists/FunctionList.html" title="class in ca.odell.glazedlists">FunctionList</a>, <a href="../../../ca/odell/glazedlists/GroupingList.html" title="class in ca.odell.glazedlists">GroupingList</a>, <a href="../../../ca/odell/glazedlists/io/NetworkList.html" title="class in ca.odell.glazedlists.io">NetworkList</a>, <a href="../../../ca/odell/glazedlists/ObservableElementList.html" title="class in ca.odell.glazedlists">ObservableElementList</a>, <a href="../../../ca/odell/glazedlists/PluggableList.html" title="class in ca.odell.glazedlists">PluggableList</a>, <a href="../../../ca/odell/glazedlists/PopularityList.html" title="class in ca.odell.glazedlists">PopularityList</a>, <a href="../../../ca/odell/glazedlists/RangeList.html" title="class in ca.odell.glazedlists">RangeList</a>, <a href="../../../ca/odell/glazedlists/SeparatorList.html" title="class in ca.odell.glazedlists">SeparatorList</a>, <a href="../../../ca/odell/glazedlists/SequenceList.html" title="class in ca.odell.glazedlists">SequenceList</a>, <a href="../../../ca/odell/glazedlists/SortedList.html" title="class in ca.odell.glazedlists">SortedList</a>, <a href="../../../ca/odell/glazedlists/ThresholdList.html" title="class in ca.odell.glazedlists">ThresholdList</a>, <a href="../../../ca/odell/glazedlists/TransactionList.html" title="class in ca.odell.glazedlists">TransactionList</a>, <a href="../../../ca/odell/glazedlists/TransformedList.html" title="class in ca.odell.glazedlists">TransformedList</a>, <a href="../../../ca/odell/glazedlists/UniqueList.html" title="class in ca.odell.glazedlists">UniqueList</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">EventList<E></span>
extends java.util.List<E></pre>
<div class="block">An observable <code>List</code>. <a href="../../../ca/odell/glazedlists/event/ListEventListener.html" title="interface in ca.odell.glazedlists.event"><code>ListEventListener</code></a>s can register to be
notified when this list changes. A <a href="../../../ca/odell/glazedlists/event/ListEvent.html" title="class in ca.odell.glazedlists.event"><code>ListEvent</code></a> represents these changes
to an <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a>.
<p><a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a>s may be writable or read-only. Consult the Javadoc for
your <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> if you are unsure.
<p><strong><font color="#FF0000">Warning:</font></strong> <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a>s
are thread ready but not thread safe. If you are sharing an <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a>
between multiple threads, you can add thread safety by using the built-in
locks:
<pre>
EventList myList = ...
myList.getReadWriteLock().writeLock().lock();
try {
// access myList here
if(myList.size() > 3) {
System.out.println(myList.get(3));
myList.remove(3);
}
} finally {
myList.getReadWriteLock().writeLock().unlock();
}
</pre>
Note that you are also required to acquire and hold the lock during the
construction of an EventList if concurrent modifications are possible in
your environment, like so:
<pre>
EventList source = ...
SortedList sorted;
source.getReadWriteLock().readLock().lock();
try {
sorted = new SortedList(source);
} finally {
source.getReadWriteLock().readLock().unlock();
}
</pre>
<p><strong><font color="#FF0000">Warning:</font></strong> <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a>s
may break the contract required by <code>List</code>. For example, when
you <code>add()</code> on a <a href="../../../ca/odell/glazedlists/SortedList.html" title="class in ca.odell.glazedlists"><code>SortedList</code></a>, it will ignore the specified
index so that the element will be inserted in sorted order.</div>
<dl>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd><a href="mailto:jesse@swank.ca">Jesse Wilson</a></dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../ca/odell/glazedlists/GlazedLists.html#eventListOf-E...-"><code>GlazedLists.eventListOf(Object[])</code></a>,
<a href="../../../ca/odell/glazedlists/GlazedLists.html#eventList-java.util.Collection-"><code>GlazedLists.eventList(Collection)</code></a>,
<a href="../../../ca/odell/glazedlists/GlazedLists.html#readOnlyList-ca.odell.glazedlists.EventList-"><code>GlazedLists.readOnlyList(EventList)</code></a>,
<a href="../../../ca/odell/glazedlists/GlazedLists.html#threadSafeList-ca.odell.glazedlists.EventList-"><code>GlazedLists.threadSafeList(EventList)</code></a>,
<a href="../../../ca/odell/glazedlists/GlazedLists.html#weakReferenceProxy-ca.odell.glazedlists.EventList-ca.odell.glazedlists.event.ListEventListener-"><code>GlazedLists.weakReferenceProxy(EventList, ListEventListener)</code></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="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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/EventList.html#addListEventListener-ca.odell.glazedlists.event.ListEventListener-">addListEventListener</a></span>(<a href="../../../ca/odell/glazedlists/event/ListEventListener.html" title="interface in ca.odell.glazedlists.event">ListEventListener</a><? super <a href="../../../ca/odell/glazedlists/EventList.html" title="type parameter in EventList">E</a>> listChangeListener)</code>
<div class="block">Registers the specified listener to receive change updates for this list.</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/EventList.html#dispose--">dispose</a></span>()</code>
<div class="block">Disposing an EventList will make it eligible for garbage collection.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event">ListEventPublisher</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/EventList.html#getPublisher--">getPublisher</a></span>()</code>
<div class="block">Get the publisher used to distribute <a href="../../../ca/odell/glazedlists/event/ListEvent.html" title="class in ca.odell.glazedlists.event"><code>ListEvent</code></a>s.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent">ReadWriteLock</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../ca/odell/glazedlists/EventList.html#getReadWriteLock--">getReadWriteLock</a></span>()</code>
<div class="block">Gets the lock required to share this list between multiple threads.</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/EventList.html#removeListEventListener-ca.odell.glazedlists.event.ListEventListener-">removeListEventListener</a></span>(<a href="../../../ca/odell/glazedlists/event/ListEventListener.html" title="interface in ca.odell.glazedlists.event">ListEventListener</a><? super <a href="../../../ca/odell/glazedlists/EventList.html" title="type parameter in EventList">E</a>> listChangeListener)</code>
<div class="block">Removes the specified listener from receiving change updates for this list.</div>
</td>
</tr>
</table>
<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>add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray</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">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addListEventListener-ca.odell.glazedlists.event.ListEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addListEventListener</h4>
<pre>void addListEventListener(<a href="../../../ca/odell/glazedlists/event/ListEventListener.html" title="interface in ca.odell.glazedlists.event">ListEventListener</a><? super <a href="../../../ca/odell/glazedlists/EventList.html" title="type parameter in EventList">E</a>> listChangeListener)</pre>
<div class="block">Registers the specified listener to receive change updates for this list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listChangeListener</code> - event listener != null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the specified listener is null</dd>
</dl>
</li>
</ul>
<a name="removeListEventListener-ca.odell.glazedlists.event.ListEventListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeListEventListener</h4>
<pre>void removeListEventListener(<a href="../../../ca/odell/glazedlists/event/ListEventListener.html" title="interface in ca.odell.glazedlists.event">ListEventListener</a><? super <a href="../../../ca/odell/glazedlists/EventList.html" title="type parameter in EventList">E</a>> listChangeListener)</pre>
<div class="block">Removes the specified listener from receiving change updates for this list.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>listChangeListener</code> - event listener != null</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the specified listener is null</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if the specified listener wasn't added before</dd>
</dl>
</li>
</ul>
<a name="getReadWriteLock--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadWriteLock</h4>
<pre><a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent">ReadWriteLock</a> getReadWriteLock()</pre>
<div class="block">Gets the lock required to share this list between multiple threads. It's always defined.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a re-entrant <a href="../../../ca/odell/glazedlists/util/concurrent/ReadWriteLock.html" title="interface in ca.odell.glazedlists.util.concurrent"><code>ReadWriteLock</code></a> that guarantees thread safe
access to this list.</dd>
</dl>
</li>
</ul>
<a name="getPublisher--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPublisher</h4>
<pre><a href="../../../ca/odell/glazedlists/event/ListEventPublisher.html" title="interface in ca.odell.glazedlists.event">ListEventPublisher</a> getPublisher()</pre>
<div class="block">Get the publisher used to distribute <a href="../../../ca/odell/glazedlists/event/ListEvent.html" title="class in ca.odell.glazedlists.event"><code>ListEvent</code></a>s. It's always defined.</div>
</li>
</ul>
<a name="dispose--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>dispose</h4>
<pre>void dispose()</pre>
<div class="block">Disposing an EventList will make it eligible for garbage collection.
Some EventLists install themselves as listeners to related objects so
disposing them is necessary.
<p><strong><font color="#FF0000">Warning:</font></strong> It is an error
to call any method on an <a href="../../../ca/odell/glazedlists/EventList.html" title="interface in ca.odell.glazedlists"><code>EventList</code></a> after it has been disposed.</div>
</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/EventList.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/DisposableMap.html" title="interface in ca.odell.glazedlists"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../ca/odell/glazedlists/Filterator.html" title="interface in ca.odell.glazedlists"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?ca/odell/glazedlists/EventList.html" target="_top">Frames</a></li>
<li><a href="EventList.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><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>
|