Class SubscribableCollection<E>

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingCollection<E>

nl.colorize.util.SubscribableCollection<E>

Type Parameters:

E - The type of element included in this collection.

All Implemented Interfaces:

Iterable<E>, Collection<E>

public class SubscribableCollection<E>
extends com.google.common.collect.ForwardingCollection<E>

Wraps an existing collection to allow subscribers to be notified whenever elements are added to or removed from the collection.

Method Summary

Modifier and Type	Method	Description
boolean	add(E element)
void	clear()
protected Collection<E>	delegate()
Stream<E>	flush()	Removes all elements from this collection, then returns a stream containing the elements that were just removed.
Subject<E>	getAddedElements()
E	getFirst()
Subject<E>	getRemovedElements()
Iterator<E>	iterator()	Returns an iterator for the elements in the underlying collection.
boolean	remove(Object element)
boolean	removeAll(Collection<?> toRemove)
boolean	retainAll(Collection<?> toRetain)
String	toString()
static <E> SubscribableCollection<E>	wrap(Collection<E> elements)	Returns a new SubscribableCollection instance that wraps the specified underlying collection.

Methods inherited from class com.google.common.collect.ForwardingCollection

addAll, contains, containsAll, isEmpty, size, standardAddAll, standardClear, standardContains, standardContainsAll, standardIsEmpty, standardRemove, standardRemoveAll, standardRetainAll, standardToArray, standardToArray, standardToString, toArray, toArray

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface Iterable

forEach

Method Details

delegate

protected Collection<E> delegate()

Specified by:

delegate in class com.google.common.collect.ForwardingCollection<E>

add

public boolean add(E element)

Specified by:

add in interface Collection<E>

Overrides:

add in class com.google.common.collect.ForwardingCollection<E>

remove

public boolean remove(Object element)

Specified by:

remove in interface Collection<E>

Overrides:

remove in class com.google.common.collect.ForwardingCollection<E>

removeAll

public boolean removeAll(Collection<?> toRemove)

Specified by:

removeAll in interface Collection<E>

Overrides:

removeAll in class com.google.common.collect.ForwardingCollection<E>

retainAll

public boolean retainAll(Collection<?> toRetain)

Specified by:

retainAll in interface Collection<E>

Overrides:

retainAll in class com.google.common.collect.ForwardingCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class com.google.common.collect.ForwardingCollection<E>

iterator

public Iterator<E> iterator()

Returns an iterator for the elements in the underlying collection. The returned iterator will not support Iterator.remove(), even if the original collection does allow this.

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface Iterable<E>

Overrides:

iterator in class com.google.common.collect.ForwardingCollection<E>

getFirst

public E getFirst()

flush

public Stream<E> flush()

Removes all elements from this collection, then returns a stream containing the elements that were just removed.

toString

public String toString()

Overrides:

toString in class com.google.common.collect.ForwardingObject

wrap

public static <E> SubscribableCollection<E> wrap(Collection<E> elements)

Returns a new SubscribableCollection instance that wraps the specified underlying collection.

getAddedElements

public Subject<E> getAddedElements()

getRemovedElements

public Subject<E> getRemovedElements()