com.gs.collections.impl.multimap.bag

Class AbstractMutableBagMultimap<K,V>

java.lang.Object

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

com.gs.collections.impl.multimap.AbstractMutableMultimap<K,V,com.gs.collections.api.bag.MutableBag<V>>

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

All Implemented Interfaces:

com.gs.collections.api.multimap.bag.BagMultimap<K,V>, com.gs.collections.api.multimap.bag.MutableBagIterableMultimap<K,V>, com.gs.collections.api.multimap.bag.MutableBagMultimap<K,V>, com.gs.collections.api.multimap.bag.UnsortedBagMultimap<K,V>, com.gs.collections.api.multimap.Multimap<K,V>, com.gs.collections.api.multimap.MutableMultimap<K,V>

Direct Known Subclasses:

HashBagMultimap, HashBagMultimapWithHashingStrategy, MultiReaderHashBagMultimap

public abstract class AbstractMutableBagMultimap<K,V>
extends AbstractMutableMultimap<K,V,com.gs.collections.api.bag.MutableBag<V>>
implements com.gs.collections.api.multimap.bag.MutableBagMultimap<K,V>

Field Summary

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

map, totalSize

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMutableBagMultimap()
protected	AbstractMutableBagMultimap(int size)
protected	AbstractMutableBagMultimap(java.lang.Iterable<com.gs.collections.api.tuple.Pair<K,V>> inputIterable)
protected	AbstractMutableBagMultimap(com.gs.collections.api.tuple.Pair<K,V>... pairs)

Method Summary

Methods

Modifier and Type	Method and Description
<K2,V2> HashBagMultimap<K2,V2>	collectKeysValues(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function) Returns a new multimap with the results of applying the specified function on each key and value of the source multimap.
void	putOccurrences(K key, V value, int occurrences)
void	readExternal(java.io.ObjectInput in)
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.
void	writeExternal(java.io.ObjectOutput out)

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

add, addToTotalSize, clear, clearTotalSize, createMap, createMapWithKeyCount, decrementTotalSize, get, getMap, incrementTotalSize, isEmpty, put, putAll, putAll, putAllPairs, remove, removeAll, replaceValues, size, sizeDistinct, subtractFromTotalSize, toMap, toMap

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

collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, createCollection, createCollectionBlock, equals, forEachKey, forEachKeyMultiValues, forEachKeyValue, forEachValue, hashCode, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, 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.MutableBagMultimap

collectValues, flip, get, newEmpty, rejectKeysMultiValues, rejectKeysValues, removeAll, replaceValues, selectKeysMultiValues, selectKeysValues

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

add, clear, put, putAll, putAll, putAllPairs, remove

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

collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, equals, forEachKey, forEachKeyMultiValues, forEachKeyValue, forEachValue, hashCode, isEmpty, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, size, sizeDistinct, toMap, toMap, valuesView

Constructor Detail

AbstractMutableBagMultimap

protected AbstractMutableBagMultimap()

AbstractMutableBagMultimap

protected AbstractMutableBagMultimap(com.gs.collections.api.tuple.Pair<K,V>... pairs)

AbstractMutableBagMultimap

protected AbstractMutableBagMultimap(java.lang.Iterable<com.gs.collections.api.tuple.Pair<K,V>> inputIterable)

AbstractMutableBagMultimap

protected AbstractMutableBagMultimap(int size)

Method Detail

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>

collectKeysValues

public <K2,V2> HashBagMultimap<K2,V2> collectKeysValues(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function)

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

Returns a new multimap with the results of applying the specified function on each key and value of the source multimap. This method is also commonly called transform or map.

e.g.
 return multimap.collectKeysValues(new Function2<Integer, Person, Pair<String, String>>()
 {
     public Pair<String, String> valueOf(Integer age, Person person)
     {
         return Tuples.pair(age.toString(), person.getLastName());
     }
 });
 

Specified by:

collectKeysValues in interface com.gs.collections.api.multimap.bag.MutableBagIterableMultimap<K,V>

Specified by:

collectKeysValues in interface com.gs.collections.api.multimap.bag.MutableBagMultimap<K,V>

Specified by:

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

Specified by:

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

Specified by:

collectKeysValues in interface com.gs.collections.api.multimap.MutableMultimap<K,V>

Parameters:

function - a Function2 to use for transformation

Returns:

Multimap, which contains elements as a result of the transformation

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Overrides:

writeExternal in class AbstractMutableMultimap<K,V,com.gs.collections.api.bag.MutableBag<V>>

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Overrides:

readExternal in class AbstractMutableMultimap<K,V,com.gs.collections.api.bag.MutableBag<V>>

Throws:

java.io.IOException

java.lang.ClassNotFoundException

putOccurrences

public void putOccurrences(K key,
                  V value,
                  int occurrences)

Specified by:

putOccurrences in interface com.gs.collections.api.multimap.bag.MutableBagMultimap<K,V>