java.lang.Object
- org.djutils.event.EventProducer
- - org.djutils.event.util.EventProducingSet<E>

Type Parameters:

E - the type of elements in the set

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, EventListener, Set<E>, EventListenerInterface, EventProducerInterface
```
public class EventProducingSet<E>
extends EventProducer
implements EventListenerInterface, Set<E>
```
The Event producing set provides a set 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-2021 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:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static EventType`	`OBJECT_ADDED_EVENT`	OBJECT_ADDED_EVENT is fired on new entries.
`static EventType`	`OBJECT_CHANGED_EVENT`	OBJECT_CHANGED_EVENT is fired on change of one or more entries.
`static EventType`	`OBJECT_REMOVED_EVENT`	OBJECT_REMOVED_EVENT is fired on removal of entries.

Fields inherited from class org.djutils.event.EventProducer
eventProducerImpl

Fields inherited from interface org.djutils.event.EventProducerInterface
FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors
Constructor	Description
`EventProducingSet(Set<E> parent, Serializable sourceId)`	Constructs a new EventProducingSet.
`EventProducingSet(Set<E> parent, IdProvider sourceIdProvider)`	Constructs a new EventProducingSet.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`add(E o)`
`boolean`	`addAll(Collection<? extends E> c)`
`void`	`clear()`
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`Serializable`	`getSourceId()`	Provide the sourceId that will be transmitted with the fired Event.
`boolean`	`isEmpty()`
`EventProducingIterator<E>`	`iterator()`
`void`	`notify(EventInterface event)`	Notifies the event listener of an event.
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`int`	`size()`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`

Methods inherited from class org.djutils.event.EventProducer
addListener, addListener, addListener, addListener, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireTimedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, fireUnverifiedTimedEvent, 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.lang.Iterable
forEach

Methods inherited from interface java.util.Set
equals, hashCode, spliterator

- Field Detail
  - OBJECT_ADDED_EVENT
```
public static final EventType OBJECT_ADDED_EVENT
```
    OBJECT_ADDED_EVENT is fired on new entries.
  - OBJECT_REMOVED_EVENT
```
public static final EventType OBJECT_REMOVED_EVENT
```
    OBJECT_REMOVED_EVENT is fired on removal of entries.
  - OBJECT_CHANGED_EVENT
```
public static final EventType OBJECT_CHANGED_EVENT
```
    OBJECT_CHANGED_EVENT is fired on change of one or more entries.
- Constructor Detail
  - EventProducingSet
```
public EventProducingSet(Set<E> parent,
                         Serializable sourceId)
```
    Constructs a new EventProducingSet.
    
    Parameters:
    
    parent - Set<E>; the parent set.
    
    sourceId - Serializable; the id by which the EventProducer can be identified by the EventListener
  - EventProducingSet
```
public EventProducingSet(Set<E> parent,
                         IdProvider sourceIdProvider)
```
    Constructs a new EventProducingSet.
    
    Parameters:
    
    parent - Set<E>; the parent set.
    
    sourceIdProvider - IdProvider; the function that produces the id by which the EventProducer can be identified by the EventListener
- Method Detail
  - getSourceId
```
public Serializable getSourceId()
```
    Provide the sourceId that will be transmitted with the fired Event.
    
    Specified by:
    
    getSourceId in interface EventProducerInterface
    
    Specified by:
    
    getSourceId in class EventProducer
    
    Returns:
    
    Serializable; the sourceId that will be transmitted with the fired Event
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<E>
    
    Specified by:
    
    size in interface Set<E>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<E>
    
    Specified by:
    
    isEmpty in interface Set<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<E>
    
    Specified by:
    
    clear in interface Set<E>
  - add
```
public boolean add(E o)
```
    Specified by:
    
    add in interface Collection<E>
    
    Specified by:
    
    add in interface Set<E>
  - addAll
```
public boolean addAll(Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface Collection<E>
    
    Specified by:
    
    addAll in interface Set<E>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<E>
    
    Specified by:
    
    contains in interface Set<E>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<E>
    
    Specified by:
    
    containsAll in interface Set<E>
  - iterator
```
public EventProducingIterator<E> iterator()
```
    Specified by:
    
    iterator in interface Collection<E>
    
    Specified by:
    
    iterator in interface Iterable<E>
    
    Specified by:
    
    iterator in interface Set<E>
  - notify
```
public void notify(EventInterface event)
            throws RemoteException
```
    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 interface EventListenerInterface
    
    Parameters:
    
    event - EventInterface; the event which is sent to the listener
    
    Throws:
    
    RemoteException - If a network connection failure occurs.
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<E>
    
    Specified by:
    
    remove in interface Set<E>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<E>
    
    Specified by:
    
    removeAll in interface Set<E>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<E>
    
    Specified by:
    
    retainAll in interface Set<E>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface Set<E>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<E>
    
    Specified by:
    
    toArray in interface Set<E>

Class EventProducingSet<E>

Field Summary

Fields inherited from class org.djutils.event.EventProducer

Fields inherited from interface org.djutils.event.EventProducerInterface

Constructor Summary

Method Summary

Methods inherited from class org.djutils.event.EventProducer

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Set

Field Detail

OBJECT_ADDED_EVENT

OBJECT_REMOVED_EVENT

OBJECT_CHANGED_EVENT

Constructor Detail

EventProducingSet

EventProducingSet

Method Detail

getSourceId

size

isEmpty

clear

add

addAll

contains

containsAll

iterator

notify

remove

removeAll

retainAll

toArray

toArray