com.jgoodies.common.collect

Class ArrayListModel<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<E>

com.jgoodies.common.collect.ArrayListModel<E>

Type Parameters:

E - the type of the list elements

All Implemented Interfaces:

ObservableList<E>, ObservableList2<E>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<E>, java.util.Collection<E>, java.util.List<E>, java.util.RandomAccess, javax.swing.ListModel

public final class ArrayListModel<E>
extends java.util.ArrayList<E>
implements ObservableList2<E>

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

See Also:

ObservableList, LinkedListModel, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private javax.swing.event.EventListenerList	listenerList Holds the registered ListDataListeners.
private static long	serialVersionUID

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	add(E e)
void	add(int index, E element)
boolean	addAll(java.util.Collection<? extends E> c)
boolean	addAll(int index, java.util.Collection<? extends E> c)
void	addListDataListener(javax.swing.event.ListDataListener l)
void	clear()
void	fireContentsChanged(int index) Notifies all registered ListDataListeners that the element at the specified index has changed.
void	fireContentsChanged(int index0, int index1) Notifies all registered ListDataListeners that the element at the specified index has changed.
private void	fireIntervalAdded(int index0, int index1) This method must be called after one or more elements are added to the model.
private void	fireIntervalRemoved(int index0, int index1) This method must be called after one or more elements are removed from the model.
java.lang.Object	getElementAt(int index)
private javax.swing.event.EventListenerList	getEventListenerList() Lazily initializes and returns the event listener list used to notify registered listeners.
javax.swing.event.ListDataListener[]	getListDataListeners() Returns an array of all the list data listeners registered on this ArrayListModel.
int	getSize()
E	remove(int index)
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> c) Removes from this collection all of its elements that are contained in the specified collection (optional operation).
void	removeListDataListener(javax.swing.event.ListDataListener l)
protected void	removeRange(int fromIndex, int toIndex)
boolean	retainAll(java.util.Collection<?> c) Retains only the elements in this collection that are contained in the specified collection (optional operation).
E	set(int index, E element)

Methods inherited from class java.util.ArrayList

clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, removeIf, replaceAll, size, sort, spliterator, 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.List

contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, replaceAll, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

listenerList

private javax.swing.event.EventListenerList listenerList

Holds the registered ListDataListeners. The list that holds these listeners is initialized lazily in #getEventListenerList.

See Also:

addListDataListener(ListDataListener), removeListDataListener(ListDataListener)

Constructor Detail

ArrayListModel

public ArrayListModel()

Constructs an empty list with an initial capacity of ten.

ArrayListModel

public ArrayListModel(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

ArrayListModel

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

Constructs a list containing the elements of the specified collection, in the order they are returned by the collection's iterator. The ArrayListModel instance has an initial capacity of 110% the size of the specified collection.

Parameters:

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

Throws:

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

Method Detail

add

public final void add(int index,
                      E element)

Specified by:

add in interface java.util.List<E>

Overrides:

add in class java.util.ArrayList<E>

add

public final boolean add(E e)

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>

addAll

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

Specified by:

addAll in interface java.util.List<E>

Overrides:

addAll in class java.util.ArrayList<E>

addAll

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

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>

removeAll

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

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

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>

Parameters:

c - elements to be removed from this collection.

Returns:

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

Throws:

java.lang.UnsupportedOperationException - if the removeAll method is not supported by this collection.

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

See Also:

remove(Object), ArrayList.contains(Object)

retainAll

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

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

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>

Parameters:

c - elements to be retained in this collection.

Returns:

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

Throws:

java.lang.UnsupportedOperationException - if the retainAll method is not supported by this Collection.

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

See Also:

remove(Object), ArrayList.contains(Object)

clear

public final void clear()

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 final E remove(int index)

Specified by:

remove in interface java.util.List<E>

Overrides:

remove in class java.util.ArrayList<E>

remove

public final boolean remove(java.lang.Object o)

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>

removeRange

protected final void removeRange(int fromIndex,
                                 int toIndex)

Overrides:

removeRange in class java.util.ArrayList<E>

set

public final E set(int index,
                   E element)

Specified by:

set in interface java.util.List<E>

Overrides:

set in class java.util.ArrayList<E>

addListDataListener

public final void addListDataListener(javax.swing.event.ListDataListener l)

Specified by:

addListDataListener in interface javax.swing.ListModel

removeListDataListener

public final void removeListDataListener(javax.swing.event.ListDataListener l)

Specified by:

removeListDataListener in interface javax.swing.ListModel

getElementAt

public final java.lang.Object getElementAt(int index)

Specified by:

getElementAt in interface javax.swing.ListModel

getSize

public final int getSize()

Specified by:

getSize in interface javax.swing.ListModel

fireContentsChanged

public final void fireContentsChanged(int index)

Description copied from interface: ObservableList2

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

This method must be called after the element of the list changes.

Specified by:

fireContentsChanged in interface ObservableList2<E>

Parameters:

index - the index of the element that has changed

See Also:

EventListenerList

fireContentsChanged

public final void fireContentsChanged(int index0,
                                      int index1)

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

This method must be called after one or more elements of the list change. The changed elements are specified by the closed interval index0, index1 -- the end points are included. Note that index0 need not be less than or equal to index1.

Specified by:

fireContentsChanged in interface ObservableList2<E>

Parameters:

index0 - one end of the new interval

index1 - the other end of the new interval

Since:

1.7

See Also:

EventListenerList

getListDataListeners

public final javax.swing.event.ListDataListener[] getListDataListeners()

Returns an array of all the list data listeners registered on this ArrayListModel.

Returns:

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

See Also:

addListDataListener(ListDataListener), removeListDataListener(ListDataListener)

fireIntervalAdded

private void fireIntervalAdded(int index0,
                               int index1)

This method must be called after one or more elements are added to the model. The new elements are specified by a closed interval index0, index1 -- the end points are included. Note that index0 need not be less than or equal to index1.

Parameters:

index0 - one end of the new interval

index1 - the other end of the new interval

See Also:

EventListenerList

fireIntervalRemoved

private void fireIntervalRemoved(int index0,
                                 int index1)

This method must be called after one or more elements are removed from the model. index0 and index1 are the end points of the interval that's been removed. Note that index0 need not be less than or equal to index1.

Parameters:

index0 - one end of the removed interval, including index0

index1 - the other end of the removed interval, including index1

See Also:

EventListenerList

getEventListenerList

private javax.swing.event.EventListenerList getEventListenerList()

Lazily initializes and returns the event listener list used to notify registered listeners.

Returns:

the event listener list used to notify listeners