com.gargoylesoftware.base.collections
Class NotificationList

java.lang.Object
  com.gargoylesoftware.base.collections.NotificationList

All Implemented Interfaces:

Collection, List

public class NotificationList

extends Object

implements List

This is a wrapper for a List object that fires NotificationListEvent's whenever the list is modified.

Version:

$Revision: 1.5 $

Author:

Mike Bowler

Constructor Summary

NotificationList(List delegate)
Construct a new NotificationList.

Method Summary

void	add(int index, Object element) Inserts the specified element at the specified position in this list (optional operation).
boolean	add(Object object) Appends the specified element to the end of this list (optional operation).
boolean	addAll(Collection collection) 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 (optional operation).
boolean	addAll(int index, Collection collection) Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
void	addNotificationListListener(NotificationListListener listener) Add a NotificationListListener.
void	clear() Removes all of the elements from this list (optional operation).
boolean	contains(Object object) Returns true if this list contains the specified element.
boolean	containsAll(Collection collection) Returns true if this list contains all of the elements of the specified collection.
Object	get(int index) Returns the element at the specified position in this list.
int	indexOf(Object object) Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.
boolean	isEmpty() Returns true if this list contains no elements.
Iterator	iterator() Returns an iterator over the elements in this list in proper sequence.
int	lastIndexOf(Object object) Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.
ListIterator	listIterator() Returns a list iterator of the elements in this list (in proper sequence).
ListIterator	listIterator(int index) Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.
Object	remove(int index) Removes the element at the specified position in this list (optional operation).
boolean	remove(Object object) Removes the first occurrence in this list of the specified element (optional operation).
boolean	removeAll(Collection collection) Removes from this list all the elements that are contained in the specified collection (optional operation).
void	removeNotificationListListener(NotificationListListener listener) Remove a NotificationListListener.
boolean	retainAll(Collection collection) Retains only the elements in this list that are contained in the specified collection (optional operation).
Object	set(int index, Object element) Replaces the element at the specified position in this list with the specified element (optional operation).
int	size() Returns the number of elements in this list.
List	subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
Object[]	toArray() Returns an array containing all of the elements in this list in proper sequence.
Object[]	toArray(Object[] array) Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

NotificationList

public NotificationList(List delegate)

Construct a new NotificationList.

Parameters:

delegate - The list that we will delegate requests to.

Method Detail

add

public boolean add(Object object)
            throws UnsupportedOperationException

Appends the specified element to the end of this list (optional operation).

Lists that support this operation may place limitations on what elements may be added to this list. In particular, some lists will refuse to add null elements, and others will impose restrictions on the type of elements that may be added. List classes should clearly specify in their documentation any restrictions on what elements may be added.

Specified by:

add in interface List

Parameters:

object - element to be appended to this list.

Returns:

true (as per the general contract of the Collection.add method).

Throws:

UnsupportedOperationException - if the add method is not supported by this list.

add

public void add(int index,
                Object element)
         throws UnsupportedOperationException

Inserts the specified element at the specified position in this list (optional operation). 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 List

Parameters:

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

element - element to be inserted.

Throws:

UnsupportedOperationException - if the add method is not supported by this list.

addAll

public boolean addAll(Collection collection)
               throws UnsupportedOperationException

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 (optional operation). The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Specified by:

addAll in interface List

Parameters:

collection - collection whose elements are to be added to this list.

Returns:

true if this list changed as a result of the call.

Throws:

UnsupportedOperationException - if the addAll method is not supported by this list.

See Also:

add(Object)

addAll

public boolean addAll(int index,
                      Collection collection)
               throws UnsupportedOperationException

Inserts all of the elements in the specified collection into this list at the specified position (optional operation). 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 this list in the order that they are returned by the specified collection's iterator. The behavior of this operation is unspecified if the specified collection is modified while the operation is in progress. (Note that this will occur if the specified collection is this list, and it's nonempty.)

Specified by:

addAll in interface List

Parameters:

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

collection - elements to be inserted into this list.

Returns:

true if this list changed as a result of the call.

Throws:

UnsupportedOperationException - if the addAll method is not supported by this list.

get

public Object get(int index)

Returns the element at the specified position in this list.

Specified by:

get in interface List

Parameters:

index - index of element to return.

Returns:

the element at the specified position in this list.

set

public Object set(int index,
                  Object element)
           throws UnsupportedOperationException

Replaces the element at the specified position in this list with the specified element (optional operation).

Specified by:

set in interface List

Parameters:

index - index of element to replace.

element - element to be stored at the specified position.

Returns:

the element previously at the specified position.

Throws:

UnsupportedOperationException - if the set method is not supported by this list.

remove

public Object remove(int index)
              throws UnsupportedOperationException

Removes the element at the specified position in this list (optional operation). Shifts any subsequent elements to the left (subtracts one from their indices). Returns the element that was removed from the list.

Specified by:

remove in interface List

Parameters:

index - the index of the element to removed.

Returns:

the element previously at the specified position.

Throws:

UnsupportedOperationException - if the remove method is not supported by this list.

remove

public boolean remove(Object object)
               throws UnsupportedOperationException

Removes the first occurrence in this list of the specified element (optional operation). If this 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).

Specified by:

remove in interface List

Parameters:

object - element to be removed from this list, if present.

Returns:

