Package org.eclipse.core.databinding.observable.list

Class AbstractObservableList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

org.eclipse.core.databinding.observable.list.AbstractObservableList<E>

Type Parameters:

E - the list element type

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>, IObservable, IObservableCollection<E>, IObservableList<E>

Direct Known Subclasses:

ComputedList, MultiList

public abstract class AbstractObservableList<E>
extends AbstractList<E>
implements IObservableList<E>

Subclasses should override at least get(int index) and size().

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

Implementation Note:

If methods are added to the interface which this class implements then implementations of those methods must be added to this class.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor	Description
AbstractObservableList()
AbstractObservableList(Realm realm)

Method Summary

Modifier and Type	Method	Description
boolean	add(E o)
boolean	addAll(int index, Collection<? extends E> c)
boolean	addAll(Collection<? extends E> c)
void	addChangeListener(IChangeListener listener)	Adds the given change listener to the list of change listeners.
void	addDisposeListener(IDisposeListener listener)	Adds the given dispose listener to the list of dispose listeners.
void	addListChangeListener(IListChangeListener<? super E> listener)	Adds the given list change listener to the list of list change listeners.
void	addStaleListener(IStaleListener listener)	Adds the given stale listener to the list of stale listeners.
protected void	checkRealm()	Asserts that the realm is the current realm.
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
void	dispose()	Disposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.
protected abstract int	doGetSize()
boolean	equals(Object o)
protected void	fireChange()	Fires change event.
protected void	fireListChange(ListDiff<E> diff)
protected void	fireStale()	Fires stale event.
protected void	firstListenerAdded()
Realm	getRealm()	Returns the realm for this observable.
int	hashCode()
protected boolean	hasListeners()	Returns whether this observable list has any registered listeners.
int	indexOf(Object o)
boolean	isDisposed()	Returns whether the observable has been disposed
boolean	isEmpty()
boolean	isStale()	Returns whether the state of this observable is stale and is expected to change soon.
Iterator<E>	iterator()
int	lastIndexOf(Object o)
protected void	lastListenerRemoved()
E	move(int oldIndex, int newIndex)	Moves the element located at oldIndex to newIndex.
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
void	removeChangeListener(IChangeListener listener)	Removes the given change listener from the list of change listeners.
void	removeDisposeListener(IDisposeListener listener)	Removes the given dispose listener from the list of dispose listeners.
void	removeListChangeListener(IListChangeListener<? super E> listener)	Removes the given list change listener from the list of list change listeners.
void	removeStaleListener(IStaleListener listener)	Removes the given stale listener from the list of stale listeners.
boolean	retainAll(Collection<?> c)
final int	size()
Object[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.util.AbstractList

add, clear, get, listIterator, listIterator, remove, removeRange, set, subList

Methods inherited from class java.util.AbstractCollection

toString

Methods inherited from class java.lang.Object

clone, 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.list.IObservableList

get, getElementType, listIterator, listIterator, remove, set, subList

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, clear, replaceAll, sort, spliterator

Constructor Details

AbstractObservableList

public AbstractObservableList(Realm realm)

Parameters:

realm - the realm; not null

AbstractObservableList

public AbstractObservableList()

Method Details

hasListeners

protected boolean hasListeners()

Returns whether this observable list has any registered listeners.

Returns:

whether this observable list has any registered listeners.

Since:

1.2

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:

true if this observable's state is stale and will change soon.

addListChangeListener

public void addListChangeListener(IListChangeListener<? super E> listener)

Description copied from interface: IObservableList

Adds the given list change listener to the list of list change listeners.

Specified by:

addListChangeListener in interface IObservableList<E>

Parameters:

listener - the change listener to add; not null

removeListChangeListener

public void removeListChangeListener(IListChangeListener<? super E> listener)

Description copied from interface: IObservableList

Removes the given list change listener from the list of list change listeners. Has no effect if the given listener is not registered as a list change listener.

Specified by:

removeListChangeListener in interface IObservableList<E>

Parameters:

listener - the change listener to remove; not null

fireListChange

protected void fireListChange(ListDiff<E> diff)

addChangeListener

public void addChangeListener(IChangeListener listener)

Description copied from interface: IObservable

Adds the given change listener to the list of change listeners. Change listeners are notified about changes of the state of this observable in a generic way, without specifying the change that happened. To get the changed state, a change listener needs to query for the current state of this observable.

Specified by:

addChangeListener in interface IObservable

Parameters:

listener - the listener to add; not null

removeChangeListener

public void removeChangeListener(IChangeListener listener)

Description copied from interface: IObservable

Removes the given change listener from the list of change listeners. Has no effect if the given listener is not registered as a change listener.

Specified by:

removeChangeListener in interface IObservable

Parameters:

listener - the listener to remove; not null

addStaleListener

public void addStaleListener(IStaleListener listener)

Description copied from interface: IObservable

Adds the given stale listener to the list of stale listeners. Stale listeners are notified when an observable object becomes stale, not when is becomes non-stale.

Specified by:

addStaleListener in interface IObservable

Parameters:

listener - the listener to add; not null

See Also:

• IObservable.isStale()

removeStaleListener

public void removeStaleListener(IStaleListener listener)

Description copied from interface: IObservable

Removes the given stale listener from the list of stale listeners. Has no effect if the given listener is not registered as a stale listener.

Specified by:

removeStaleListener in interface IObservable

Parameters:

listener - the listener to remove; not null

addDisposeListener

public void addDisposeListener(IDisposeListener listener)

Description copied from interface: IObservable

Adds the given dispose listener to the list of dispose listeners. Dispose listeners are notified when an observable has been disposed.

Specified by:

addDisposeListener in interface IObservable

Parameters:

listener - the listener to add

Since:

1.2

removeDisposeListener

public void removeDisposeListener(IDisposeListener listener)

Description copied from interface: IObservable

Removes the given dispose listener from the list of dispose listeners. Has no effect if the given listener is not registered as a dispose listener.

Specified by:

removeDisposeListener in interface IObservable

Parameters:

listener - the listener to remove

Since:

1.2

fireChange

protected void fireChange()

Fires change event. Must be invoked from the current realm.

fireStale

protected void fireStale()

Fires stale event. Must be invoked from the current realm.

firstListenerAdded

protected void firstListenerAdded()

lastListenerRemoved

protected void lastListenerRemoved()

isDisposed

public boolean isDisposed()

Description copied from interface: IObservable

Returns whether the observable has been disposed

Specified by:

isDisposed in interface IObservable

Returns:

whether the observable has been disposed

Since:

1.2

dispose

public void dispose()

Description copied from interface: IObservable

Disposes of this observable object, removing all listeners registered with this object, and all listeners this object might have registered on other objects.

Specified by:

dispose in interface IObservable

size

public final int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface IObservableList<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

doGetSize

protected abstract int doGetSize()

Returns:

the size

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<E>

Specified by:

isEmpty in interface IObservableList<E>

Specified by:

isEmpty in interface List<E>

Overrides:

isEmpty in class AbstractCollection<E>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<E>

Specified by:

contains in interface IObservableList<E>

Specified by:

contains in interface List<E>

Overrides:

contains in class AbstractCollection<E>

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Collection<E>

Specified by:

iterator in interface IObservableList<E>

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface List<E>

Overrides:

iterator in class AbstractList<E>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface IObservableList<E>

Specified by:

toArray in interface List<E>

Overrides:

toArray in class AbstractCollection<E>

toArray

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

Specified by:

toArray in interface Collection<E>

Specified by:

toArray in interface IObservableList<E>

Specified by:

toArray in interface List<E>

Overrides:

toArray in class AbstractCollection<E>

add

public boolean add(E o)

Specified by:

add in interface Collection<E>

Specified by:

add in interface IObservableList<E>

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

move

public E move(int oldIndex,
 int newIndex)

Moves the element located at oldIndex to newIndex. This method is equivalent to calling add(newIndex, remove(oldIndex)).

Subclasses should override this method to deliver list change notification for the remove and add operations in the same ListChangeEvent, as this allows ListDiff.accept(ListDiffVisitor) to recognize the operation as a move.

Specified by:

move in interface IObservableList<E>

Parameters:

oldIndex - the element's position before the move. Must be within the range 0 <= oldIndex < size().

newIndex - the element's position after the move. Must be within the range 0 <= newIndex < size().

Returns:

the element that was moved.

Throws:

IndexOutOfBoundsException - if either argument is out of range ( 0 <= index < size()).

Since:

1.1

See Also:

• ListDiffVisitor.handleMove(int, int, Object)
• ListDiff.accept(ListDiffVisitor)

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface IObservableList<E>

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractCollection<E>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<E>

Specified by:

containsAll in interface IObservableList<E>

Specified by:

containsAll in interface List<E>

Overrides:

containsAll in class AbstractCollection<E>

addAll

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

Specified by:

addAll in interface Collection<E>

Specified by:

addAll in interface IObservableList<E>

Specified by:

addAll in interface List<E>

Overrides:

addAll in class AbstractCollection<E>

addAll

public boolean addAll(int index,
 Collection<? extends E> c)

Specified by:

addAll in interface IObservableList<E>

Specified by:

addAll in interface List<E>

Overrides:

addAll in class AbstractList<E>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface IObservableList<E>

Specified by:

removeAll in interface List<E>

Overrides:

removeAll in class AbstractCollection<E>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface IObservableList<E>

Specified by:

retainAll in interface List<E>

Overrides:

retainAll in class AbstractCollection<E>

equals

public boolean equals(Object o)

Specified by:

equals in interface Collection<E>

Specified by:

equals in interface IObservableList<E>

Specified by:

equals in interface List<E>

Overrides:

equals in class AbstractList<E>

hashCode

public int hashCode()

Specified by:

hashCode in interface Collection<E>

Specified by:

hashCode in interface IObservableList<E>

Specified by:

hashCode in interface List<E>

Overrides:

hashCode in class AbstractList<E>

indexOf

public int indexOf(Object o)

Specified by:

indexOf in interface IObservableList<E>

Specified by:

indexOf in interface List<E>

Overrides:

indexOf in class AbstractList<E>

lastIndexOf

public int lastIndexOf(Object o)

Specified by:

lastIndexOf in interface IObservableList<E>

Specified by:

lastIndexOf in interface List<E>

Overrides:

lastIndexOf in class AbstractList<E>

getRealm

public Realm getRealm()

Description copied from interface: IObservable

Returns the realm for this observable. Unless otherwise specified, getters and setters must be accessed from within this realm. Listeners will be within this realm when they receive events from this observable.

Because observables can only be accessed from within one realm, and they always fire events on that realm, their state can be observed in an incremental way. It is always safe to call getters of an observable from within a change listener attached to that observable.

Specified by:

getRealm in interface IObservable

Returns:

the realm

checkRealm

protected void checkRealm()

Asserts that the realm is the current realm.

Throws:

AssertionFailedException - if the realm is not the current realm

See Also:

• Realm.isCurrent()