Package org.djutils.event.collection
Class EventProducingList<E>
java.lang.Object
org.djutils.event.LocalEventProducer
org.djutils.event.collection.EventProducingList<E>
- Type Parameters:
E
- the type of elements in the list
- All Implemented Interfaces:
Serializable
,Iterable<E>
,Remote
,Collection<E>
,EventListener
,List<E>
,EventListener
,EventProducer
The Event producing list provides a list to which one can subscribe interest in entry changes. This class does not keep track
of changes which take place indirectly. One is for example not notified on
map.iterator.remove()
. A listener
must subscribe to the iterator individually.
Copyright (c) 2002-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djutils.org. The DJUTILS project is distributed under a three-clause BSD-style license, which can be found at https://djutils.org/docs/license.html. This class was originally part of the DSOL project, see https://simulation.tudelft.nl/dsol/manual.
- Author:
- Peter Jacobs , Alexander Verbraeck
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final EventType
OBJECT_ADDED_EVENT is fired on new entries.static final EventType
OBJECT_CHANGED_EVENT is fired on change of one or more entries.static final EventType
OBJECT_REMOVED_EVENT is fired on removal of entries.Fields inherited from interface org.djutils.event.EventProducer
FIRST_POSITION, LAST_POSITION
-
Constructor Summary
ConstructorDescriptionEventProducingList
(List<E> wrappedList) constructs a new EventProducingList. -
Method Summary
Modifier and TypeMethodDescriptionvoid
boolean
boolean
addAll
(int index, Collection<? extends E> c) boolean
addAll
(Collection<? extends E> c) void
clear()
boolean
boolean
containsAll
(Collection<?> c) get
(int index) int
boolean
isEmpty()
iterator()
int
listIterator
(int index) void
Notifies the event listener of an event.remove
(int index) boolean
boolean
removeAll
(Collection<?> c) boolean
retainAll
(Collection<?> c) int
size()
subList
(int fromIndex, int toIndex) Object[]
toArray()
<T> T[]
toArray
(T[] a) Methods inherited from class org.djutils.event.LocalEventProducer
addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, getEventListenerMap, getEventTypesWithListeners, getListenerReferences, hasListeners, numberOfListeners, removeAllListeners, removeAllListeners, removeListener
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArray
Methods inherited from interface java.util.List
equals, hashCode, replaceAll, sort, spliterator
-
Field Details
-
OBJECT_ADDED_EVENT
OBJECT_ADDED_EVENT is fired on new entries. -
OBJECT_REMOVED_EVENT
OBJECT_REMOVED_EVENT is fired on removal of entries. -
OBJECT_CHANGED_EVENT
OBJECT_CHANGED_EVENT is fired on change of one or more entries.
-
-
Constructor Details
-
EventProducingList
constructs a new EventProducingList.- Parameters:
wrappedList
- List<E>; the embedded list.
-
-
Method Details
-
size
public int size() -
isEmpty
public boolean isEmpty() -
clear
public void clear() -
add
-
add
-
addAll
-
addAll
-
contains
-
containsAll
- Specified by:
containsAll
in interfaceCollection<E>
- Specified by:
containsAll
in interfaceList<E>
-
get
-
indexOf
-
iterator
-
listIterator
- Specified by:
listIterator
in interfaceList<E>
-
listIterator
- Specified by:
listIterator
in interfaceList<E>
-
notify
Description copied from interface:EventListener
Notifies the event listener of an event. This operation forms the callback method of the asynchronous communication protocol expressed in the event package.- Specified by:
notify
in interfaceEventListener
- Parameters:
event
- Event; the event which is sent to the listener- Throws:
RemoteException
- If a network connection failure occurs.
-
lastIndexOf
- Specified by:
lastIndexOf
in interfaceList<E>
-
remove
-
remove
-
removeAll
-
retainAll
-
set
-
subList
-
toArray
-
toArray
public <T> T[] toArray(T[] a)
-