com.gs.collections.api.multimap

Interface MutableMultimap<K,V>

All Superinterfaces:

Multimap<K,V>

All Known Subinterfaces:

MutableBagMultimap<K,V>, MutableListMultimap<K,V>, MutableSetMultimap<K,V>, MutableSortedBagMultimap<K,V>, MutableSortedSetMultimap<K,V>

public interface MutableMultimap<K,V>
extends Multimap<K,V>

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
void	clear()
MutableCollection<V>	get(K key) Returns a view of all values associated with the given key.
MutableMultimap<K,V>	newEmpty() Creates a new instance of the same implementation type, using the default capacity and growth parameters.
boolean	put(K key, V value)
boolean	putAll(K key, java.lang.Iterable<? extends V> values)
<KK extends K,VV extends V> boolean	putAll(Multimap<KK,VV> multimap)
boolean	putAllPairs(Pair<K,V>... pairs)
boolean	remove(java.lang.Object key, java.lang.Object value)
RichIterable<V>	removeAll(java.lang.Object key)
RichIterable<V>	replaceValues(K key, java.lang.Iterable<? extends V> values)

Methods inherited from interface com.gs.collections.api.multimap.Multimap

containsKey, containsKeyAndValue, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, hashCode, isEmpty, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, size, sizeDistinct, toImmutable, toMap, toMap, toMutable, valuesView

Method Detail

newEmpty

MutableMultimap<K,V> newEmpty()

Description copied from interface: Multimap

Creates a new instance of the same implementation type, using the default capacity and growth parameters.

Specified by:

newEmpty in interface Multimap<K,V>

get

MutableCollection<V> get(K key)

Description copied from interface: Multimap

Returns a view of all values associated with the given key.

If the given key does not exist, an empty RichIterable is returned.

Specified by:

get in interface Multimap<K,V>

Parameters:

key - the key to search for

put

boolean put(K key,
          V value)

remove

boolean remove(java.lang.Object key,
             java.lang.Object value)

putAllPairs

boolean putAllPairs(Pair<K,V>... pairs)

putAll

boolean putAll(K key,
             java.lang.Iterable<? extends V> values)

putAll

<KK extends K,VV extends V> boolean putAll(Multimap<KK,VV> multimap)

replaceValues

RichIterable<V> replaceValues(K key,
                            java.lang.Iterable<? extends V> values)

removeAll

RichIterable<V> removeAll(java.lang.Object key)

clear

void clear()