com.gs.collections.impl.multimap.bag

Class ImmutableBagMultimapImpl<K,V>

java.lang.Object

com.gs.collections.impl.multimap.AbstractMultimap<K,V,C>

com.gs.collections.impl.multimap.AbstractImmutableMultimap<K,V,com.gs.collections.api.bag.ImmutableBag<V>>

com.gs.collections.impl.multimap.bag.ImmutableBagMultimapImpl<K,V>

All Implemented Interfaces:

com.gs.collections.api.multimap.bag.BagMultimap<K,V>, com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>, com.gs.collections.api.multimap.bag.UnsortedBagMultimap<K,V>, com.gs.collections.api.multimap.ImmutableMultimap<K,V>, com.gs.collections.api.multimap.Multimap<K,V>, java.io.Serializable

public final class ImmutableBagMultimapImpl<K,V>
extends AbstractImmutableMultimap<K,V,com.gs.collections.api.bag.ImmutableBag<V>>
implements com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>, java.io.Serializable

The default ImmutableBagMultimap implementation.

Since:

1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.gs.collections.impl.multimap.AbstractImmutableMultimap

map

Constructor Summary

Constructors

Constructor and Description
ImmutableBagMultimapImpl(com.gs.collections.api.map.ImmutableMap<K,com.gs.collections.api.bag.ImmutableBag<V>> map)
ImmutableBagMultimapImpl(com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.bag.ImmutableBag<V>> map)

Method Summary

Methods

Modifier and Type	Method and Description
protected com.gs.collections.api.bag.ImmutableBag<V>	createCollection() Creates the collection of values for a single key.
com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>	newEmpty() Creates a new instance of the same implementation type, using the default capacity and growth parameters.
com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>	newWith(K key, V value)
com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>	newWithAll(K key, java.lang.Iterable<? extends V> values)
com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>	newWithout(java.lang.Object key, java.lang.Object value)
com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>	newWithoutAll(java.lang.Object key)
com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>	toImmutable() Returns an immutable copy of this Multimap if it is not already immutable.
com.gs.collections.api.multimap.bag.MutableBagMultimap<K,V>	toMutable() Returns a mutable copy of this Multimap.

Methods inherited from class com.gs.collections.impl.multimap.AbstractImmutableMultimap

get, getMap, isEmpty, readResolve, size, sizeDistinct, toMap

Methods inherited from class com.gs.collections.impl.multimap.AbstractMultimap

containsKey, containsKeyAndValue, containsValue, createCollectionBlock, equals, forEachKey, forEachKeyValue, forEachValue, hashCode, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, toMap, toString, valuesView

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.gs.collections.api.multimap.bag.ImmutableBagMultimap

get

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

Constructor Detail

ImmutableBagMultimapImpl

public ImmutableBagMultimapImpl(com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.bag.ImmutableBag<V>> map)

ImmutableBagMultimapImpl

public ImmutableBagMultimapImpl(com.gs.collections.api.map.ImmutableMap<K,com.gs.collections.api.bag.ImmutableBag<V>> map)

Method Detail

createCollection

protected com.gs.collections.api.bag.ImmutableBag<V> createCollection()

Description copied from class: AbstractMultimap

Creates the collection of values for a single key.

Collections with weak, soft, or phantom references are not supported. Each call to createCollection should create a new instance.

The returned collection class determines whether duplicate key-value pairs are allowed.

Specified by:

createCollection in class AbstractMultimap<K,V,com.gs.collections.api.bag.ImmutableBag<V>>

Returns:

an empty collection of values

newEmpty

public com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V> newEmpty()

Description copied from interface: com.gs.collections.api.multimap.Multimap

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

Specified by:

newEmpty in interface com.gs.collections.api.multimap.bag.BagMultimap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.multimap.bag.UnsortedBagMultimap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.multimap.Multimap<K,V>

toMutable

public com.gs.collections.api.multimap.bag.MutableBagMultimap<K,V> toMutable()

Description copied from interface: com.gs.collections.api.multimap.Multimap

Returns a mutable copy of this Multimap.

Specified by:

toMutable in interface com.gs.collections.api.multimap.bag.UnsortedBagMultimap<K,V>

Specified by:

toMutable in interface com.gs.collections.api.multimap.Multimap<K,V>

toImmutable

public com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V> toImmutable()

Description copied from interface: com.gs.collections.api.multimap.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 com.gs.collections.api.multimap.bag.UnsortedBagMultimap<K,V>

Specified by:

toImmutable in interface com.gs.collections.api.multimap.Multimap<K,V>

Overrides:

toImmutable in class AbstractImmutableMultimap<K,V,com.gs.collections.api.bag.ImmutableBag<V>>

newWith

public com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V> newWith(K key,
                                                                    V value)

Specified by:

newWith in interface com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>

Specified by:

newWith in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>

Overrides:

newWith in class AbstractImmutableMultimap<K,V,com.gs.collections.api.bag.ImmutableBag<V>>

newWithout

public com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V> newWithout(java.lang.Object key,
                                                                       java.lang.Object value)

Specified by:

newWithout in interface com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>

Specified by:

newWithout in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>

Overrides:

newWithout in class AbstractImmutableMultimap<K,V,com.gs.collections.api.bag.ImmutableBag<V>>

newWithAll

public com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V> newWithAll(K key,
                                                                       java.lang.Iterable<? extends V> values)

Specified by:

newWithAll in interface com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>

Specified by:

newWithAll in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>

Overrides:

newWithAll in class AbstractImmutableMultimap<K,V,com.gs.collections.api.bag.ImmutableBag<V>>

newWithoutAll

public com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V> newWithoutAll(java.lang.Object key)

Specified by:

newWithoutAll in interface com.gs.collections.api.multimap.bag.ImmutableBagMultimap<K,V>

Specified by:

newWithoutAll in interface com.gs.collections.api.multimap.ImmutableMultimap<K,V>

Overrides:

newWithoutAll in class AbstractImmutableMultimap<K,V,com.gs.collections.api.bag.ImmutableBag<V>>