com.gs.collections.api.multimap.sortedbag

Interface SortedBagMultimap<K,V>

All Superinterfaces:

BagMultimap<K,V>, Multimap<K,V>, SortedIterableMultimap<K,V>

All Known Subinterfaces:

ImmutableSortedBagMultimap<K,V>, MutableSortedBagMultimap<K,V>

All Known Implementing Classes:

TreeBagMultimap, TreeBagMultimap

public interface SortedBagMultimap<K,V>
extends BagMultimap<K,V>, SortedIterableMultimap<K,V>

Since:

4.2

Method Summary

Modifier and Type	Method and Description
SortedBag<V>	get(K key) Returns a view of all values associated with the given key.
SortedBagMultimap<K,V>	newEmpty() Creates a new instance of the same implementation type, using the default capacity and growth parameters.
ImmutableSortedBagMultimap<K,V>	toImmutable() Returns an immutable copy of this Multimap if it is not already immutable.
MutableSortedBagMultimap<K,V>	toMutable() Returns a mutable copy of this Multimap.

Methods inherited from interface com.gs.collections.api.multimap.ordered.SortedIterableMultimap

comparator

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

Method Detail

newEmpty

SortedBagMultimap<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 BagMultimap<K,V>

Specified by:

newEmpty in interface Multimap<K,V>

Specified by:

newEmpty in interface SortedIterableMultimap<K,V>

get

SortedBag<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 BagMultimap<K,V>

Specified by:

get in interface Multimap<K,V>

Specified by:

get in interface SortedIterableMultimap<K,V>

Parameters:

key - the key to search for

toMutable

MutableSortedBagMultimap<K,V> toMutable()

Description copied from interface: Multimap

Returns a mutable copy of this Multimap.

Specified by:

toMutable in interface Multimap<K,V>

toImmutable

ImmutableSortedBagMultimap<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 Multimap<K,V>