public abstract class AbstractEventList<E> extends Object implements EventList<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.
Modifier and Type | Field and Description |
---|---|
protected ListEventPublisher |
publisher
the publisher manages the distribution of changes
|
protected ReadWriteLock |
readWriteLock
the read/write lock provides mutual exclusion to access
|
protected ListEventAssembler<E> |
updates
the change event and notification system
|
Modifier | Constructor and Description |
---|---|
protected |
AbstractEventList()
Create an
AbstractEventList that sends events with the default
ListEventPublisher . |
protected |
AbstractEventList(ListEventPublisher publisher)
Creates an
AbstractEventList that sends events using the specified
ListEventPublisher . |
Modifier and Type | Method and Description |
---|---|
boolean |
add(E value)
Appends the specified element to the end of this list (optional operation).
|
void |
add(int index,
E value)
Inserts the specified element at the specified position in this list (optional operation).
|
boolean |
addAll(Collection<? extends 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).
|
boolean |
addAll(int index,
Collection<? extends E> values)
Inserts all of the elements in the specified collection into this list at the specified
position (optional operation).
|
void |
addListEventListener(ListEventListener<? super E> listChangeListener)
Registers the specified listener to receive change updates for this list.
|
void |
clear()
Removes all of the elements from this list (optional operation).
|
boolean |
contains(Object object)
Returns
true if this list contains the specified element. |
boolean |
containsAll(Collection<?> values)
Returns
true if this list contains all of the elements of the specified collection. |
boolean |
equals(Object object)
Compares the specified object with this list for equality.
|
abstract E |
get(int index)
Returns the element at the specified position in this list.
|
ListEventPublisher |
getPublisher()
Get the publisher used to distribute
ListEvent s. |
ReadWriteLock |
getReadWriteLock()
Gets the lock required to share this list between multiple threads.
|
int |
hashCode()
Returns the hash code value for this list.
|
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.
|
boolean |
isEmpty()
Returns
true if this list contains no elements. |
Iterator<E> |
iterator()
Returns an iterator over the elements in this list in proper sequence.
|
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.
|
ListIterator<E> |
listIterator()
Returns a list iterator of the elements in this list (in proper sequence).
|
ListIterator<E> |
listIterator(int index)
Returns a list iterator of the elements in this list (in proper sequence), starting at the
specified position in this list.
|
E |
remove(int index)
Removes the element at the specified position in this list (optional operation).
|
boolean |
remove(Object toRemove)
Removes the first occurrence in this list of the specified element (optional operation).
|
boolean |
removeAll(Collection<?> values)
Removes from this list all the elements that are contained in the specified collection
(optional operation).
|
void |
removeListEventListener(ListEventListener<? super E> listChangeListener)
Removes the specified listener from receiving change updates for this list.
|
boolean |
retainAll(Collection<?> values)
Retains only the elements in this list that are contained in the specified collection (optional
operation).
|
E |
set(int index,
E value)
Replaces the element at the specified position in this list with the specified element
(optional operation).
|
abstract int |
size()
Returns the number of elements in this list.
|
List<E> |
subList(int fromIndex,
int toIndex)
Returns a view of the portion of this list between the specified
fromIndex , inclusive,
and toIndex , exclusive. |
Object[] |
toArray()
Returns an array containing all of the elements in this list in proper sequence.
|
<T> T[] |
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.
|
String |
toString()
Returns a string representation of this collection.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
replaceAll, sort, spliterator
parallelStream, removeIf, stream
protected ListEventAssembler<E> updates
protected ReadWriteLock readWriteLock
protected ListEventPublisher publisher
protected AbstractEventList(ListEventPublisher publisher)
AbstractEventList
that sends events using the specified
ListEventPublisher
.publisher
- the channel for event distribution. If this is null
, then a new
ListEventPublisher
will be created.protected AbstractEventList()
AbstractEventList
that sends events with the default
ListEventPublisher
.public ListEventPublisher getPublisher()
ListEvent
s. It's always defined.getPublisher
in interface EventList<E>
ListEvent
s.public ReadWriteLock getReadWriteLock()
getReadWriteLock
in interface EventList<E>
ReadWriteLock
that guarantees thread safe access to this list.public void addListEventListener(ListEventListener<? super E> listChangeListener)
addListEventListener
in interface EventList<E>
listChangeListener
- event listener != nullpublic void removeListEventListener(ListEventListener<? super E> listChangeListener)
removeListEventListener
in interface EventList<E>
listChangeListener
- event listener != nullpublic abstract int size()
Integer.MAX_VALUE
elements, returns Integer.MAX_VALUE
.public boolean isEmpty()
true
if this list contains no elements.public boolean contains(Object object)
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))
.contains
in interface Collection<E>
contains
in interface List<E>
object
- element whose presence in this list is to be tested.true
if this list contains the specified element.ClassCastException
- if the type of the specified element is incompatible with this list
(optional).NullPointerException
- if the specified element is null and this list does not support
null elements (optional).public Iterator<E> iterator()
The returned Iterator
will become inconsistent if the EventList
that it views
is modified. To overcome this problem, use listIterator()
. When used concurrently, the
returned Iterator
requires locking via this list's ReadWriteLock
.
public Object[] toArray()
Collection.toArray
method.toArray
in interface Collection<E>
toArray
in interface List<E>
Arrays.asList(T...)
public <T> T[] toArray(T[] array)
Collection.toArray(Object[])
method.toArray
in interface Collection<E>
toArray
in interface List<E>
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.ArrayStoreException
- if the runtime type of the specified array is not a supertype of
the runtime type of every element in this list.NullPointerException
- if the specified array is null
.public boolean add(E value)
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.
add
in interface Collection<E>
add
in interface List<E>
value
- element to be appended to this list.true
(as per the general contract of the Collection.add
method).UnsupportedOperationException
- if the add
method is not supported by this list.ClassCastException
- if the class of the specified element prevents it from being added
to this list.NullPointerException
- if the specified element is null and this list does not support
null elements.IllegalArgumentException
- if some aspect of this element prevents it from being added to
this list.public boolean remove(Object toRemove)
(o==null ? get(i)==null : o.equals(get(i)))
(if such
an element exists).remove
in interface Collection<E>
remove
in interface List<E>
toRemove
- element to be removed from this list, if present.true
if this list contained the specified element.ClassCastException
- if the type of the specified element is incompatible with this list
(optional).NullPointerException
- if the specified element is null and this list does not support
null elements (optional).UnsupportedOperationException
- if the remove
method is not supported by this
list.public boolean containsAll(Collection<?> values)
true
if this list contains all of the elements of the specified collection.containsAll
in interface Collection<E>
containsAll
in interface List<E>
values
- collection to be checked for containment in this list.true
if this list contains all of the elements of the specified collection.ClassCastException
- if the types of one or more elements in the specified collection are
incompatible with this list (optional).NullPointerException
- if the specified collection contains one or more null elements and
this list does not support null elements (optional).NullPointerException
- if the specified collection is null
.contains(Object)
public boolean addAll(Collection<? extends E> values)
addAll
in interface Collection<E>
addAll
in interface List<E>
values
- collection whose elements are to be added to this list.true
if this list changed as a result of the call.UnsupportedOperationException
- if the addAll
method is not supported by this
list.ClassCastException
- if the class of an element in the specified collection prevents it
from being added to this list.NullPointerException
- if the specified collection contains one or more null elements and
this list does not support null elements, or if the specified collection is
null
.IllegalArgumentException
- if some aspect of an element in the specified collection
prevents it from being added to this list.add(Object)
public boolean addAll(int index, Collection<? extends E> values)
addAll
in interface List<E>
index
- index at which to insert first element from the specified collection.values
- elements to be inserted into this list.true
if this list changed as a result of the call.UnsupportedOperationException
- if the addAll
method is not supported by this
list.ClassCastException
- if the class of one of elements of the specified collection prevents
it from being added to this list.NullPointerException
- if the specified collection contains one or more null elements and
this list does not support null elements, or if the specified collection is
null
.IllegalArgumentException
- if some aspect of one of elements of the specified collection
prevents it from being added to this list.IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >
size()).public boolean removeAll(Collection<?> values)
removeAll
in interface Collection<E>
removeAll
in interface List<E>
values
- collection that defines which elements will be removed from this list.true
if this list changed as a result of the call.UnsupportedOperationException
- if the removeAll
method is not supported by this
list.ClassCastException
- if the types of one or more elements in this list are incompatible
with the specified collection (optional).NullPointerException
- if this list contains one or more null elements and the specified
collection does not support null elements (optional).NullPointerException
- if the specified collection is null
.remove(Object)
,
contains(Object)
public boolean retainAll(Collection<?> values)
retainAll
in interface Collection<E>
retainAll
in interface List<E>
values
- collection that defines which elements this set will retain.true
if this list changed as a result of the call.UnsupportedOperationException
- if the retainAll
method is not supported by this
list.ClassCastException
- if the types of one or more elements in this list are incompatible
with the specified collection (optional).NullPointerException
- if this list contains one or more null elements and the specified
collection does not support null elements (optional).NullPointerException
- if the specified collection is null
.remove(Object)
,
contains(Object)
public void clear()
clear
in interface Collection<E>
clear
in interface List<E>
UnsupportedOperationException
- if the clear
method is not supported by this
list.public boolean equals(Object object)
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.public int hashCode()
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
.hashCode
in interface Collection<E>
hashCode
in interface List<E>
hashCode
in class Object
Object.hashCode()
,
Object.equals(Object)
,
equals(Object)
public abstract E get(int index)
get
in interface List<E>
index
- index of element to return.IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >=
size()).public E set(int index, E value)
set
in interface List<E>
index
- index of element to replace.value
- element to be stored at the specified position.UnsupportedOperationException
- if the set
method is not supported by this list.ClassCastException
- if the class of the specified element prevents it from being added
to this list.NullPointerException
- if the specified element is null and this list does not support
null elements.IllegalArgumentException
- if some aspect of the specified element prevents it from being
added to this list.IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >=
size()).public void add(int index, E value)
add
in interface List<E>
index
- index at which the specified element is to be inserted.value
- element to be inserted.UnsupportedOperationException
- if the add
method is not supported by this list.ClassCastException
- if the class of the specified element prevents it from being added
to this list.NullPointerException
- if the specified element is null and this list does not support
null elements.IllegalArgumentException
- if some aspect of the specified element prevents it from being
added to this list.IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >
size()).public E remove(int index)
remove
in interface List<E>
index
- the index of the element to removed.UnsupportedOperationException
- if the remove
method is not supported by this
list.IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >=
size()).public int indexOf(Object object)
i
such
that (o==null ? get(i)==null : o.equals(get(i)))
, or -1 if there is no such index.indexOf
in interface List<E>
object
- element to search for.ClassCastException
- if the type of the specified element is incompatible with this list
(optional).NullPointerException
- if the specified element is null and this list does not support
null elements (optional).public int lastIndexOf(Object object)
i
such
that (o==null ? get(i)==null : o.equals(get(i)))
, or -1 if there is no such index.lastIndexOf
in interface List<E>
object
- element to search for.ClassCastException
- if the type of the specified element is incompatible with this list
(optional).NullPointerException
- if the specified element is null and this list does not support
null elements (optional).public ListIterator<E> listIterator()
Unlike the ListIterator
from a regular List
, the EventList
's
ListIterator
will remain consistent even if the EventList
is changed
externally. Note that when used concurrently, the returned ListIterator
requires
locking via this list's ReadWriteLock
.
listIterator
in interface List<E>
public ListIterator<E> listIterator(int index)
next
method. An initial call to the
previous
method would return the element with the specified index minus one.
Unlike the ListIterator
from a regular List
, the EventList
's
ListIterator
will remain consistent even if the EventList
is changed
externally. Note that when used concurrently, the returned ListIterator
requires
locking via this list's ReadWriteLock
.
listIterator
in interface List<E>
index
- index of first element to be returned from the list iterator (by a call to the
next
method).IndexOutOfBoundsException
- if the index is out of range (index < 0 || index >
size()).public List<E> subList(int fromIndex, int toIndex)
fromIndex
, inclusive,
and toIndex
, exclusive. (If fromIndex
and toIndex
are equal, the
returned list is empty.)
Unlike the standard List.subList()
method, the List
returned by this method will continue to be consistent even if the EventList
it views
is modified, structurally or otherwise. The returned List
can always be safely cast to
EventList
. Note that when used concurrently, the returned List
requires locking
via this list's ReadWriteLock
.
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.subList
in interface List<E>
fromIndex
- low endpoint (inclusive) of the subList.toIndex
- high endpoint (exclusive) of the subList.IndexOutOfBoundsException
- for an illegal endpoint index value (fromIndex < 0 ||
toIndex > size || fromIndex > toIndex).public String toString()
"[]"
). 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.
Copyright © 2024 levigo holding gmbh. All rights reserved.