com.gs.collections.api.multimap

Interface ImmutableMultimap<K,V>

All Superinterfaces:

Multimap<K,V>

All Known Subinterfaces:

ImmutableBagMultimap<K,V>, ImmutableListMultimap<K,V>, ImmutableSetMultimap<K,V>, ImmutableSortedBagMultimap<K,V>, ImmutableSortedSetMultimap<K,V>

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

Since:

1.0

Method Summary

Methods

Modifier and Type	Method and Description
ImmutableCollection<V>	get(K key) Returns a view of all values associated with the given key.
ImmutableMultimap<K,V>	newEmpty() Creates a new instance of the same implementation type, using the default capacity and growth parameters.
ImmutableMultimap<K,V>	newWith(K key, V value)
ImmutableMultimap<K,V>	newWithAll(K key, java.lang.Iterable<? extends V> values)
ImmutableMultimap<K,V>	newWithout(java.lang.Object key, java.lang.Object value)
ImmutableMultimap<K,V>	newWithoutAll(java.lang.Object key)

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

ImmutableMultimap<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

ImmutableCollection<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

newWith

ImmutableMultimap<K,V> newWith(K key,
                             V value)

newWithout

ImmutableMultimap<K,V> newWithout(java.lang.Object key,
                                java.lang.Object value)

newWithAll

ImmutableMultimap<K,V> newWithAll(K key,
                                java.lang.Iterable<? extends V> values)

newWithoutAll

ImmutableMultimap<K,V> newWithoutAll(java.lang.Object key)