java.lang.Object
- org.opentrafficsim.core.perception.AbstractHistorical<K,AbstractHistoricalMap.EventMap<K,V,M>>
- - org.opentrafficsim.core.perception.collections.AbstractHistoricalMap<K,V,M>

Type Parameters:

K - key type

V - value type

M - map type

All Implemented Interfaces:

java.util.Map<K,V>, HistoricalMap<K,V>, HistoryManager.HistoricalElement

Direct Known Subclasses:

AbstractHistoricalSortedMap, HistoricalEnumMap, HistoricalHashMap, HistoricalLinkedHashMap
```
public abstract class AbstractHistoricalMap<K,V,M extends java.util.Map<K,V>>
extends AbstractHistorical<K,AbstractHistoricalMap.EventMap<K,V,M>>
implements HistoricalMap<K,V>
```
Map-valued historical state. The current map is always maintained, and past states of the map are obtained by applying the events between now and the requested time in reverse.

The set views returned by this class are unmodifiable.
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 feb. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AbstractHistoricalMap.EventMap<K,V,M extends java.util.Map<K,V>>`	Abstract super class for events that add or remove a value from the map.

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

Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractHistoricalMap(HistoryManager historyManager, M map)
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clear()`
`boolean`	`containsKey(java.lang.Object key)`
`boolean`	`containsValue(java.lang.Object value)`
`java.util.Set<java.util.Map.Entry<K,V>>`	`entrySet()`
`protected M`	`fill(M map)`	Fill map with the current map.
`protected M`	`fill(Time time, M map)`	Fill map with the map at the given simulation time.
`V`	`get(java.lang.Object key)`
`protected M`	`getMap()`	Returns the internal map.
`boolean`	`isEmpty()`
`java.util.Set<K>`	`keySet()`
`V`	`put(K key, V value)`
`void`	`putAll(java.util.Map<? extends K,? extends V> m)`
`V`	`remove(java.lang.Object key)`
`int`	`size()`
`java.util.Collection<V>`	`values()`

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 org.opentrafficsim.core.perception.collections.HistoricalMap
get, get, replaceAll

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace

- Constructor Detail
  - AbstractHistoricalMap
```
protected AbstractHistoricalMap(HistoryManager historyManager,
                                M map)
```
    Constructor.
    
    Parameters:
    
    historyManager - HistoryManager; history manager
    
    map - M; initial map
- Method Detail
  - getMap
```
protected M getMap()
```
    Returns the internal map.
    
    Returns:
    
    M; internal map
  - fill
```
protected M fill(M map)
```
    Fill map with the current map.
    
    Parameters:
    
    map - M; map to fill
    
    Returns:
    
    M; input map filled
  - fill
```
protected M fill(Time time,
                 M map)
```
    Fill map with the map at the given simulation time.
    
    Parameters:
    
    time - Time; time
    
    map - M; map to fill
    
    Returns:
    
    M; input map filled
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface java.util.Map<K,V>
  - put
```
public V put(K key,
             V value)
```
    Specified by:
    
    put in interface java.util.Map<K,V>
  - putAll
```
public void putAll(java.util.Map<? extends K,? extends V> m)
```
    Specified by:
    
    putAll in interface java.util.Map<K,V>
  - remove
```
public V remove(java.lang.Object key)
```
    Specified by:
    
    remove in interface java.util.Map<K,V>
  - size
```
public int size()
```
    Specified by:
    
    size in interface java.util.Map<K,V>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface java.util.Map<K,V>
  - containsKey
```
public boolean containsKey(java.lang.Object key)
```
    Specified by:
    
    containsKey in interface java.util.Map<K,V>
  - containsValue
```
public boolean containsValue(java.lang.Object value)
```
    Specified by:
    
    containsValue in interface java.util.Map<K,V>
  - get
```
public V get(java.lang.Object key)
```
    Specified by:
    
    get in interface java.util.Map<K,V>
  - keySet
```
public java.util.Set<K> keySet()
```
    Specified by:
    
    keySet in interface java.util.Map<K,V>
  - values
```
public java.util.Collection<V> values()
```
    Specified by:
    
    values in interface java.util.Map<K,V>
  - entrySet
```
public java.util.Set<java.util.Map.Entry<K,V>> entrySet()
```
    Specified by:
    
    entrySet in interface java.util.Map<K,V>

Class AbstractHistoricalMap<K,​V,​M extends java.util.Map<K,​V>>

Nested Class Summary

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

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

Constructor Detail

AbstractHistoricalMap

Method Detail

getMap

fill

fill

clear

put

putAll

remove

size

isEmpty

containsKey

containsValue

get

keySet

values

entrySet

Class AbstractHistoricalMap<K,V,M extends java.util.Map<K,V>>