org.opentrafficsim.base.immutablecollections

Class ImmutableHashMap<K,V>

java.lang.Object

org.opentrafficsim.base.immutablecollections.ImmutableAbstractMap<K,V>

org.opentrafficsim.base.immutablecollections.ImmutableHashMap<K,V>

Type Parameters:

K - the key type of content of this Map

V - the value type of content of this Map

All Implemented Interfaces:

Serializable, ImmutableMap<K,V>

Direct Known Subclasses:

ImmutableLinkedHashMap

public class ImmutableHashMap<K,V>
extends ImmutableAbstractMap<K,V>

An immutable wrapper for a HashMap.

Copyright (c) 2013-2016 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version May 7, 2016

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	ImmutableHashMap(ImmutableHashMap<K,V> immutableMap)
	ImmutableHashMap(ImmutableHashMap<K,V> immutableMap, Immutable copyOrWrap)
	ImmutableHashMap(Map<K,V> map)
protected	ImmutableHashMap(Map<K,V> map, boolean copy)
	ImmutableHashMap(Map<K,V> map, Immutable copyOrWrap)

Method Summary

Modifier and Type	Method and Description
protected HashMap<K,V>	getMap() Prepare the map of the right type for use a subclass.
ImmutableSet<K>	keySet() Returns a Set view of the keys contained in this map.
Map<K,V>	toMap() Returns a modifiable copy of this immutable list.
String	toString()

Methods inherited from class org.opentrafficsim.base.immutablecollections.ImmutableAbstractMap

containsKey, containsValue, equals, get, hashCode, isEmpty, isWrap, size, values

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opentrafficsim.base.immutablecollections.ImmutableMap

forEach, getOrDefault, isCopy

Constructor Detail

ImmutableHashMap

public ImmutableHashMap(Map<K,V> map)

Parameters:

map - the map to use as the immutable map.

ImmutableHashMap

public ImmutableHashMap(Map<K,V> map,
                        Immutable copyOrWrap)

Parameters:

map - the map to use as the immutable map.

copyOrWrap - COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection

ImmutableHashMap

protected ImmutableHashMap(Map<K,V> map,
                           boolean copy)

Parameters:

map - the map to use as the immutable map.

copy - boolean; indicates whether the immutable is a copy or a wrap

ImmutableHashMap

public ImmutableHashMap(ImmutableHashMap<K,V> immutableMap)

Parameters:

immutableMap - the map to use as the immutable map.

ImmutableHashMap

public ImmutableHashMap(ImmutableHashMap<K,V> immutableMap,
                        Immutable copyOrWrap)

Parameters:

immutableMap - the map to use as the immutable map.

copyOrWrap - COPY stores a safe, internal copy of the collection; WRAP stores a pointer to the original collection

Method Detail

getMap

protected final HashMap<K,V> getMap()

Prepare the map of the right type for use a subclass. Implement e.g. as follows:

  @Override
 protected HashMap<E> getMap()
 {
     return (HashMap<E>) super.getMap();
 }
 

Overrides:

getMap in class ImmutableAbstractMap<K,V>

Returns:

the map of the right type for use a subclass

toMap

public final Map<K,V> toMap()

Returns a modifiable copy of this immutable list.

Returns:

a modifiable copy of this immutable list.

keySet

public final ImmutableSet<K> keySet()

Returns a Set view of the keys contained in this map.

Returns:

an immutable set of the keys contained in this map

toString

public String toString()

Overrides:

toString in class ImmutableAbstractMap<K,V>