com.jgoodies.common.collect
Class LinkedListModel<E>

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.AbstractSequentialList<E>
              java.util.LinkedList<E>
                  com.jgoodies.common.collect.LinkedListModel<E>

Type Parameters:

E - the type of the list elements

All Implemented Interfaces:

ObservableList<E>, Serializable, Cloneable, Iterable<E>, Collection<E>, Deque<E>, List<E>, Queue<E>, ListModel

public class LinkedListModel<E>
extends LinkedList<E>
implements ObservableList<E>

Adds ListModel capabilities to its superclass It allows to observe changes in the content and structure. Useful fo Lists that are bound to list views such as JList, JComboBox and JTable.

Version:

$Revision: 1.3 $

Author:

Karsten Lentzsch

See Also:

ObservableList, ArrayListModel, Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

LinkedListModel()
Constructs an empty LinkedListModel.

LinkedListModel(Collection<? extends E> c)
Constructs a LinkedListModel containing the elements of the specifie collection, in the order they are returned by the collection' iterator.

Method Summary

boolean	add(E e)
void	add(int index, E element)
boolean	addAll(int index, Collection<? extends E> c)
void	addFirst(E e)
void	addLast(E e)
void	addListDataListener(ListDataListener l)
void	clear()
void	fireContentsChanged(int index) Notifies all registered ListDataListeners that the elemen at the specified index has changed.
E	getElementAt(int index)
ListDataListener[]	getListDataListeners() Returns an array of all the list data listener registered on this LinkedListModel.
int	getSize()
ListIterator<E>	listIterator(int index)
E	remove(int index)
boolean	remove(Object o)
boolean	removeAll(Collection<?> c) Removes from this collection all of its elements that are contained i the specified collection (optional operation).
E	removeFirst()
E	removeLast()
void	removeListDataListener(ListDataListener l)
protected void	removeRange(int fromIndex, int toIndex)
boolean	retainAll(Collection<?> c) Retains only the elements in this collection that are contained in th specified collection (optional operation).
E	set(int index, E element)

Methods inherited from class java.util.LinkedList

addAll, clone, contains, descendingIterator, element, get, getFirst, getLast, indexOf, lastIndexOf, offer, offerFirst, offerLast, peek, peekFirst, peekLast, poll, pollFirst, pollLast, pop, push, remove, removeFirstOccurrence, removeLastOccurrence, size, toArray, toArray

Methods inherited from class java.util.AbstractSequentialList

iterator

Methods inherited from class java.util.AbstractList

equals, hashCode, listIterator, subList

Methods inherited from class java.util.AbstractCollection

containsAll, isEmpty, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

addAll, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, size, subList, toArray, toArray

Methods inherited from interface java.util.Deque

iterator

Constructor Detail

LinkedListModel

public LinkedListModel()

Constructs an empty LinkedListModel.

LinkedListModel

public LinkedListModel(Collection<? extends E> c)

Constructs a LinkedListModel containing the elements of the specifie collection, in the order they are returned by the collection' iterator.

Parameters:

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

Throws:

NullPointerException - if c is null

Method Detail

add

public final void add(int index,
                      E element)

Specified by:

add in interface List<E>

Overrides:

add in class LinkedList<E>

add

public final boolean add(E e)

Specified by:

add in interface Collection<E>

Specified by:

add in interface Deque<E>

Specified by:

add in interface List<E>

Specified by:

add in interface Queue<E>

Overrides:

add in class LinkedList<E>

addAll

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

Specified by:

addAll in interface List<E>

Overrides:

addAll in class LinkedList<E>

removeAll

public boolean removeAll(Collection<?> c)

Removes from this collection all of its elements that are contained i the specified collection (optional operation).

remove method.

UnsupportedOperationException if the iterator returned by th iterator method does not implement the remove metho and this collection contains one or more elements in common with th specified collection.

Specified by:

removeAll in interface Collection<E>

Specified by:

removeAll in interface List<E>

Overrides:

removeAll in class AbstractCollection<E>

Parameters:

c - elements to be removed from this collection.

Returns:

true if this collection changed as a result of th call.

Throws:

UnsupportedOperationException - if the removeAll metho is not supported by this collection.

NullPointerException - if the specified collection is null.

See Also:

remove(Object), LinkedList.contains(Object)

retainAll

public boolean retainAll(Collection<?> c)

Retains only the elements in this collection that are contained in th specified collection (optional operation). In other words, remove from this collection all of its elements that are not contained in th specified collection.

remove method.

UnsupportedOperationException if the iterator returned by th iterator method does not implement the remove metho and this collection contains one or more elements not present in th specified collection.

Specified by:

retainAll in interface Collection<E>

Specified by:

retainAll in interface List<E>

Overrides:

retainAll in class AbstractCollection<E>

Parameters:

c - elements to be retained in this collection.

Returns:

true if this collection changed as a result of th call.

Throws:

UnsupportedOperationException - if the retainAll metho is not supported by this Collection.

NullPointerException - if the specified collection is null.

See Also:

remove(Object), LinkedList.contains(Object)

addFirst

public final void addFirst(E e)

Specified by:

addFirst in interface Deque<E>

Overrides:

addFirst in class LinkedList<E>

addLast

public final void addLast(E e)

Specified by:

addLast in interface Deque<E>

Overrides:

addLast in class LinkedList<E>

clear

public final void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class LinkedList<E>

remove

public final E remove(int index)

Specified by:

remove in interface List<E>

Overrides:

remove in class LinkedList<E>

remove

public final boolean remove(Object o)

Specified by:

remove in interface Collection<E>

Specified by:

remove in interface Deque<E>

Specified by:

remove in interface List<E>

Overrides:

remove in class LinkedList<E>

removeFirst

public final E removeFirst()

Specified by:

removeFirst in interface Deque<E>

Overrides:

removeFirst in class LinkedList<E>

removeLast

public final E removeLast()

Specified by:

removeLast in interface Deque<E>

Overrides:

removeLast in class LinkedList<E>

removeRange

protected final void removeRange(int fromIndex,
                                 int toIndex)

Overrides:

removeRange in class AbstractList<E>

set

public final E set(int index,
                   E element)

Specified by:

set in interface List<E>

Overrides:

set in class LinkedList<E>

listIterator

public final ListIterator<E> listIterator(int index)

Specified by:

listIterator in interface List<E>

Overrides:

listIterator in class LinkedList<E>

addListDataListener

public final void addListDataListener(ListDataListener l)

Specified by:

addListDataListener in interface ListModel

removeListDataListener

public final void removeListDataListener(ListDataListener l)

Specified by:

removeListDataListener in interface ListModel

getElementAt

public final E getElementAt(int index)

Specified by:

getElementAt in interface ListModel

getSize

public final int getSize()

Specified by:

getSize in interface ListModel

fireContentsChanged

public final void fireContentsChanged(int index)

Notifies all registered ListDataListeners that the elemen at the specified index has changed. Useful if there's a content chang without any structural change.

after the element of the list changes.

Parameters:

index - the index of the element that has changed

See Also:

EventListenerList

getListDataListeners

public final ListDataListener[] getListDataListeners()

Returns an array of all the list data listener registered on this LinkedListModel.

Returns:

all of this model's ListDataListeners or an empty array if no list data listener are currently registered

See Also:

addListDataListener(ListDataListener), removeListDataListener(ListDataListener)