org.conqat.lib.commons.collections

Class UnmodifiableMap<K,V>

java.lang.Object

org.conqat.lib.commons.collections.UnmodifiableMap<K,V>

All Implemented Interfaces:

java.io.Serializable, java.util.Map<K,V>

Direct Known Subclasses:

UnmodifiableSortedMap

public class UnmodifiableMap<K,V>
extends java.lang.Object
implements java.util.Map<K,V>, java.io.Serializable

This is a wrapper for a Map prohibiting all calls which would modify its contents. As the construction of this class is performed in constant time it is prefered over copying the map (which takes linear time). Using this class is also preferred to using the unmodifiableX() in class Collections as they return the collection base type that does not signal, that the object ist unmodifiable. Using the classes in this package makes unmodifiability more explicit.

All prohibited methods throw an UnsupportedOperationException. The class is nearly the same as the one returned by Collections.unmodifiableMap(Map), but by making it a public class we can make the return value of some methods more explicit.

This map is serializable if the wrapped map is serializable.

See Also:

Serialized Form

Nested Class Summary

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
UnmodifiableMap(java.util.Map<K,V> m) Creates a new unmodifiable map from another map.

Method Summary

Modifier and Type	Method and Description
void	clear() Operation is not supported.
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
UnmodifiableSet<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object obj)
V	get(java.lang.Object key)
int	hashCode()
boolean	isEmpty()
UnmodifiableSet<K>	keySet()
V	put(K arg0, V arg1) Operation is not supported.
void	putAll(java.util.Map<? extends K,? extends V> arg0) Operation is not supported.
V	remove(java.lang.Object arg0) Operation is not supported.
int	size()
java.lang.String	toString() Returns a string representation of this map.
UnmodifiableCollection<V>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

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

Constructor Detail

UnmodifiableMap

public UnmodifiableMap(java.util.Map<K,V> m)

Creates a new unmodifiable map from another map. All modifications to the underlying map will directly be visible in this wrapper.

Method Detail

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<K,V>

size

public int size()

Specified by:

size 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 UnmodifiableSet<K> keySet()

Specified by:

keySet in interface java.util.Map<K,V>

values

public UnmodifiableCollection<V> values()

Specified by:

values in interface java.util.Map<K,V>

entrySet

public UnmodifiableSet<java.util.Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface java.util.Map<K,V>

clear

public void clear()

Operation is not supported.

Specified by:

clear in interface java.util.Map<K,V>

put

public V put(K arg0,
             V arg1)

Operation is not supported.

Specified by:

put in interface java.util.Map<K,V>

putAll

public void putAll(java.util.Map<? extends K,? extends V> arg0)

Operation is not supported.

Specified by:

putAll in interface java.util.Map<K,V>

remove

public V remove(java.lang.Object arg0)

Operation is not supported.

Specified by:

remove in interface java.util.Map<K,V>

toString

public java.lang.String toString()

Returns a string representation of this map.

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Map<K,V>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<K,V>

Overrides:

hashCode in class java.lang.Object