ca.odell.glazedlists

Interface EventList<E>

All Superinterfaces:

java.util.Collection<E>, java.lang.Iterable<E>, java.util.List<E>

All Known Implementing Classes:

AbstractEventList, BasicEventList, CachingList, CollectionList, CompositeList, DebugList, FileList, FilterList, FreezableList, FunctionList, GroupingList, JavaFxThreadProxyEventList, NetworkList, ObservableElementList, PersistentEventList, PluggableList, PopularityList, RangeList, SeparatorList, SequenceList, SortedList, ca.odell.glazedlists.impl.gui.ThreadProxyEventList, ThresholdList, TransactionList, TransformedList, TreeList, UniqueList

public interface EventList<E>
extends java.util.List<E>

An observable List. ListEventListeners can register to be notified when this list changes. A ListEvent represents these changes to an EventList.

EventLists may be writable or read-only. Consult the Javadoc for your EventList if you are unsure.

Warning: EventLists are thread ready but not thread safe. If you are sharing an EventList between multiple threads, you can add thread safety by using the built-in locks:

 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();
 }
 

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:

 EventList source = ...
 SortedList sorted;
 source.getReadWriteLock().readLock().lock();
 try {
    sorted = new SortedList(source);
 } finally {
    source.getReadWriteLock().readLock().unlock();
 }
 

Warning: EventLists may break the contract required by List. For example, when you add() on a SortedList, it will ignore the specified index so that the element will be inserted in sorted order.

Author:

Jesse Wilson

See Also:

GlazedLists.eventListOf(Object[]), GlazedLists.eventList(Collection), GlazedLists.readOnlyList(EventList), GlazedLists.threadSafeList(EventList), GlazedLists.weakReferenceProxy(EventList, ListEventListener)

Method Summary

Modifier and Type	Method and Description
default void	acceptWithReadLock(java.util.function.Consumer<EventList<E>> consumer) Executes the block of code represented by the given consumer while holding the read lock of this EventList.
default void	acceptWithWriteLock(java.util.function.Consumer<EventList<E>> consumer) Executes the block of code represented by the given consumer while holding the write lock of this EventList.
void	addListEventListener(ListEventListener<? super E> listChangeListener) Registers the specified listener to receive change updates for this list.
default <R> R	applyWithReadLock(java.util.function.Function<EventList<E>,R> function) Applies the given function while holding the read lock of this EventList.
default <R> R	applyWithWriteLock(java.util.function.Function<EventList<E>,R> function) Applies the given function while holding the write lock of this EventList.
void	dispose() Disposing an EventList will make it eligible for garbage collection.
ListEventPublisher	getPublisher() Get the publisher used to distribute ListEvents.
ReadWriteLock	getReadWriteLock() Gets the lock required to share this list between multiple threads.
void	removeListEventListener(ListEventListener<? super E> listChangeListener) Removes the specified listener from receiving change updates for this list.

Methods inherited from interface java.util.List

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

addListEventListener

void addListEventListener(ListEventListener<? super E> listChangeListener)

Registers the specified listener to receive change updates for this list.

Parameters:

listChangeListener - event listener != null

Throws:

java.lang.NullPointerException - if the specified listener is null

removeListEventListener

void removeListEventListener(ListEventListener<? super E> listChangeListener)

Removes the specified listener from receiving change updates for this list.

Parameters:

listChangeListener - event listener != null

Throws:

java.lang.NullPointerException - if the specified listener is null

java.lang.IllegalArgumentException - if the specified listener wasn't added before

getReadWriteLock

ReadWriteLock getReadWriteLock()

Gets the lock required to share this list between multiple threads. It's always defined.

Returns:

a re-entrant ReadWriteLock that guarantees thread safe access to this list.

getPublisher

ListEventPublisher getPublisher()

Get the publisher used to distribute ListEvents. It's always defined.

dispose

void dispose()

Disposing an EventList will make it eligible for garbage collection. Some EventLists install themselves as listeners to related objects so disposing them is necessary.

Warning: It is an error to call any method on an EventList after it has been disposed.

acceptWithReadLock

default void acceptWithReadLock(java.util.function.Consumer<EventList<E>> consumer)

Executes the block of code represented by the given consumer while holding the read lock of this EventList.

The consumer has access to the methods of the EventList interface. If you need access to methods of the implementation class, consider the helper methods in the Guard class instead.

Parameters:

consumer - the consumer != null

See Also:

Guard.acceptWithReadLock(EventList, Consumer)

acceptWithWriteLock

default void acceptWithWriteLock(java.util.function.Consumer<EventList<E>> consumer)

Executes the block of code represented by the given consumer while holding the write lock of this EventList.

The consumer has access to the methods of the EventList interface. If you need access to methods of the implementation class, consider the helper methods in the Guard class instead.

Parameters:

consumer - the consumer != null

See Also:

Guard.acceptWithWriteLock(EventList, Consumer)

applyWithReadLock

default <R> R applyWithReadLock(java.util.function.Function<EventList<E>,R> function)

Applies the given function while holding the read lock of this EventList.

The function has access to the methods of the EventList interface. If you need access to methods of the implementation class, consider the helper methods in the Guard class instead.

Type Parameters:

R - the result type of the function

Parameters:

function - the function != null

Returns:

the result of the function

See Also:

Guard.applyWithReadLock(EventList, Function)

applyWithWriteLock

default <R> R applyWithWriteLock(java.util.function.Function<EventList<E>,R> function)

Applies the given function while holding the write lock of this EventList.

The function has access to the methods of the EventList interface. If you need access to methods of the implementation class, consider the helper methods in the Guard class instead.

Type Parameters:

R - the result type of the function

Parameters:

function - the function != null

Returns:

the result of the function

See Also:

Guard.applyWithWriteLock(EventList, Function)