org.apache.commons.collections4
Interface Put<K,V>

All Known Subinterfaces:

BidiMap<K,V>, BoundedMap<K,V>, IterableMap<K,V>, IterableSortedMap<K,V>, MultiMap<K,V>, OrderedBidiMap<K,V>, OrderedMap<K,V>, SortedBidiMap<K,V>, Trie<K,V>

All Known Implementing Classes:

AbstractBidiMapDecorator, AbstractBitwiseTrie, AbstractDualBidiMap, AbstractHashedMap, AbstractIterableMap, AbstractLinkedMap, AbstractMapDecorator, AbstractOrderedBidiMapDecorator, AbstractOrderedMapDecorator, AbstractReferenceMap, AbstractSortedBidiMapDecorator, AbstractSortedMapDecorator, CaseInsensitiveMap, CompositeMap, DefaultedMap, DualHashBidiMap, DualLinkedHashBidiMap, DualTreeBidiMap, DualTreeBidiMap.ViewMap, FixedSizeMap, FixedSizeSortedMap, Flat3Map, HashedMap, LazyMap, LazySortedMap, LinkedMap, ListOrderedMap, LRUMap, MultiKeyMap, MultiValueMap, PassiveExpiringMap, PatriciaTrie, PredicatedMap, PredicatedSortedMap, ReferenceIdentityMap, ReferenceMap, SingletonMap, StaticBucketMap, TransformedMap, TransformedSortedMap, TransformedSplitMap, TreeBidiMap, UnmodifiableBidiMap, UnmodifiableMap, UnmodifiableOrderedBidiMap, UnmodifiableOrderedMap, UnmodifiableSortedBidiMap, UnmodifiableSortedMap, UnmodifiableTrie

public interface Put<K,V>

The "write" subset of the Map interface.

NOTE: in the original Map interface, Map.put(Object, Object) is known to have the same return type as Map.get(Object), namely V. Put makes no assumptions in this regard (there is no association with, nor even knowledge of, a "reading" interface) and thus defines put(Object, Object) as returning Object.

Since:

4.0

Version:

$Id: Put.java 1482645 2013-05-14 23:52:09Z sebb $

See Also:

Get

clear

void clear()

See Also:

Map.clear()

put

Object put(K key,
           V value)

Note that the return type is Object, rather than V as in the Map interface. See the class Javadoc for further info.

See Also:

Map.put(Object, Object)

putAll

void putAll(Map<? extends K,? extends V> t)

See Also:

Map.putAll(Map)