org.enhydra.barracuda.core.comp
Class DefaultListModel

java.lang.Object
  |
  +--org.enhydra.barracuda.core.comp.AbstractListModel
        |
        +--org.enhydra.barracuda.core.comp.DefaultListModel
All Implemented Interfaces:
java.util.Collection, Contextual, java.util.List, ListModel, Model

public class DefaultListModel
extends AbstractListModel
implements java.util.List

This class provides a default implementation for List Model. This implementation is backed by a java.util.ArrayList.


Field Summary
protected  java.util.List items
           
protected static org.apache.log4j.Logger logger
           
 
Fields inherited from class org.enhydra.barracuda.core.comp.AbstractListModel
listeners, viewContext
 
Constructor Summary
DefaultListModel()
           
 
Method Summary
 void add(int index, java.lang.Object element)
          Inserts the specified element at the specified position in this list (optional operation).
 boolean add(java.lang.Object o)
          Appends the specified element to the end of this list (optional operation).
 boolean addAll(java.util.Collection 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 (optional operation).
 boolean addAll(int index, java.util.Collection c)
          Inserts all of the elements in the specified collection into this list at the specified position (optional operation).
 void clear()
          Removes all of the elements from this list
 boolean contains(java.lang.Object o)
          Returns true if this list contains the specified element.
 boolean containsAll(java.util.Collection c)
          Returns true if this list contains all of the elements of the specified collection.
 boolean equals(java.lang.Object o)
          Compares the specified object with this list for equality.
 java.lang.Object get(int index)
          Returns the element at the specified position in this list.
 java.lang.Object getItemAt(int index)
          Get an element at a specific index
 int getSize()
          Get the size of the list
 int hashCode()
          Returns the hash code value for this list.
 int indexOf(java.lang.Object o)
          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.
 java.util.Iterator iterator()
          Returns an iterator over the elements in this list in proper sequence.
 int lastIndexOf(java.lang.Object o)
          Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.
 java.util.ListIterator listIterator()
          Returns a list iterator of the elements in this list (in proper sequence).
 java.util.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.
 java.lang.Object remove(int index)
          Removes the element at the specified position in this list (optional operation).
 boolean remove(java.lang.Object o)
          Removes the first occurrence in this list of the specified element (optional operation).
 boolean removeAll(java.util.Collection c)
          Removes from this list all the elements that are contained in the specified collection (optional operation).
 boolean retainAll(java.util.Collection c)
          Retains only the elements in this list that are contained in the specified collection (optional operation).
 java.lang.Object set(int index, java.lang.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.
 java.util.List subList(int fromIndex, int toIndex)
          Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive.
 java.lang.Object[] toArray()
          Returns an array containing all of the elements in this list in proper sequence.
 java.lang.Object[] toArray(java.lang.Object[] a)
          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.
 java.lang.String toString()
          Create a string representation of the list and return it.
 
Methods inherited from class org.enhydra.barracuda.core.comp.AbstractListModel
addModelListener, fireModelChanged, getViewContext, removeModelListener, resetModel, setViewContext
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

logger

protected static org.apache.log4j.Logger logger

items

protected java.util.List items
Constructor Detail

DefaultListModel

public DefaultListModel()
Method Detail

getItemAt

public java.lang.Object getItemAt(int index)
Get an element at a specific index

Specified by:
getItemAt in interface ListModel
Parameters:
index - the target index
Returns:
the element at the specific index

getSize

public int getSize()
Get the size of the list

Specified by:
getSize in interface ListModel
Returns:
the size of the list
See Also:
List.size()

size

public int size()
Returns the number of elements in this list.

Specified by:
size in interface java.util.List
Returns:
the number of elements in this list.
See Also:
List.size()

isEmpty

public boolean isEmpty()
Returns true if this list contains no elements.

Specified by:
isEmpty in interface java.util.List
Returns:
true if this list contains no elements.
See Also:
List.isEmpty()

contains

public boolean contains(java.lang.Object o)
Returns true if this list contains the specified element.

Specified by:
contains in interface java.util.List
Parameters:
o - element whose presence in this list is to be tested.
Returns:
true if this list contains the specified element.
See Also:
List.contains(Object)

iterator

public java.util.Iterator iterator()
Returns an iterator over the elements in this list in proper sequence.

Specified by:
iterator in interface java.util.List
Returns:
an iterator over the elements in this list in proper sequence.
See Also:
List.iterator()

toArray

public java.lang.Object[] toArray()
Returns an array containing all of the elements in this list in proper sequence. Obeys the general contract of the Collection.toArray method.

Specified by:
toArray in interface java.util.List
Returns:
an array containing all of the elements in this list in proper sequence.
See Also:
List.toArray()

toArray

public java.lang.Object[] toArray(java.lang.Object[] a)
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 java.util.List
Parameters:
a - 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:
java.lang.ArrayStoreException - if the runtime type of the specified array is not a supertype of the runtime type of every element in this list.
See Also:
List.toArray(Object[])

add

public boolean add(java.lang.Object o)
Appends the specified element to the end of this list (optional operation).

Specified by:
add in interface java.util.List
Parameters:
o - element to be appended to this list.
Returns:
true (as per the general contract of the Collection.add method).
Throws:
java.lang.UnsupportedOperationException - if the add method is not supported by this list.
java.lang.ClassCastException - if the class of the specified element prevents it from being added to this list.
java.lang.IllegalArgumentException - if some aspect of this element prevents it from being added to this collection.
See Also:
List.add(Object)

remove

public boolean remove(java.lang.Object o)
Removes the first occurrence in this list of the specified element (optional operation). If this list does not contain the element, it is unchanged.

Specified by:
remove in interface java.util.List
Parameters:
o - element to be removed from this list, if present.
Returns:
true if this list contained the specified element.
Throws:
java.lang.UnsupportedOperationException - if the remove method is not supported by this list.
See Also:
List.remove(Object)

containsAll

public boolean containsAll(java.util.Collection c)
Returns true if this list contains all of the elements of the specified collection.

Specified by:
containsAll in interface java.util.List
Parameters:
c - 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:
List.containsAll(Collection)

addAll

public boolean addAll(java.util.Collection 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 (optional operation).

Specified by:
addAll in interface java.util.List
Parameters:
c - collection whose elements are to be added to this list.
Returns:
true if this list changed as a result of the call.
Throws:
java.lang.UnsupportedOperationException - if the addAll method is not supported by this list.
java.lang.ClassCastException - if the class of an element in the specified collection prevents it from being added to this list.
java.lang.IllegalArgumentException - if some aspect of an element in the specified collection prevents it from being added to this list.
See Also:
List.addAll(Collection)

addAll

public boolean addAll(int index,
                      java.util.Collection c)
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).

Specified by:
addAll in interface java.util.List
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.
Throws:
java.lang.UnsupportedOperationException - if the addAll method is not supported by this list.
java.lang.ClassCastException - if the class of one of elements of the specified collection prevents it from being added to this list.
java.lang.IllegalArgumentException - if some aspect of one of elements of the specified collection prevents it from being added to this list.
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).
See Also:
List.addAll(int,Collection)

removeAll

public boolean removeAll(java.util.Collection c)
Removes from this list all the elements that are contained in the specified collection (optional operation).

Specified by:
removeAll in interface java.util.List
Parameters:
c - collection that defines which elements will be removed from this list.
Returns:
true if this list changed as a result of the call.
Throws:
java.lang.UnsupportedOperationException - if the removeAll method is not supported by this list.
See Also:
List.removeAll(Collection)

retainAll

public boolean retainAll(java.util.Collection c)
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.

Specified by:
retainAll in interface java.util.List
Parameters:
c - collection that defines which elements this set will retain.
Returns:
true if this list changed as a result of the call.
Throws:
java.lang.UnsupportedOperationException - if the retainAll method is not supported by this list.
See Also:
List.retainAll(Collection)

clear

public void clear()
Removes all of the elements from this list

Specified by:
clear in interface java.util.List
Throws:
java.lang.UnsupportedOperationException - if the clear method is not supported by this list.
See Also:
List.clear()

equals

public boolean equals(java.lang.Object o)
Compares the specified object with this list for equality. Returns true if and only if the specified object is also a list, both lists have the same size, and all corresponding pairs of elements in the two lists are equal.

Specified by:
equals in interface java.util.List
Overrides:
equals in class java.lang.Object
Parameters:
o - the object to be compared for equality with this list.
Returns:
true if the specified object is equal to this list.
See Also:
List.equals(Object)

hashCode

public int hashCode()
Returns the hash code value for this list.

Specified by:
hashCode in interface java.util.List
Overrides:
hashCode in class java.lang.Object
Returns:
the hash code value for this list.
See Also:
List.hashCode()

get

public java.lang.Object get(int index)
Returns the element at the specified position in this list.

Specified by:
get in interface java.util.List
Parameters:
index - index of element to return.
Returns:
the element at the specified position in this list.
Throws:
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).
See Also:
List.get(int)

set

public java.lang.Object set(int index,
                            java.lang.Object element)
Replaces the element at the specified position in this list with the specified element (optional operation).

Specified by:
set in interface java.util.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:
java.lang.UnsupportedOperationException - if the set method is not supported by this list.
java.lang.ClassCastException - if the class of the specified element prevents it from being added to this list.
java.lang.IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list.
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).
See Also:
List.set(int,Object)

add

public void add(int index,
                java.lang.Object element)
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 java.util.List
Parameters:
index - index at which the specified element is to be inserted.
element - element to be inserted.
Throws:
java.lang.UnsupportedOperationException - if the add method is not supported by this list.
java.lang.ClassCastException - if the class of the specified element prevents it from being added to this list.
java.lang.IllegalArgumentException - if some aspect of the specified element prevents it from being added to this list.
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).
See Also:
List.add(int,Object)

remove

public java.lang.Object remove(int index)
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 java.util.List
Parameters:
index - the index of the element to removed.
Returns:
the element previously at the specified position.
Throws:
java.lang.UnsupportedOperationException - if the remove method is not supported by this list.
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).
See Also:
List.remove(int)

indexOf

public int indexOf(java.lang.Object o)
Returns the index in this list of the first occurrence of the specified element, or -1 if this list does not contain this element.

Specified by:
indexOf in interface java.util.List
Parameters:
o - 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.
See Also:
List.indexOf(Object)

lastIndexOf

public int lastIndexOf(java.lang.Object o)
Returns the index in this list of the last occurrence of the specified element, or -1 if this list does not contain this element.

Specified by:
lastIndexOf in interface java.util.List
Parameters:
o - 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.
See Also:
List.lastIndexOf(Object)

listIterator

public java.util.ListIterator listIterator()
Returns a list iterator of the elements in this list (in proper sequence).

Specified by:
listIterator in interface java.util.List
Returns:
a list iterator of the elements in this list (in proper sequence).
See Also:
List.listIterator()

listIterator

public java.util.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.

Specified by:
listIterator in interface java.util.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.
Throws:
java.lang.IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size()).
See Also:
List.listIterator(int)

subList

public java.util.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.

Specified by:
subList in interface java.util.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.
Throws:
java.lang.IndexOutOfBoundsException - for an illegal endpoint index value (fromIndex < 0 || toIndex > size || fromIndex > toIndex).
See Also:
List.subList(int,int)

toString

public java.lang.String toString()
Create a string representation of the list and return it. This method is invoked by the list component when rendering a list into a text based item that does not inherantly support a list structure

Overrides:
toString in class java.lang.Object
Returns:
a string representation of the list


Copyright © 2001 Enhydra.org