true if this list contained the specified element.

Throws:

UnsupportedOperationException - if the remove method is not supported by this list.

removeAll

public boolean removeAll(Collection collection)
                  throws UnsupportedOperationException

Removes from this list all the elements that are contained in the specified collection (optional operation). Implementation note This is currently unsupported.

Specified by:

removeAll in interface List

Parameters:

collection - collection that defines which elements will be removed from this list.

Returns:

true if this list changed as a result of the call.

Throws:

UnsupportedOperationException - if the removeAll method is not supported by this list.

See Also:

remove(Object), contains(Object)

retainAll

public boolean retainAll(Collection collection)
                  throws UnsupportedOperationException

Retains only the elements in this list that are contained in the specified collection (optional operation). In other words, removes from this list all the elements that are not contained in the specified collection. Implementation note This is currently unsupported.

Specified by:

retainAll in interface List

Parameters:

collection - collection that defines which elements this set will retain.

Returns:

true if this list changed as a result of the call.

Throws:

UnsupportedOperationException - if the retainAll method is not supported by this list.

See Also:

remove(Object), contains(Object)

indexOf

public int indexOf(Object object)

Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the lowest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

indexOf in interface List

Parameters:

object - element to search for.

Returns:

the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.

lastIndexOf

public int lastIndexOf(Object object)

Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element. More formally, returns the highest index i such that (o==null ? get(i)==null : o.equals(get(i))), or -1 if there is no such index.

Specified by:

lastIndexOf in interface List

Parameters:

object - element to search for.

Returns:

the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.

listIterator

public ListIterator listIterator()

Returns a list iterator of the elements in this list (in proper sequence).

Specified by:

listIterator in interface List

Returns:

a list iterator of the elements in this list (in proper sequence).

listIterator

public ListIterator listIterator(int index)

Returns a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

Specified by:

listIterator in interface List

Parameters:

index - index of first element to be returned from the list iterator (by a call to the next method).

Returns:

a list iterator of the elements in this list (in proper sequence), starting at the specified position in this list.

subList

public List subList(int fromIndex,
                    int toIndex)

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned list is backed by this list, so changes in the returned list are reflected in this list, and vice-versa. The returned list supports all of the optional list operations supported by this list.

This method eliminates the need for explicit range operations (of the sort that commonly exist for arrays). Any operation that expects a list can be used as a range operation by passing a subList view instead of a whole list. For example, the following idiom removes a range of elements from a list:

            list.subList(from, to).clear();
 

Similar idioms may be constructed for indexOf and lastIndexOf, and all of the algorithms in the Collections class can be applied to a subList.

The semantics of this list returned by this method become undefined if the backing list (i.e., this list) is structurally modified in any way other than via the returned list. (Structural modifications are those that change the size of this list, or otherwise perturb it in such a fashion that iterations in progress may yield incorrect results.)

Specified by:

subList in interface List

Parameters:

fromIndex - low endpoint (inclusive) of the subList.

toIndex - high endpoint (exclusive) of the subList.

Returns:

a view of the specified range within this list.

iterator

public Iterator iterator()

Returns an iterator over the elements in this list in proper sequence.

Specified by:

iterator in interface List

Returns:

an iterator over the elements in this list in proper sequence.

containsAll

public boolean containsAll(Collection collection)

Returns true if this list contains all of the elements of the specified collection.

Specified by:

containsAll in interface List

Parameters:

collection - collection to be checked for containment in this list.

Returns:

true if this list contains all of the elements of the specified collection.

See Also:

contains(Object)

contains

public boolean contains(Object object)

Returns true if this list contains the specified element. More formally, returns true if and only if this list contains at least one element e such that (o==null ? e==null : o.equals(e)).

Specified by:

contains in interface List

Parameters:

object - element whose presence in this list is to be tested.

Returns:

true if this list contains the specified element.

clear

public void clear()
           throws UnsupportedOperationException

Removes all of the elements from this list (optional operation). This list will be empty after this call returns (unless it throws an exception).

Specified by:

clear in interface List

Throws:

UnsupportedOperationException - if the clear method is not supported by this list.

isEmpty

public boolean isEmpty()

Returns true if this list contains no elements.

Specified by:

isEmpty in interface List

Returns:

true if this list contains no elements.

size

public int size()

Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Specified by:

size in interface List

Returns:

the number of elements in this list.

toArray

public Object[] toArray()

Returns an array containing all of the elements in this list in proper sequence. Obeys the general contract of the List.toArray method.

Specified by:

toArray in interface List

Returns:

an array containing all of the elements in this list in proper sequence.

See Also:

List.toArray(Object[])

toArray

public Object[] toArray(Object[] array)
                 throws ArrayStoreException

Returns an array containing all of the elements in this list in proper sequence; the runtime type of the returned array is that of the specified array. Obeys the general contract of the Collection.toArray(Object[]) method.

Specified by:

toArray in interface List

Parameters:

array - the array into which the elements of this list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

an array containing the elements of this list.

Throws:

ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this list.

addNotificationListListener

public void addNotificationListListener(NotificationListListener listener)

Add a NotificationListListener.

Parameters:

listener - The listener to add.

removeNotificationListListener

public void removeNotificationListListener(NotificationListListener listener)

Remove a NotificationListListener.

Parameters:

listener - The listener to remove.