EventProducingIterator (Delft Java Utilities Basic Classes 2.2.0 API)

java.lang.Object
- org.djutils.event.LocalEventProducer
- - org.djutils.event.collection.EventProducingIterator<T>

Type Parameters:

T - the type of elements to iterate on

All Implemented Interfaces:

Serializable, Remote, Iterator<T>, EventProducer

Direct Known Subclasses:

EventProducingListIterator
```
public class EventProducingIterator<T>
extends LocalEventProducer
implements Iterator<T>, Serializable
```
The EventProducingIterator provides an iterator embedding the Iterator, which fires an event when an object has been removed. Note that one does not have to subscribe specifically to the events of the EventProducingIterator, as the EventProducing collection subscribes to the EventProducingIterator's remove events and fires these again to its subscribers.
Copyright (c) 2002-2023 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_REMOVED_EVENT
OBJECT_REMOVED_EVENT is fired on removal of entries.
- Fields inherited from interface org.djutils.event.EventProducer
  FIRST_POSITION, LAST_POSITION

Constructor Summary

Constructors
Constructor Description

EventProducingIterator(Iterator<T> wrappedIterator)
constructs a new EventProducingIterator, embedding the parent Iterator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected Iterator<T>`	`getWrappedIterator()`	Return the embedded iterator.
`boolean`	`hasNext()`
`T`	`next()`
`void`	`remove()`

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.Iterator
forEachRemaining

- Field Detail
  - OBJECT_REMOVED_EVENT
```
public static final EventType OBJECT_REMOVED_EVENT
```
    OBJECT_REMOVED_EVENT is fired on removal of entries.
- Constructor Detail
  - EventProducingIterator
```
public EventProducingIterator(Iterator<T> wrappedIterator)
```
    constructs a new EventProducingIterator, embedding the parent Iterator.
    
    Parameters:
    
    wrappedIterator - Iterator<T>; parent.
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T>
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T>
  - getWrappedIterator
```
protected Iterator<T> getWrappedIterator()
```
    Return the embedded iterator.
    
    Returns:
    
    parent Iterator<T>; the embedded iterator