com.gs.collections.api.multimap.list

Interface MutableListMultimap<K,V>

All Superinterfaces:

ListMultimap<K,V>, Multimap<K,V>, MutableMultimap<K,V>, ReversibleIterableMultimap<K,V>

public interface MutableListMultimap<K,V>
extends ListMultimap<K,V>, MutableMultimap<K,V>

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
MutableList<V>	get(K key) Returns a view of all values associated with the given key.
MutableListMultimap<K,V>	newEmpty() Creates a new instance of the same implementation type, using the default capacity and growth parameters.
MutableList<V>	removeAll(java.lang.Object key)
MutableList<V>	replaceValues(K key, java.lang.Iterable<? extends V> values)
ImmutableListMultimap<K,V>	toImmutable() Returns an immutable copy of this Multimap if it is not already immutable.
MutableListMultimap<K,V>	toMutable() Returns a mutable copy of this Multimap.

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, toMap, toMap, valuesView

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

clear, put, putAll, putAll, putAllPairs, remove

Method Detail

replaceValues

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

Specified by:

replaceValues in interface MutableMultimap<K,V>

removeAll

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

Specified by:

removeAll in interface MutableMultimap<K,V>

newEmpty

MutableListMultimap<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 ListMultimap<K,V>

Specified by:

newEmpty in interface Multimap<K,V>

Specified by:

newEmpty in interface MutableMultimap<K,V>

Specified by:

newEmpty in interface ReversibleIterableMultimap<K,V>

get

MutableList<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 ListMultimap<K,V>

Specified by:

get in interface Multimap<K,V>

Specified by:

get in interface MutableMultimap<K,V>

Specified by:

get in interface ReversibleIterableMultimap<K,V>

Parameters:

key - the key to search for

toMutable

MutableListMultimap<K,V> toMutable()

Description copied from interface: Multimap

Returns a mutable copy of this Multimap.

Specified by:

toMutable in interface ListMultimap<K,V>

Specified by:

toMutable in interface Multimap<K,V>

toImmutable

ImmutableListMultimap<K,V> toImmutable()

Description copied from interface: Multimap

Returns an immutable copy of this Multimap if it is not already immutable. If the Multimap is immutable, it will return itself.

The returned Multimap will be Serializable if this Multimap is Serializable.

Specified by:

toImmutable in interface ListMultimap<K,V>

Specified by:

toImmutable in interface Multimap<K,V>