com.jgoodies.binding.list

Class LinkedListModel

Implemented Interfaces:
List, ListModel, ObservableList

public final class LinkedListModel
extends LinkedList
implements ObservableList

Adds javax.swing.ListModel capabilities to its superclass LinkedList, i. e. allows to observe changes in the content and structure. Useful for lists that are bound to list views, for example JList, JComboBox and JTable.
Version:
$Revision: 1.4 $
Author:
Karsten Lentzsch
See Also:
ArrayListModel, java.util.ListIterator

Constructor Summary

LinkedListModel()
Constructs an empty linked list.
LinkedListModel(Collection c)
Constructs a linked list containing the elements of the specified collection, in the order they are returned by the collection's iterator.

Method Summary

boolean
add(Object o)
Appends the specified element to the end of this list.
void
add(int index, Object element)
Inserts the specified element at the specified position in this list.
boolean
addAll(int index, Collection c)
Inserts all of the elements in the specified Collection into this list, starting at the specified position.
void
addFirst(Object o)
Inserts the given element at the beginning of this list.
void
addLast(Object o)
Appends the given element to the end of this list.
void
addListDataListener(ListDataListener l)
Adds a listener to the list that's notified each time a change to the data model occurs.
void
clear()
Removes all of the elements from this list.
void
fireContentsChanged(int index)
Notifies all registered ListDataListeners that the element at the specified index has changed.
Object
getElementAt(int index)
Returns the value at the specified index.
ListDataListener[]
getListDataListeners()
Returns an array of all the list data listeners registered on this LinkedListModel.
int
getSize()
Returns the length of the list or 0 if there's no list.
ListIterator
listIterator(int index)
Returns a list-iterator of the elements in this list (in proper sequence), starting at the specified position in the list.
boolean
remove(Object o)
Removes a single instance of the specified element from this collection, if it is present (optional operation).
Object
remove(int index)
Removes the element at the specified position in this list.
Object
removeFirst()
Removes and returns the first element from this list.
Object
removeLast()
Removes and returns the last element from this list.
void
removeListDataListener(ListDataListener l)
Removes a listener from the list that's notified each time a change to the data model occurs.
protected void
removeRange(int fromIndex, int toIndex)
Removes from this List all of the elements whose index is between fromIndex, inclusive and toIndex, exclusive.
Object
set(int index, Object element)
Replaces the element at the specified position in this list with the specified element.

Constructor Details

LinkedListModel

public LinkedListModel()
Constructs an empty linked list.

LinkedListModel

public LinkedListModel(Collection c)
Constructs a linked list containing the elements of the specified collection, in the order they are returned by the collection's iterator.
Parameters:
c - the collection whose elements are to be placed into this list.

Method Details

add

public boolean add(Object o)
Appends the specified element to the end of this list.
Parameters:
o - element to be appended to this list.
Returns:
true (as per the general contract of Collection.add).

add

public void add(int index,
                Object element)
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).
Parameters:
index - index at which the specified element is to be inserted.
element - element to be inserted.

addAll

public boolean addAll(int index,
                      Collection 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.
Parameters:
index - index at which to insert first element from the specified collection.
c - elements to be inserted into this list.
Returns:
true if this list changed as a result of the call.

addFirst

public void addFirst(Object o)
Inserts the given element at the beginning of this list.
Parameters:
o - the element to be inserted at the beginning of this list.

addLast

public void addLast(Object o)
Appends the given element to the end of this list. (Identical in function to the add method; included only for consistency.)
Parameters:
o - the element to be inserted at the end of this list.

addListDataListener

public void addListDataListener(ListDataListener l)
Adds a listener to the list that's notified each time a change to the data model occurs.
Parameters:
l - the ListDataListener to be added

clear

public void clear()
Removes all of the elements from this list. The list will be empty after this call returns.

fireContentsChanged

public void fireContentsChanged(int index)
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.

Parameters:
index - the index of the element that has changed
See Also:
EventListenerList

getElementAt

public Object getElementAt(int index)
Returns the value at the specified index.
Parameters:
index - the requested index
Returns:
the value at index

getListDataListeners

public ListDataListener[] getListDataListeners()
Returns an array of all the list data listeners registered on this LinkedListModel.
Returns:
all of this model's ListDataListeners, or an empty array if no list data listeners are currently registered

getSize

public int getSize()
Returns the length of the list or 0 if there's no list.
Returns:
the length of the list or 0 if there's no list

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 the list. Obeys the general contract of List.listIterator(int).

The list-iterator is fail-fast: if the list is structurally modified at any time after the Iterator is created, in any way except through the list-iterator's own remove or add methods, the list-iterator will throw a ConcurrentModificationException. Thus, in the face of concurrent modification, the iterator fails quickly and cleanly, rather than risking arbitrary, non-deterministic behavior at an undetermined time in the future.

Parameters:
index - index of first element to be returned from the list-iterator (by a call to next).
Returns:
a ListIterator of the elements in this list (in proper sequence), starting at the specified position in the list.
See Also:
java.util.List.listIterator(int)

remove

public boolean remove(Object o)
Removes a single instance of the specified element from this collection, if it is present (optional operation). More formally, removes an element e such that (o==null ? e==null : o.equals(e)), if the collection contains one or more such elements. Returns true if the collection contained the specified element (or equivalently, if the collection changed as a result of the call).

This implementation iterates over the collection looking for the specified element. If it finds the element, it removes the element from the collection using the iterator's remove method.

Note that this implementation throws an UnsupportedOperationException if the iterator returned by this collection's iterator method does not implement the remove method and this collection contains the specified object.

Parameters:
o - element to be removed from this collection, if present.
Returns:
true if the collection contained the specified element.

remove

public Object 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).
Parameters:
index - the index of the element to removed.
Returns:
the element that was removed from the list.

removeFirst

public Object removeFirst()
Removes and returns the first element from this list.
Returns:
the first element from this list.

removeLast

public Object removeLast()
Removes and returns the last element from this list.
Returns:
the last element from this list.

removeListDataListener

public void removeListDataListener(ListDataListener l)
Removes a listener from the list that's notified each time a change to the data model occurs.
Parameters:
l - the ListDataListener to be removed

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 list by (toIndex - fromIndex) elements. (If toIndex==fromIndex, this operation has no effect.)
Parameters:
fromIndex - index of first element to be removed.
toIndex - index after last element to be removed.

set

public Object set(int index,
                  Object element)
Replaces the element at the specified position in this list with the specified element.
Parameters:
index - index of element to replace.
element - element to be stored at the specified position.
Returns:
the element previously at the specified position.

Copyright © 2002-2007 JGoodies Karsten Lentzsch. All Rights Reserved.