Package org.djutils.immutablecollections

Class ImmutableLinkedHashMap<K,V>

java.lang.Object

org.djutils.immutablecollections.ImmutableAbstractMap<K,V>

org.djutils.immutablecollections.ImmutableLinkedHashMap<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>

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

An immutable wrapper for a LinkedHashMap.

Copyright (c) 2016-2021 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.

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.djutils.immutablecollections.ImmutableMap

ImmutableMap.ImmutableEntry<K,V>

Field Summary

Fields inherited from class org.djutils.immutablecollections.ImmutableAbstractMap

cachedValues, copyOrWrap

Constructor Summary

Constructors

Constructor	Description
ImmutableLinkedHashMap(Map<K,V> map)
ImmutableLinkedHashMap(Map<K,V> map, Immutable copyOrWrap)
ImmutableLinkedHashMap(ImmutableAbstractMap<K,V> immutableMap)
ImmutableLinkedHashMap(ImmutableAbstractMap<K,V> immutableMap, Immutable copyOrWrap)

Method Summary

Modifier and Type	Method	Description
ImmutableSet<ImmutableMap.ImmutableEntry<K,V>>	entrySet()	Returns a Set view of the entries contained in this map.
protected Map<K,V>	getUnderlyingMap()	Return the raw underlying map.
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 map.
String	toString()	Force to redefine toString.
ImmutableCollection<V>	values()	Returns a ImmutableCollection view of the values contained in this map.

Methods inherited from class org.djutils.immutablecollections.ImmutableAbstractMap

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djutils.immutablecollections.ImmutableMap

forEach, getOrDefault, isCopy

Constructor Detail

ImmutableLinkedHashMap

public ImmutableLinkedHashMap(Map<K,V> map)

Parameters:

map - Map<K,V>; the map to use for the immutable map.

ImmutableLinkedHashMap

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

Parameters:

map - Map<K,V>; the map to use for the immutable map.

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

ImmutableLinkedHashMap

public ImmutableLinkedHashMap(ImmutableAbstractMap<K,V> immutableMap)

Parameters:

immutableMap - ImmutableAbstractMap<K,V>; the map to use for the immutable map.

ImmutableLinkedHashMap

public ImmutableLinkedHashMap(ImmutableAbstractMap<K,V> immutableMap,
                              Immutable copyOrWrap)

Parameters:

immutableMap - ImmutableAbstractMap<K,V>; the map to use for the immutable map.

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

Method Detail

getUnderlyingMap

protected final Map<K,V> getUnderlyingMap()

Return the raw underlying map.

Overrides:

getUnderlyingMap in class ImmutableAbstractMap<K,V>

Returns:

Map<K, V>; the raw underlying map

toMap

public final Map<K,V> toMap()

Returns a modifiable copy of this immutable map.

Returns:

a modifiable copy of this immutable map.

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

entrySet

public ImmutableSet<ImmutableMap.ImmutableEntry<K,V>> entrySet()

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

Returns:

an immutable set of the entries contained in this map

values

public ImmutableCollection<V> values()

Returns a ImmutableCollection view of the values contained in this map.

Specified by:

values in interface ImmutableMap<K,V>

Overrides:

values in class ImmutableAbstractMap<K,V>

Returns:

an immutable collection view of the values contained in this map

toString

public final String toString()

Force to redefine toString.

Specified by:

toString in interface ImmutableMap<K,V>

Overrides:

toString in class Object

Returns:

String; a description of this immutable map