info.bioinfweb.commons.collections.observable

Class ObservableList<E>

java.lang.Object

info.bioinfweb.commons.collections.ListDecorator<E>

info.bioinfweb.commons.collections.observable.ObservableList<E>

Type Parameters:

E - the type of elements in the decorated (and this) list

All Implemented Interfaces:

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

public class ObservableList<E>
extends ListDecorator<E>

Decorator for an instance of List that allows to track modifications of the underlying list using an ListChangeListener.

Since:

1.1.0

Author:

Ben Stöver

Constructor Summary

Constructors

Constructor and Description
ObservableList(java.util.List<E> underlyingList) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
void	addListChangeListener(ListChangeListener<E> listener) Adds a change listener to track changes of the underlying list.
protected void	afterAdd(int index, java.util.Collection<? extends E> addedElements) This method is called at the end of all methods of this list that add elements to it, including methods called on the results of or iterators.
protected void	afterRemove(int index, java.util.Collection<? extends E> removedElements) This method is called at the end of all methods of this list that remove elements from it, including methods called on the results of ListDecorator.subList(int, int) or iterators.
protected void	afterReplace(int index, E previousElement, E currentElement) This method is called at the end of ListDecorator.set(int, Object) to indicate that an element has been replaced.
protected void	beforeAdd(int index, java.util.Collection<? extends E> addedElements) This method is called at the beginning of all methods of this list that add elements to it (including methods called on the results of ListDecorator.subList(int, int) or iterators) before the actual inserting happens.
protected void	beforeRemove(int index, java.util.Collection<java.lang.Object> removedElements) This method is called at the beginning of all methods of this list that remove elements from it (including methods called on the results of ListDecorator.subList(int, int) or iterators) before the actual deletion happens.
protected void	beforeReplace(int index, E currentElement, E newElement) This method is called at the beginning of ListDecorator.set(int, Object) to indicate that an element will be replaced.
boolean	removeListChangeListener(ListChangeListener<E> listener) Removes a listener from this list.

Methods inherited from class info.bioinfweb.commons.collections.ListDecorator

add, add, addAll, addAll, clear, contains, containsAll, createDecoratedListIterator, equals, get, getUnderlyingList, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.List

replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ObservableList

public ObservableList(java.util.List<E> underlyingList)

Creates a new instance of this class.

Parameters:

underlyingList - the list to be observed

Method Detail

addListChangeListener

public void addListChangeListener(ListChangeListener<E> listener)

Adds a change listener to track changes of the underlying list.

Parameters:

listener - the listener to add

removeListChangeListener

public boolean removeListChangeListener(ListChangeListener<E> listener)

Removes a listener from this list.

Parameters:

listener - the listener to be removed

Returns:

true if this list contained the specified element

beforeAdd

protected void beforeAdd(int index,
                         java.util.Collection<? extends E> addedElements)

Description copied from class: ListDecorator

This method is called at the beginning of all methods of this list that add elements to it (including methods called on the results of ListDecorator.subList(int, int) or iterators) before the actual inserting happens. This default implementation is empty and can be overwritten by inherited classes which want to track modifications of the list.

If more than one element will be add in one operation (e.g. ListDecorator.addAll(Collection)) this method is only called once before the first elements is inserted.

Overrides:

beforeAdd in class ListDecorator<E>

Parameters:

index - the index where the first new element will be inserted

addedElements - the elements that shall be add (Always contains at least one element.)

afterAdd

protected void afterAdd(int index,
                        java.util.Collection<? extends E> addedElements)

Description copied from class: ListDecorator

This method is called at the end of all methods of this list that add elements to it, including methods called on the results of or iterators. This default implementation is empty and can be overwritten by inherited classes which want to track modifications of the list.

If more than one element is add in one operation (e.g. ListDecorator.addAll(Collection)) this method is only called once when all elements have been inserted.

Note that this method is not called if an add operation is not successful. In such a case only ListDecorator.beforeAdd(int, Collection) is called.

Overrides:

afterAdd in class ListDecorator<E>

Parameters:

index - the index where the first new element has been inserted

addedElements - the elements that have been add (Always contains at least one element.)

beforeReplace

protected void beforeReplace(int index,
                             E currentElement,
                             E newElement)

Description copied from class: ListDecorator

This method is called at the beginning of ListDecorator.set(int, Object) to indicate that an element will be replaced. This default implementation is empty and can be overwritten by inherited classes which want to track modifications of the list.

Overrides:

beforeReplace in class ListDecorator<E>

Parameters:

index - the index where the element will be replaced

currentElement - the element that will be replaced

newElement - the new element that shall replace the current one

afterReplace

protected void afterReplace(int index,
                            E previousElement,
                            E currentElement)

Description copied from class: ListDecorator

This method is called at the end of ListDecorator.set(int, Object) to indicate that an element has been replaced. This default implementation is empty and can be overwritten by inherited classes which want to track modifications of the list.

Overrides:

afterReplace in class ListDecorator<E>

Parameters:

index - the index where the element has been replaced

previousElement - the element that was replaced

currentElement - the new element that is now contained in the list

beforeRemove

protected void beforeRemove(int index,
                            java.util.Collection<java.lang.Object> removedElements)

Description copied from class: ListDecorator

This method is called at the beginning of all methods of this list that remove elements from it (including methods called on the results of ListDecorator.subList(int, int) or iterators) before the actual deletion happens. This default implementation is empty and can be overwritten by inherited classes which want to track modifications of the list.

If more than one element will be removed in one operation (e.g. ListDecorator.retainAll(Collection)) this method is only called once before the first element is removed.

Overrides:

beforeRemove in class ListDecorator<E>

removedElements - the elements that have been removed.

afterRemove

protected void afterRemove(int index,
                           java.util.Collection<? extends E> removedElements)

Description copied from class: ListDecorator

This method is called at the end of all methods of this list that remove elements from it, including methods called on the results of ListDecorator.subList(int, int) or iterators. This default implementation is empty and can be overwritten by inherited classes which want to track modifications of the list.

If more than one element is removed in one operation (e.g. ListDecorator.retainAll(Collection)) this method is only called once when all elements have been removed.

Note that this method is not called if an add operation is not successful. In such a case only #beforeRemove(Collection) is called.

Overrides:

afterRemove in class ListDecorator<E>

removedElements - the elements that have been removed.