com.alee.utils.map

Class ImmutableMap<K,V>

java.lang.Object

com.alee.utils.map.ImmutableMap<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

Serializable, Cloneable, Map<K,V>

public class ImmutableMap<K,V>
extends Object
implements Map<K,V>, Cloneable, Serializable

Map implementation that doesn't allow any data modifications to be done. Unlike Collections.unmodifiableMap(Map) this implementation keeps map data copy. If you need to provide an unmodifiable reference for your map use Collections implementations or write your own.

Author:

Mikle Garin

See Also:

Serialized Form

Nested Class Summary

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

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<K,V>	data Map data.

Constructor Summary

Constructors

Constructor and Description
ImmutableMap(Map<K,V> map) Constructs new ImmutableMap based on the provided map.
ImmutableMap(Object... data) Constructs new ImmutableMap based on the provided data.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
protected UnsupportedOperationException	createModificationException() Returns new UnsupportedOperationException instance specific for this implementation.
Set<Map.Entry<K,V>>	entrySet()
V	get(Object key)
boolean	isEmpty()
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> m)
V	remove(Object key)
int	size()
Collection<V>	values()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

data

protected final HashMap<K,V> data

Map data.

Constructor Detail

ImmutableMap

public ImmutableMap(Object... data)

Constructs new ImmutableMap based on the provided data.

Parameters:

data - mixed keys and values

ImmutableMap

public ImmutableMap(Map<K,V> map)

Constructs new ImmutableMap based on the provided map.

Parameters:

map - data Map

Method Detail

size

public int size()

Specified by:

size in interface Map<K,V>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

put

public V put(K key,
             V value)

Specified by:

put in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

putAll

public void putAll(Map<? extends K,? extends V> m)

Specified by:

putAll in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

createModificationException

protected UnsupportedOperationException createModificationException()

Returns new UnsupportedOperationException instance specific for this implementation.

Returns:

new UnsupportedOperationException instance specific for this implementation