java.lang.Object
- org.opentrafficsim.core.perception.AbstractHistorical<E,AbstractHistoricalCollection.EventCollection<E,C>>
- - org.opentrafficsim.core.perception.collections.AbstractHistoricalCollection<E,C>

Type Parameters:

E - element type

C - collection type

All Implemented Interfaces:

java.lang.Iterable<E>, java.util.Collection<E>, HistoricalCollection<E>, HistoryManager.HistoricalElement

Direct Known Subclasses:

AbstractHistoricalList, AbstractHistoricalQueue, AbstractHistoricalSortedSet, HistoricalHashSet, HistoricalLinkedHashSet
```
public abstract class AbstractHistoricalCollection<E,C extends java.util.Collection<E>>
extends AbstractHistorical<E,AbstractHistoricalCollection.EventCollection<E,C>>
implements HistoricalCollection<E>
```
Collection-valued historical state. The current collection is always maintained, and past states of the collection are obtained by applying the events between now and the requested time in reverse.

This implementation is suitable for sets, as add and remove events to retrieve historical states are only created if indeed the underlying collection is changed. Set introduces no new methods relative to Collection.

The Iterator returned by this class does not support the remove() method.
Copyright (c) 2013-2020 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version 1 jan. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AbstractHistoricalCollection.AddEvent<E,C extends java.util.Collection<E>>`	Event for adding value to the collection.
`static class`	`AbstractHistoricalCollection.EventCollection<E,C extends java.util.Collection<E>>`	Abstract super class for events that add or remove a value from the collection.
`static class`	`AbstractHistoricalCollection.RemoveEvent<E,C extends java.util.Collection<E>>`	Event for removing value from the collection.

Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.AbstractHistorical
AbstractHistorical.EventValue<T>

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractHistoricalCollection(HistoryManager historyManager, C collection)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`add(E value)`
`boolean`	`addAll(java.util.Collection<? extends E> c)`
`void`	`clear()`
`boolean`	`contains(java.lang.Object o)`
`boolean`	`containsAll(java.util.Collection<?> c)`
`protected C`	`fill(C collection)`	Fill collection with the current collection.
`protected C`	`fill(Time time, C collection)`	Fill collection with the collection at the given simulation time.
`protected C`	`getCollection()`	Returns the internal collection.
`boolean`	`isEmpty()`
`java.util.Iterator<E>`	`iterator()`
`boolean`	`remove(java.lang.Object value)`
`boolean`	`removeAll(java.util.Collection<?> c)`
`boolean`	`retainAll(java.util.Collection<?> c)`
`int`	`size()`
`java.lang.Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`

Methods inherited from class org.opentrafficsim.core.perception.AbstractHistorical
addEvent, cleanUpHistory, getEvent, getEvents, getLastEvent, isLastState, now, removeEvent

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
equals, hashCode, parallelStream, spliterator, stream, toArray

Methods inherited from interface org.opentrafficsim.core.perception.collections.HistoricalCollection
get, get, removeIf

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - AbstractHistoricalCollection
```
protected AbstractHistoricalCollection(HistoryManager historyManager,
                                       C collection)
```
    Constructor.
    
    Parameters:
    
    historyManager - HistoryManager; history manager
    
    collection - C; initial collection
- Method Detail
  - getCollection
```
protected final C getCollection()
```
    Returns the internal collection.
    
    Returns:
    
    C; internal collection
  - fill
```
protected final C fill(C collection)
```
    Fill collection with the current collection.
    
    Parameters:
    
    collection - C; collection to fill
    
    Returns:
    
    C; input collection filled
  - fill
```
protected final C fill(Time time,
                       C collection)
```
    Fill collection with the collection at the given simulation time.
    
    Parameters:
    
    time - Time; time
    
    collection - C; collection to fill
    
    Returns:
    
    C; input collection filled
  - add
```
public boolean add(E value)
```
    Specified by:
    
    add in interface java.util.Collection<E>
  - addAll
```
public boolean addAll(java.util.Collection<? extends E> c)
```
    Specified by:
    
    addAll in interface java.util.Collection<E>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Collection<E>
  - remove
```
public boolean remove(java.lang.Object value)
```
    Specified by:
    
    remove in interface java.util.Collection<E>
  - removeAll
```
public boolean removeAll(java.util.Collection<?> c)
```
    Specified by:
    
    removeAll in interface java.util.Collection<E>
  - retainAll
```
public boolean retainAll(java.util.Collection<?> c)
```
    Specified by:
    
    retainAll in interface java.util.Collection<E>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Collection<E>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Collection<E>
  - contains
```
public boolean contains(java.lang.Object o)
```
    Specified by:
    
    contains in interface java.util.Collection<E>
  - iterator
```
public java.util.Iterator<E> iterator()
```
    Specified by:
    
    iterator in interface java.util.Collection<E>
    
    Specified by:
    
    iterator in interface java.lang.Iterable<E>
  - toArray
```
public java.lang.Object[] toArray()
```
    Specified by:
    
    toArray in interface java.util.Collection<E>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface java.util.Collection<E>
  - containsAll
```
public boolean containsAll(java.util.Collection<?> c)
```
    Specified by:
    
    containsAll in interface java.util.Collection<E>

Class AbstractHistoricalCollection<E,​C extends java.util.Collection<E>>

Nested Class Summary

Nested classes/interfaces inherited from class org.opentrafficsim.core.perception.AbstractHistorical

Constructor Summary

Method Summary

Methods inherited from class org.opentrafficsim.core.perception.AbstractHistorical

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Methods inherited from interface org.opentrafficsim.core.perception.collections.HistoricalCollection

Methods inherited from interface java.lang.Iterable

Constructor Detail

AbstractHistoricalCollection

Method Detail

getCollection

fill

fill

add

addAll

clear

remove

removeAll

retainAll

size

isEmpty

contains

iterator

toArray

toArray

containsAll

Class AbstractHistoricalCollection<E,C extends java.util.Collection<E>>