Package org.eclipse.core.databinding.observable.set

Class ObservableSet<E>

java.lang.Object

org.eclipse.core.databinding.observable.AbstractObservable

org.eclipse.core.databinding.observable.set.ObservableSet<E>

Type Parameters:

E - the type of elements in this collection

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, java.util.Set<E>, IObservable, IObservableCollection<E>, IObservableSet<E>

Direct Known Subclasses:

ListToSetAdapter, MappedSet, UnionSet, WritableSet

public abstract class ObservableSet<E>
extends AbstractObservable
implements IObservableSet<E>

Abstract implementation of IObservableSet.

This class is thread safe. All state accessing methods must be invoked from the current realm. Methods for adding and removing listeners may be invoked from any thread.

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.Object	elementType
protected java.util.Set<E>	wrappedSet

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ObservableSet(java.util.Set<E> wrappedSet, java.lang.Object elementType)
protected	ObservableSet(Realm realm, java.util.Set<E> wrappedSet, java.lang.Object elementType)

Method Summary

Modifier and Type	Method	Description
boolean	add(E o)
boolean	addAll(java.util.Collection<? extends E> c)
protected void	addListener(java.lang.Object listenerType, IObservablesListener listener)
void	addSetChangeListener(ISetChangeListener<? super E> listener)
void	clear()
protected java.lang.Object	clone()
boolean	contains(java.lang.Object o)
boolean	containsAll(java.util.Collection<?> c)
boolean	equals(java.lang.Object o)
protected void	fireChange()
protected void	fireEvent(ObservableEvent event)
protected void	fireSetChange(SetDiff<E> diff)
protected void	firstListenerAdded()
java.lang.Object	getElementType()	Returns the element type of this observable collection, or null if this observable collection is untyped.
Realm	getRealm()
protected void	getterCalled()
int	hashCode()
protected boolean	hasListeners()
boolean	isEmpty()
boolean	isStale()	Returns whether the state of this observable is stale and is expected to change soon.
java.util.Iterator<E>	iterator()
protected void	lastListenerRemoved()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c)
protected void	removeListener(java.lang.Object listenerType, IObservablesListener listener)
void	removeSetChangeListener(ISetChangeListener<? super E> listener)
boolean	retainAll(java.util.Collection<?> c)
void	setStale(boolean stale)
protected void	setWrappedSet(java.util.Set<E> wrappedSet)
int	size()
java.lang.Object[]	toArray()
<T> T[]	toArray(T[] a)
java.lang.String	toString()

Methods inherited from class org.eclipse.core.databinding.observable.AbstractObservable

addChangeListener, addDisposeListener, addStaleListener, checkRealm, dispose, fireStale, isDisposed, removeChangeListener, removeDisposeListener, removeStaleListener

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface org.eclipse.core.databinding.observable.IObservable

addChangeListener, addDisposeListener, addStaleListener, dispose, getRealm, isDisposed, removeChangeListener, removeDisposeListener, removeStaleListener

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

spliterator

Field Detail

wrappedSet

protected java.util.Set<E> wrappedSet

elementType

protected java.lang.Object elementType

Constructor Detail

ObservableSet

protected ObservableSet(java.util.Set<E> wrappedSet,
                        java.lang.Object elementType)

ObservableSet

protected ObservableSet(Realm realm,
                        java.util.Set<E> wrappedSet,
                        java.lang.Object elementType)

Method Detail

addSetChangeListener

public void addSetChangeListener(ISetChangeListener<? super E> listener)

Specified by:

addSetChangeListener in interface IObservableSet<E>

Parameters:

listener - the change listener to add; not null

removeSetChangeListener

public void removeSetChangeListener(ISetChangeListener<? super E> listener)

Specified by:

removeSetChangeListener in interface IObservableSet<E>

Parameters:

listener - the change listener to remove; not null

fireSetChange

protected void fireSetChange(SetDiff<E> diff)

contains

public boolean contains(java.lang.Object o)

Specified by:

contains in interface java.util.Collection<E>

Specified by:

contains in interface IObservableSet<E>

Specified by:

