HistoricalMap (Open Traffic Sim core classes 2.00.04 API)

Type Parameters:

K - key type

V - value type

All Superinterfaces:

Map<K,V>

All Known Subinterfaces:

HistoricalNavigableMap<K,V>, HistoricalSortedMap<K,V>

All Known Implementing Classes:

AbstractHistoricalMap, AbstractHistoricalNavigableMap, AbstractHistoricalSortedMap, HistoricalEnumMap, HistoricalHashMap, HistoricalLinkedHashMap, HistoricalTreeMap
```
public interface HistoricalMap<K,V>
extends Map<K,V>
```
Interface for historical maps.
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 3 feb. 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

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

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`Map<K,V>`	`get()`	Retrieve the current, internal map.
`Map<K,V>`	`get(Time time)`	Retrieve a past map.
`default void`	`replaceAll(BiFunction<? super K,? super V,? extends V> function)`

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, size, values

- Method Detail
  - get
```
Map<K,V> get()
```
    Retrieve the current, internal map. TODO document what the caller may do with the result.
    
    Returns:
    
    Map; current map
  - get
```
Map<K,V> get(Time time)
```
    Retrieve a past map.
    
    Parameters:
    
    time - Time; time to obtain the map at
    
    Returns:
    
    Map<K, V>; past map
  - replaceAll
```
default void replaceAll(BiFunction<? super K,? super V,? extends V> function)
```
    Specified by:
    
    replaceAll in interface Map<K,V>