oracle.javatools.util

Class ListenableArrayList<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<E>

oracle.javatools.util.ListenableArrayList<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, java.util.RandomAccess, ListenableCollection<E>

public class ListenableArrayList<E>
extends java.util.ArrayList<E>
implements ListenableCollection<E>

An extension of ArrayList that generates notification events when the list contents are modified.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
ListenableArrayList()
ListenableArrayList(java.util.Collection<? extends E> collection) Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
ListenableArrayList(int initialCapacity) Constructs an empty list with the specified initial capacity.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(E e) Appends the specified element to the end of this list.
void	add(int index, E e) Inserts the specified element at the specified position in this list.
boolean	addAll(java.util.Collection<? extends E> c) Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's Iterator.
boolean	addAll(int index, java.util.Collection<? extends E> c) Inserts all of the elements in the specified collection into this list, starting at the specified position.
void	addListener(CollectionListener<E> listener) Add a listener to be notified when the list changes.
void	clear() Removes all of the elements from this list.
protected java.util.List<CollectionListener<E>>	createListenerList() Create a list to hold the registered listeners.
protected void	fireChange(CollectionEvent.Type type, E element, int index)
E	remove(int index) Removes the element at the specified position in this list.
boolean	remove(java.lang.Object o) Removes the first occurrence of the specified element from this list, if it is present.
boolean	removeAll(java.util.Collection<?> c)
void	removeListener(CollectionListener<E> listener) Stop listening for changes to the collection.
protected void	removeRange(int fromIndex, int toIndex) Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive.
boolean	retainAll(java.util.Collection<?> c)

Methods inherited from class java.util.ArrayList

clone, contains, ensureCapacity, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, set, size, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, iterator, size, toArray, toArray

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Constructor Detail

ListenableArrayList

public ListenableArrayList(java.util.Collection<? extends E> collection)

Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Parameters:

collection - the collection whose elements are to be placed into this list

Throws:

java.lang.NullPointerException - if the specified collection is null

ListenableArrayList

public ListenableArrayList()

ListenableArrayList

public ListenableArrayList(int initialCapacity)

Constructs an empty list with the specified initial capacity.

Parameters:

initialCapacity - the initial capacity of the list

Throws:

java.lang.IllegalArgumentException - if the specified initial capacity is negative

Method Detail

createListenerList

protected java.util.List<CollectionListener<E>> createListenerList()

Create a list to hold the registered listeners. Subclasses may wish to use an alternative to CopyOnWriteArrayList.

Returns:

the list that holds the listeners.

addListener

public void addListener(CollectionListener<E> listener)

Add a listener to be notified when the list changes.

Specified by:

addListener in interface ListenableCollection<E>

Parameters:

listener -

removeListener

public void removeListener(CollectionListener<E> listener)

Description copied from interface: ListenableCollection

Stop listening for changes to the collection.

Specified by:

removeListener in interface ListenableCollection<E>

add

public boolean add(E e)

Appends the specified element to the end of this list.

Specified by:

add in interface java.util.Collection<E>

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.ArrayList<E>

Parameters:

e - element to be appended to this list

Returns:

true (as specified by Collection.add(E))

add

public void add(int index,
       E e)

Inserts the specified element at the specified position in this list. Shifts the element currently at that position (if any) and any subsequent elements to the right (adds one to their indices).

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.ArrayList<E>

Parameters:

index - index at which the specified element is to be inserted

e - element to be inserted

Throws:

java.lang.IndexOutOfBoundsException

addAll

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

Appends all of the elements in the specified collection to the end of this list, in the order that they are returned by the specified collection's Iterator. The behavior of this operation is undefined if the specified collection is modified while the operation is in progress. (This implies that the behavior of this call is undefined if the specified collection is this list, and this list is nonempty.)

Specified by:

addAll in interface java.util.Collection<E>

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.ArrayList<E>

Parameters:

c - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.NullPointerException - if the specified collection is null

addAll

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

Inserts all of the elements in the specified collection into this list, starting at the specified position. Shifts the element currently at that position (if any) and any subsequent elements to the right (increases their indices). The new elements will appear in the list in the order that they are returned by the specified collection's iterator.

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.ArrayList<E>

Parameters:

index - index at which to insert the first element from the specified collection

c - collection containing elements to be added to this list

Returns:

true if this list changed as a result of the call

Throws:

java.lang.IndexOutOfBoundsException

java.lang.NullPointerException - if the specified collection is null

clear

public void clear()

Removes all of the elements from this list. The list will be empty after this call returns.

Specified by:

clear in interface java.util.Collection<E>

Specified by:

clear in interface java.util.List<E>

Overrides:

clear in class java.util.ArrayList<E>

remove

public E remove(int index)

Removes the element at the specified position in this list. Shifts any subsequent elements to the left (subtracts one from their indices).

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.ArrayList<E>

Parameters:

index - the index of the element to be removed

Returns:

the element that was removed from the list

Throws:

java.lang.IndexOutOfBoundsException

remove

public boolean remove(java.lang.Object o)

Removes the first occurrence of the specified element from this list, if it is present. If the list does not contain the element, it is unchanged. More formally, removes the element with the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))) (if such an element exists). Returns true if this list contained the specified element (or equivalently, if this list changed as a result of the call).

Specified by:

remove in interface java.util.Collection<E>

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.ArrayList<E>

Parameters:

o - element to be removed from this list, if present

Returns:

true if this list contained the specified element

removeRange

protected void removeRange(int fromIndex,
               int toIndex)

Removes from this list all of the elements whose index is between fromIndex, inclusive, and toIndex, exclusive. Shifts any succeeding elements to the left (reduces their index). This call shortens the fireRemoval(list by (toIndex - fromIndex) elements. (If toIndex==fromIndex, this operation has no effect.)

Overrides:

removeRange in class java.util.ArrayList<E>

Parameters:

fromIndex - index of first element to be removed

toIndex - index after last element to be removed

Throws:

java.lang.IndexOutOfBoundsException - if fromIndex or toIndex out of range (fromIndex < 0 || fromIndex >= size() || toIndex > size() || toIndex < fromIndex)

fireChange

protected void fireChange(CollectionEvent.Type type,
              E element,
              int index)

removeAll

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

This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's so contained, it's removed from this collection with the iterator's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements in common with the specified collection.

Specified by:

removeAll in interface java.util.Collection<E>

Specified by:

removeAll in interface java.util.List<E>

Overrides:

removeAll in class java.util.ArrayList<E>

Throws:

java.lang.UnsupportedOperationException

java.lang.ClassCastException

java.lang.NullPointerException

See Also:

remove(Object), ArrayList.contains(Object)

retainAll

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

This implementation iterates over this collection, checking each element returned by the iterator in turn to see if it's contained in the specified collection. If it's not so contained, it's removed from this collection with the iterator's remove method.

Note that this implementation will throw an UnsupportedOperationException if the iterator returned by the iterator method does not implement the remove method and this collection contains one or more elements not present in the specified collection.

Specified by:

retainAll in interface java.util.Collection<E>

Specified by:

retainAll in interface java.util.List<E>

Overrides:

retainAll in class java.util.ArrayList<E>

Throws:

java.lang.UnsupportedOperationException

java.lang.ClassCastException

java.lang.NullPointerException

See Also:

remove(Object), ArrayList.contains(Object)