de.larssh.utils.collection

Class ProxiedMap<K,V>

java.lang.Object

de.larssh.utils.collection.ProxiedMap<K,V>

Type Parameters:

K - the type of keys in this map

V - the type of values in this map

All Implemented Interfaces:

Map<K,V>

public abstract class ProxiedMap<K,V>
extends Object
implements Map<K,V>

An abstract Map implementation pointing to a given map object.

Therefore it allows implementing maps based on invisible map types, such as Collections.unmodifiableMap(Map) or Collections.synchronizedMap(Map).

Nested Class Summary

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ProxiedMap(Map<K,V> map) Creates a new ProxiedMap instance.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	containsKey(Object key)
boolean	containsValue(Object value)
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object object)
V	get(Object key)
protected Map<K,V>	getProxiedForRead() Returns the wrapped map without verifying if modifying it is prohibited.
protected Map<K,V>	getProxiedIfModifiable() Verifies if this object is modifiable and either returns the wrapped map or throws an appropriate exception.
int	hashCode()
boolean	isEmpty()
abstract boolean	isModifiable() Flag specifying if this instance can be modified
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K,? extends V> map)
V	remove(Object key)
int	size()
String	toString()
Collection<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

ProxiedMap

public ProxiedMap(Map<K,V> map)

Creates a new ProxiedMap instance.

Parameters:

map - Wrapped map

Method Detail

clear

public void clear()

Specified by:

clear in interface Map<K,V>

containsKey

public boolean containsKey(@Nullable
                           Object key)

Specified by:

containsKey in interface Map<K,V>

containsValue

public boolean containsValue(@Nullable
                             Object value)

Specified by:

containsValue in interface Map<K,V>

entrySet

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

Specified by:

entrySet in interface Map<K,V>

equals

public boolean equals(@CheckForNull
                      Object object)

Specified by:

equals in interface Map<K,V>

Overrides:

equals in class Object

get

@Nullable
public V get(@Nullable
                       Object key)

Specified by:

get in interface Map<K,V>

getProxiedIfModifiable

protected Map<K,V> getProxiedIfModifiable()

Verifies if this object is modifiable and either returns the wrapped map or throws an appropriate exception.

Returns:

the wrapped map if this object is modifiable

Throws:

UnsupportedOperationException - if this object is unmodifiable

getProxiedForRead

protected Map<K,V> getProxiedForRead()

Returns the wrapped map without verifying if modifying it is prohibited.

Returns:

the wrapped map

hashCode

public int hashCode()

Specified by:

hashCode in interface Map<K,V>

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Map<K,V>

isModifiable

public abstract boolean isModifiable()

Flag specifying if this instance can be modified

Returns:

true if this instance is modifiable, else false

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

put

@Nullable
public V put(@Nullable
                       K key,
                       @Nullable
                       V value)

Specified by:

put in interface Map<K,V>

putAll

public void putAll(@Nullable
                   Map<? extends K,? extends V> map)

Specified by:

putAll in interface Map<K,V>

remove

@Nullable
public V remove(@Nullable
                          Object key)

Specified by:

remove in interface Map<K,V>

size

public int size()

Specified by:

size in interface Map<K,V>

toString

public String toString()

Overrides:

toString in class Object

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>