uk.co.strangeskies.collection.observable

Interface ObservableCollection<E,C>

Type Parameters:

E - the element type, as per Collection

C - the change event message type

All Superinterfaces:

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

All Known Subinterfaces:

ObservableList<E>, ObservableSet<E>, ObservableSortedSet<E>

All Known Implementing Classes:

ObservableListDecorator, ObservableSetDecorator, ObservableSortedSetDecorator, ScopedObservableSet, SynchronizedObservableList, SynchronizedObservableSet, SynchronizedObservableSortedSet, UnmodifiableObservableList, UnmodifiableObservableSet, UnmodifiableObservableSortedSet

public interface ObservableCollection<E,C>
extends java.util.Collection<E>

A collections which can be observed for changes. The collection is Observable over itself, i.e. events will be triggered with the event object being the collection itself. There is also an observable interface changes() over a type C which is parameterisable by subtypes, and which may contain further information about the nature of the change.

Observable events should be triggered each time the collection is changed. Many small internal sub-changes may be grouped into a single conceptual change, and so only trigger once upon completion. The ordering of sub-changes is generally considered an implementation detail in this case, and may not be made available via the change event message type C.

Event messages may only be valid during the invocation of the Consumer.accept(Object) method on observers, so references should typically not be held beyond this point.

Method Summary

Modifier and Type	Method and Description
Observable<C>	changes()
Observable<? extends ObservableCollection<E,C>>	invalidations()
java.util.Collection<E>	silent() Get a view of the collection which can be mutated without triggering events.
ObservableCollection<E,?>	synchronizedView()
ObservableCollection<E,?>	unmodifiableView()

Methods inherited from interface java.util.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, parallelStream, remove, removeAll, removeIf, retainAll, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

unmodifiableView

ObservableCollection<E,?> unmodifiableView()

Returns:

a view of the collections which does not allow modification

synchronizedView

ObservableCollection<E,?> synchronizedView()

Returns:

a view of the collections which is safe in concurrent contexts

invalidations

Observable<? extends ObservableCollection<E,C>> invalidations()

changes

Observable<C> changes()

Returns:

an observable instance over changes

silent

java.util.Collection<E> silent()

Get a view of the collection which can be mutated without triggering events. Operations performed on the returned list may need to be synchronized manually with the backing list.

Returns:

a view transparent to listeners