Class ForwardingConcurrentMap<K,V>

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingMap<K,V>

com.google.common.collect.ForwardingConcurrentMap<K,V>

All Implemented Interfaces:

ConcurrentMap<K,V>, Map<K,V>

@GwtCompatible
public abstract class ForwardingConcurrentMap<K,V>
extends ForwardingMap<K,V>
implements ConcurrentMap<K,V>

A concurrent map which forwards all its method calls to another concurrent map. Subclasses should override one or more methods to modify the behavior of the backing map as desired per the decorator pattern.

default method warning: This class forwards calls to only some default methods. Specifically, it forwards calls only for methods that existed before default methods were introduced. For newer methods, like forEach, it inherits their default implementations. When those implementations invoke methods, they invoke methods on the ForwardingConcurrentMap.

Since:

2.0

Author:

Charles Fry

Nested Class Summary

Nested classes/interfaces inherited from class ForwardingMap

ForwardingMap.StandardEntrySet, ForwardingMap.StandardKeySet, ForwardingMap.StandardValues

Modifier and Type	Class	Description
protected class	ForwardingMap.StandardEntrySet	A sensible implementation of Map.entrySet() in terms of the following methods: ForwardingMap.clear(), ForwardingMap.containsKey(Object), ForwardingMap.get(Object), ForwardingMap.isEmpty(), ForwardingMap.remove(Object), and ForwardingMap.size().
protected class	ForwardingMap.StandardKeySet	A sensible implementation of Map.keySet() in terms of the following methods: ForwardingMap.clear(), ForwardingMap.containsKey(Object), ForwardingMap.isEmpty(), ForwardingMap.remove(Object), ForwardingMap.size(), and the Set.iterator() method of ForwardingMap.entrySet().
protected class	ForwardingMap.StandardValues	A sensible implementation of Map.values() in terms of the following methods: ForwardingMap.clear(), ForwardingMap.containsValue(Object), ForwardingMap.isEmpty(), ForwardingMap.size(), and the Set.iterator() method of ForwardingMap.entrySet().

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ForwardingConcurrentMap()	Constructor for use by subclasses.

Method Summary

Modifier and Type	Method	Description
protected abstract ConcurrentMap<K,V>	delegate()	Returns the backing delegate instance that methods are forwarded to.
@Nullable V	putIfAbsent(K key, V value)
boolean	remove(@Nullable Object key, @Nullable Object value)
@Nullable V	replace(K key, V value)
boolean	replace(K key, V oldValue, V newValue)

Methods inherited from class ForwardingMap

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, standardClear, standardContainsKey, standardContainsValue, standardEquals, standardHashCode, standardIsEmpty, standardPutAll, standardRemove, standardToString, values

Modifier and Type	Method	Description
void	clear()
boolean	containsKey(@Nullable Object key)
boolean	containsValue(@Nullable Object value)
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(@Nullable Object object)
V	get(@Nullable Object key)
int	hashCode()
boolean	isEmpty()
Set<K>	keySet()
V	put(K key, V value)
void	putAll(Map<? extends K, ? extends V> map)
V	remove(@Nullable Object key)
int	size()
protected void	standardClear()	A sensible definition of ForwardingMap.clear() in terms of the iterator method of ForwardingMap.entrySet().
protected boolean	standardContainsKey(@Nullable Object key)	A sensible, albeit inefficient, definition of ForwardingMap.containsKey(Object) in terms of the iterator method of ForwardingMap.entrySet().
protected boolean	standardContainsValue(@Nullable Object value)	A sensible definition of ForwardingMap.containsValue(Object) in terms of the iterator method of ForwardingMap.entrySet().
protected boolean	standardEquals(@Nullable Object object)	A sensible definition of ForwardingMap.equals(Object) in terms of the equals method of ForwardingMap.entrySet().
protected int	standardHashCode()	A sensible definition of ForwardingMap.hashCode() in terms of the iterator method of ForwardingMap.entrySet().
protected boolean	standardIsEmpty()	A sensible definition of ForwardingMap.isEmpty() in terms of the iterator method of ForwardingMap.entrySet().
protected void	standardPutAll(Map<? extends K, ? extends V> map)	A sensible definition of ForwardingMap.putAll(Map) in terms of ForwardingMap.put(Object, Object).
protected V	standardRemove(@Nullable Object key)	A sensible, albeit inefficient, definition of ForwardingMap.remove(Object) in terms of the iterator method of ForwardingMap.entrySet().
protected String	standardToString()	A sensible definition of ForwardingObject.toString() in terms of the iterator method of ForwardingMap.entrySet().
Collection<V>	values()

Methods inherited from class ForwardingObject

toString

Modifier and Type	Method	Description
String	toString()	Returns the string representation generated by the delegate's toString method.

Methods inherited from class Object

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

Methods inherited from interface ConcurrentMap

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, replaceAll

Constructor Details

ForwardingConcurrentMap

protected ForwardingConcurrentMap()

Constructor for use by subclasses.

Method Details

delegate

protected abstract ConcurrentMap<K,V> delegate()

Description copied from class: ForwardingObject

Returns the backing delegate instance that methods are forwarded to. Abstract subclasses generally override this method with an abstract method that has a more specific return type, such as ForwardingSet.delegate(). Concrete subclasses override this method to supply the instance being decorated.

Specified by:

delegate in class ForwardingMap<K,V>

putIfAbsent

@CanIgnoreReturnValue
public @Nullable V putIfAbsent(K key,
 V value)

Specified by:

putIfAbsent in interface ConcurrentMap<K,V>

Specified by:

putIfAbsent in interface Map<K,V>

remove

@CanIgnoreReturnValue
public boolean remove(@Nullable Object key,
 @Nullable Object value)

Specified by:

remove in interface ConcurrentMap<K,V>

Specified by:

remove in interface Map<K,V>

replace

@CanIgnoreReturnValue
public @Nullable V replace(K key,
 V value)

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>

replace

@CanIgnoreReturnValue
public boolean replace(K key,
 V oldValue,
 V newValue)

Specified by:

replace in interface ConcurrentMap<K,V>

Specified by:

replace in interface Map<K,V>