contains in interface java.util.Set<E>

containsAll

public boolean containsAll(java.util.Collection<?> c)

Specified by:

containsAll in interface java.util.Collection<E>

Specified by:

containsAll in interface IObservableSet<E>

Specified by:

containsAll in interface java.util.Set<E>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface java.util.Collection<E>

Specified by:

equals in interface IObservableSet<E>

Specified by:

equals in interface java.util.Set<E>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Collection<E>

Specified by:

hashCode in interface IObservableSet<E>

Specified by:

hashCode in interface java.util.Set<E>

Overrides:

hashCode in class java.lang.Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Collection<E>

Specified by:

isEmpty in interface IObservableSet<E>

Specified by:

isEmpty in interface java.util.Set<E>

iterator

public java.util.Iterator<E> iterator()

Specified by:

iterator in interface java.util.Collection<E>

Specified by:

iterator in interface IObservableSet<E>

Specified by:

iterator in interface java.lang.Iterable<E>

Specified by:

iterator in interface java.util.Set<E>

size

public int size()

Specified by:

size in interface java.util.Collection<E>

Specified by:

size in interface IObservableSet<E>

Specified by:

size in interface java.util.Set<E>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface IObservableSet<E>

Specified by:

toArray in interface java.util.Set<E>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface java.util.Collection<E>

Specified by:

toArray in interface IObservableSet<E>

Specified by:

toArray in interface java.util.Set<E>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getterCalled

protected void getterCalled()

add

public boolean add(E o)

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface IObservableSet<E>

Specified by:

add in interface java.util.Set<E>

addAll

public boolean addAll(java.util.Collection<? extends E> c)

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface IObservableSet<E>

Specified by:

addAll in interface java.util.Set<E>

remove

public boolean remove(java.lang.Object o)

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface IObservableSet<E>

Specified by:

remove in interface java.util.Set<E>

removeAll

public boolean removeAll(java.util.Collection<?> c)

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface IObservableSet<E>

Specified by:

removeAll in interface java.util.Set<E>

retainAll

public boolean retainAll(java.util.Collection<?> c)

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface IObservableSet<E>

Specified by:

retainAll in interface java.util.Set<E>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.Set<E>

isStale

public boolean isStale()

Description copied from interface: IObservable

Returns whether the state of this observable is stale and is expected to change soon. A non-stale observable that becomes stale will notify its stale listeners. A stale object that becomes non-stale does so by changing its state and notifying its change listeners, it does not notify its stale listeners about becoming non-stale. Clients that do not expect asynchronous changes may ignore staleness of observable objects.

Specified by:

isStale in interface IObservable

Returns:

Returns the stale state.

setStale

public void setStale(boolean stale)

Parameters:

stale - The stale state to set. This will fire a stale event if the given boolean is true and this observable set was not already stale.

setWrappedSet

protected void setWrappedSet(java.util.Set<E> wrappedSet)

Parameters:

wrappedSet - The wrappedSet to set.

fireChange

protected void fireChange()

Overrides:

fireChange in class AbstractObservable

getElementType

public java.lang.Object getElementType()

Description copied from interface: IObservableCollection

Returns the element type of this observable collection, or null if this observable collection is untyped.

Specified by:

getElementType in interface IObservableCollection<E>

Specified by:

getElementType in interface IObservableSet<E>

Returns:

the element type or null if untyped

addListener

protected void addListener(java.lang.Object listenerType,
                           IObservablesListener listener)

Parameters:

listenerType - arbitrary object to identify a type of the listener

listener - the listener to add; not null

removeListener

protected void removeListener(java.lang.Object listenerType,
                              IObservablesListener listener)

Parameters:

listenerType - arbitrary object to identify a type of the listener

listener - the listener to remove; not null

hasListeners

protected boolean hasListeners()

fireEvent

protected void fireEvent(ObservableEvent event)

firstListenerAdded

protected void firstListenerAdded()

lastListenerRemoved

protected void lastListenerRemoved()

getRealm

public Realm getRealm()

Returns:

Returns the realm.

clone

protected java.lang.Object clone()
                          throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException