Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
ca.odell.glazedlists.AbstractEventList<E>
EventList
s.
If you are creating a custom EventList
, consider extending the more
feature-rich TransformedList
.
Documentation Note: Javadoc tags have been copied from the List
API
because the javadoc
tool does not inherit external descriptions.
Field Summary | |
protected ListEventPublisher |
|
protected ReadWriteLock |
|
protected ListEventAssembler |
|
Constructor Summary | |
| |
|
Method Summary | |
|
|
boolean |
|
void |
|
boolean |
|
boolean |
|
void |
|
void |
|
boolean |
|
boolean |
|
boolean |
|
abstract E |
|
ListEventPublisher | |
ReadWriteLock | |
int |
|
int |
|
boolean |
|
Iterator |
|
int |
|
ListIterator |
|
ListIterator |
|
boolean |
|
E |
|
boolean |
|
void |
|
boolean |
|
E |
|
abstract int |
|
List |
|
Object[] |
|
String |
|
protected ReadWriteLock readWriteLock
the read/write lock provides mutual exclusion to access
protected ListEventAssemblerupdates
the change event and notification system
protected AbstractEventList()
Create anAbstractEventList
that sends events with the defaultListEventPublisher
.
protected AbstractEventList(ListEventPublisher publisher)
Creates anAbstractEventList
that sends events using the specifiedListEventPublisher
.
- Parameters:
publisher
- the channel for event distribution. If this is null, then a newListEventPublisher
will be created.
publicT[] toArray(T[] 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. Obeys the general contract of the Collection.toArray(Object[]) method.
- 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.
public boolean add(E value)
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.
- Parameters:
value
- element to be appended to this list.
- Returns:
- true (as per the general contract of the Collection.add method).
public void add(int index, E value)
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).
- Parameters:
index
- index at which the specified element is to be inserted.value
- element to be inserted.
public boolean addAll(E> values)
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.)
- Parameters:
values
- collection whose elements are to be added to this list.
- Returns:
- true if this list changed as a result of the call.
- See Also:
add(Object)
public boolean addAll(int index, E> values)
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.)
- Parameters:
index
- index at which to insert first element from the specified collection.values
- elements to be inserted into this list.
- Returns:
- true if this list changed as a result of the call.
public void addListEventListener(E> listChangeListener)
- Specified by:
- addListEventListener in interface EventList<E>
public void clear()
Removes all of the elements from this list (optional operation). This list will be empty after this call returns (unless it throws an exception).
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)).
- Parameters:
object
- element whose presence in this list is to be tested.
- Returns:
- true if this list contains the specified element.
public boolean containsAll(Collection> values)
Returns true if this list contains all of the elements of the specified collection.
- Parameters:
values
- 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)
public boolean equals(Object object)
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. (Two elements e1 and e2 are equal if (e1==null ? e2==null : e1.equals(e2)).) In other words, two lists are defined to be equal if they contain the same elements in the same order. This definition ensures that the equals method works properly across different implementations of the List interface.
- Parameters:
object
- the object to be compared for equality with this list.
- Returns:
- true if the specified object is equal to this list.
public abstract E get(int index)
Returns the element at the specified position in this list.
- Parameters:
index
- index of element to return.
- Returns:
- the element at the specified position in this list.
public ListEventPublisher getPublisher()
- Specified by:
- getPublisher in interface EventList<E>
public ReadWriteLock getReadWriteLock()
- Specified by:
- getReadWriteLock in interface EventList<E>
public int hashCode()
Returns the hash code value for this list. The hash code of a list is defined to be the result of the following calculation:hashCode = 1; Iterator i = list.iterator(); while (i.hasNext()) { Object obj = i.next(); hashCode = 31*hashCode + (obj==null ? 0 : obj.hashCode()); }This ensures that list1.equals(list2) implies that list1.hashCode()==list2.hashCode() for any two lists, list1 and list2, as required by the general contract of Object.hashCode.
- Returns:
- the hash code value for this list.
- See Also:
Object.hashCode()
,Object.equals(Object)
,equals(Object)
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.
- 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.
public boolean isEmpty()
Returns true if this list contains no elements.
- Returns:
- true if this list contains no elements.
public Iteratoriterator()
Returns an iterator over the elements in this list in proper sequence. The returnedIterator
will become inconsistent if theEventList
that it views is modified. To overcome this problem, uselistIterator()
. When used concurrently, the returnedIterator
requires locking via this list'sReadWriteLock
.
- Returns:
- an iterator over the elements in this list in proper sequence.
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.
- 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.
public ListIteratorlistIterator()
Returns a list iterator of the elements in this list (in proper sequence). Unlike theListIterator
from a regularList
, theEventList
'sListIterator
will remain consistent even if theEventList
is changed externally. Note that when used concurrently, the returnedListIterator
requires locking via this list'sReadWriteLock
.
- Returns:
- a list iterator of the elements in this list (in proper sequence).
public ListIteratorlistIterator(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. Unlike theListIterator
from a regularList
, theEventList
'sListIterator
will remain consistent even if theEventList
is changed externally. Note that when used concurrently, the returnedListIterator
requires locking via this list'sReadWriteLock
.
- 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.
public boolean remove(Object toRemove)
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).
- Parameters:
toRemove
- element to be removed from this list, if present.
- Returns:
- true if this list contained the specified element.
public E 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.
- Parameters:
index
- the index of the element to removed.
- Returns:
- the element previously at the specified position.
public boolean removeAll(Collection> values)
Removes from this list all the elements that are contained in the specified collection (optional operation).
- Parameters:
values
- collection that defines which elements will be removed from this list.
- Returns:
- true if this list changed as a result of the call.
- See Also:
remove(Object)
,contains(Object)
public void removeListEventListener(E> listChangeListener)
- Specified by:
- removeListEventListener in interface EventList<E>
public boolean retainAll(Collection> values)
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.
- Parameters:
values
- collection that defines which elements this set will retain.
- Returns:
- true if this list changed as a result of the call.
- See Also:
remove(Object)
,contains(Object)
public E set(int index, E value)
Replaces the element at the specified position in this list with the specified element (optional operation).
- Parameters:
index
- index of element to replace.value
- element to be stored at the specified position.
- Returns:
- the element previously at the specified position.
public abstract int size()
Returns the number of elements in this list. If this list contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
- Returns:
- the number of elements in this list.
public ListsubList(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.) Unlike the standardList.subList()
method, theList
returned by this method will continue to be consistent even if theEventList
it views is modified, structurally or otherwise. The returnedList
can always be safely cast toEventList
. Note that when used concurrently, the returnedList
requires locking via this list'sReadWriteLock
. 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.
- 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.
public 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.
- Returns:
- an array containing all of the elements in this list in proper sequence.
- See Also:
Arrays.asList
public String toString()
Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String.valueOf(Object). This implementation creates an empty string buffer, appends a left square bracket, and iterates over the collection appending the string representation of each element in turn. After appending each element except the last, the string ", " is appended. Finally a right bracket is appended. A string is obtained from the string buffer, and returned.
- Returns:
- a string representation of this collection.