Package com.google.common.reflect

Class MutableTypeToInstanceMap<B>

java.lang.Object

com.google.common.collect.ForwardingObject

com.google.common.collect.ForwardingMap<TypeToken<? extends B>,B>

com.google.common.reflect.MutableTypeToInstanceMap<B>

All Implemented Interfaces:

TypeToInstanceMap<B>, Map<TypeToken<? extends B>,B>

@Beta
public final class MutableTypeToInstanceMap<B>
extends ForwardingMap<TypeToken<? extends B>,B>
implements TypeToInstanceMap<B>

A mutable type-to-instance map. See also ImmutableTypeToInstanceMap.

Since:

13.0

Author:

Ben Yu

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
MutableTypeToInstanceMap()

Method Summary

Modifier and Type	Method	Description
protected Map<TypeToken<? extends B>,B>	delegate()	Returns the backing delegate instance that methods are forwarded to.
Set<Map.Entry<TypeToken<? extends B>,B>>	entrySet()	Returns a Set view of the mappings contained in this map.
<T extends B> T	getInstance(TypeToken<T> type)	Returns the value the specified type is mapped to, or null if no entry for this type is present.
<T extends B> T	getInstance(Class<T> type)	Returns the value the specified class is mapped to, or null if no entry for this class is present.
B	put(TypeToken<? extends B> key, B value)	Deprecated. unsupported operation
void	putAll(Map<? extends TypeToken<? extends B>,? extends B> map)	Deprecated. unsupported operation
<T extends B> T	putInstance(TypeToken<T> type, T value)	Maps the specified type to the specified value.
<T extends B> T	putInstance(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

Constructor Detail

MutableTypeToInstanceMap

public MutableTypeToInstanceMap()

Method Detail

getInstance

@NullableDecl
public <T extends B> T getInstance(Class<T> type)

Description copied from interface: TypeToInstanceMap

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.

getInstance(Foo.class) is equivalent to getInstance(TypeToken.of(Foo.class)).

Specified by:

getInstance in interface TypeToInstanceMap<B>

getInstance

@NullableDecl
public <T extends B> T getInstance(TypeToken<T> type)

Description copied from interface: TypeToInstanceMap

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

Specified by:

getInstance in interface TypeToInstanceMap<B>

putInstance

@CanIgnoreReturnValue
@NullableDecl
public <T extends B> T putInstance(Class<T> type,
                                   @NullableDecl
                                   T value)

Description copied from interface: TypeToInstanceMap

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

putInstance(Foo.class, foo) is equivalent to putInstance(TypeToken.of(Foo.class), foo).

Specified by:

putInstance in interface TypeToInstanceMap<B>

Returns:

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

putInstance

@CanIgnoreReturnValue
@NullableDecl
public <T extends B> T putInstance(TypeToken<T> type,
                                   @NullableDecl
                                   T value)

Description copied from interface: TypeToInstanceMap

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

Specified by:

putInstance in interface TypeToInstanceMap<B>

Returns:

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

put

@CanIgnoreReturnValue
@Deprecated
public B put(TypeToken<? extends B> key,
             B value)

Deprecated.

unsupported operation

Not supported. Use putInstance(java.lang.Class<T>, T) instead.

Specified by:

put in interface Map<TypeToken<? extends B>,B>

Overrides:

put in class ForwardingMap<TypeToken<? extends B>,B>

Parameters:

key - key with which the specified value is to be associated

value - value to be associated with the specified key

Returns:

the previous value associated with key, or null if there was no mapping for key. (A null return can also indicate that the map previously associated null with key, if the implementation supports null values.)

Throws:

UnsupportedOperationException - always

putAll

@Deprecated
public void putAll(Map<? extends TypeToken<? extends B>,? extends B> map)

Deprecated.

unsupported operation

Not supported. Use putInstance(java.lang.Class<T>, T) instead.

Specified by:

putAll in interface Map<TypeToken<? extends B>,B>

Overrides:

putAll in class ForwardingMap<TypeToken<? extends B>,B>

Parameters:

map - mappings to be stored in this map

Throws:

UnsupportedOperationException - always

entrySet

public Set<Map.Entry<TypeToken<? extends B>,B>> entrySet()

Description copied from interface: java.util.Map

Returns a Set view of the mappings contained in this map. The set is backed by the map, so changes to the map are reflected in the set, and vice-versa. If the map is modified while an iteration over the set is in progress (except through the iterator's own remove operation, or through the setValue operation on a map entry returned by the iterator) the results of the iteration are undefined. The set supports element removal, which removes the corresponding mapping from the map, via the Iterator.remove, Set.remove, removeAll, retainAll and clear operations. It does not support the add or addAll operations.

Specified by:

entrySet in interface Map<TypeToken<? extends B>,B>

Overrides:

entrySet in class ForwardingMap<TypeToken<? extends B>,B>

Returns:

a set view of the mappings contained in this map

delegate

protected Map<TypeToken<? 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<TypeToken<? extends B>,B>