Package com.google.common.collect

Class MutableClassToInstanceMap<B>

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingMap<java.lang.Class<? extends B>,B>

com.google.common.collect.MutableClassToInstanceMap<B>

All Implemented Interfaces:

ClassToInstanceMap<B>, java.io.Serializable, java.util.Map<java.lang.Class<? extends B>,B>

@GwtIncompatible
public final class MutableClassToInstanceMap<B>
extends ForwardingMap<java.lang.Class<? extends B>,B>
implements ClassToInstanceMap<B>, java.io.Serializable

A mutable class-to-instance map backed by an arbitrary user-provided map. See also ImmutableClassToInstanceMap.

See the Guava User Guide article on ClassToInstanceMap.

This implementation does support null values, despite how it is annotated; see discussion at ClassToInstanceMap.

Since:

2.0

Author:

Kevin Bourrillion

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.google.common.collect.ForwardingMap

ForwardingMap.StandardEntrySet, ForwardingMap.StandardKeySet, ForwardingMap.StandardValues

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

java.util.Map.Entry<K extends java.lang.Object,V extends java.lang.Object>

Method Summary

Modifier and Type	Method	Description
static <B> MutableClassToInstanceMap<B>	create()	Returns a new MutableClassToInstanceMap instance backed by a HashMap using the default initial capacity and load factor.
static <B> MutableClassToInstanceMap<B>	create(java.util.Map<java.lang.Class<? extends B>,B> backingMap)	Returns a new MutableClassToInstanceMap instance backed by a given empty backingMap.
protected java.util.Map<java.lang.Class<? extends B>,B>	delegate()	Returns the backing delegate instance that methods are forwarded to.
java.util.Set<java.util.Map.Entry<java.lang.Class<? extends B>,B>>	entrySet()
<T extends B> T	getInstance(java.lang.Class<T> type)	Returns the value the specified class is mapped to, or null if no entry for this class is present.
B	put(java.lang.Class<? extends B> key, B value)
void	putAll(java.util.Map<? extends java.lang.Class<? extends B>,? extends B> map)
<T extends B> T	putInstance(java.lang.Class<T> type, T value)	Maps the specified class to the specified value.

Methods inherited from class com.google.common.collect.ForwardingMap

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

Methods inherited from class com.google.common.collect.ForwardingObject

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Method Detail

create

public static <B> MutableClassToInstanceMap<B> create()

Returns a new MutableClassToInstanceMap instance backed by a HashMap using the default initial capacity and load factor.

create

public static <B> MutableClassToInstanceMap<B> create(java.util.Map<java.lang.Class<? extends B>,B> backingMap)

Returns a new MutableClassToInstanceMap instance backed by a given empty backingMap. The caller surrenders control of the backing map, and thus should not allow any direct references to it to remain accessible.

delegate

protected java.util.Map<java.lang.Class<? extends B>,B> 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<java.lang.Class<? extends B>,B>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.Class<? extends B>,B>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.Class<? extends B>,B>

Overrides:

entrySet in class ForwardingMap<java.lang.Class<? extends B>,B>

put

@CanIgnoreReturnValue
@CheckForNull
public B put(java.lang.Class<? extends B> key,
             B value)

Specified by:

put in interface java.util.Map<java.lang.Class<? extends B>,B>

Overrides:

put in class ForwardingMap<java.lang.Class<? extends B>,B>

putAll

public void putAll(java.util.Map<? extends java.lang.Class<? extends B>,? extends B> map)

Specified by:

putAll in interface java.util.Map<java.lang.Class<? extends B>,B>

Overrides:

putAll in class ForwardingMap<java.lang.Class<? extends B>,B>

putInstance

@CanIgnoreReturnValue
@CheckForNull
public <T extends B> T putInstance(java.lang.Class<T> type,
                                   T value)

Description copied from interface: ClassToInstanceMap

Maps the specified class to the specified value. Does not associate this value with any of the class's supertypes.

Specified by:

putInstance in interface ClassToInstanceMap<B>

Returns:

the value previously associated with this class (possibly null), or null if there was no previous entry.

getInstance

@CheckForNull
public <T extends B> T getInstance(java.lang.Class<T> type)

Description copied from interface: ClassToInstanceMap

Returns the value the specified class is mapped to, or null if no entry for this class is present. This will only return a value that was bound to this specific class, not a value that may have been bound to a subtype.

Specified by:

getInstance in interface ClassToInstanceMap<B>