com.gs.collections.impl.multimap

Class AbstractMutableMultimap<K,V,C extends com.gs.collections.api.collection.MutableCollection<V>>

java.lang.Object

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

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

All Implemented Interfaces:

com.gs.collections.api.multimap.Multimap<K,V>, com.gs.collections.api.multimap.MutableMultimap<K,V>

Direct Known Subclasses:

AbstractSynchronizedPutMultimap, FastListMultimap, HashBagMultimap, TreeBagMultimap, TreeBagMultimap, TreeSortedSetMultimap, UnifiedSetMultimap, UnifiedSetWithHashingStrategyMultimap

public abstract class AbstractMutableMultimap<K,V,C extends com.gs.collections.api.collection.MutableCollection<V>>
extends AbstractMultimap<K,V,C>
implements com.gs.collections.api.multimap.MutableMultimap<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
protected com.gs.collections.api.map.MutableMap<K,C>	map
protected int	totalSize

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMutableMultimap()
protected	AbstractMutableMultimap(int size)
protected	AbstractMutableMultimap(com.gs.collections.api.map.MutableMap<K,C> newMap)
protected	AbstractMutableMultimap(com.gs.collections.api.tuple.Pair<K,V>... pairs) Constructs a Multimap containing all the Pairs.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addToTotalSize(int value) This method is provided to allow for subclasses to provide the behavior.
void	clear()
protected void	clearTotalSize() This method is provided to allow for subclasses to provide the behavior.
protected abstract com.gs.collections.api.map.MutableMap<K,C>	createMap()
protected abstract com.gs.collections.api.map.MutableMap<K,C>	createMapWithKeyCount(int keyCount)
protected void	decrementTotalSize() This method is provided to allow for subclasses to provide the behavior.
C	get(K key) Returns a view of all values associated with the given key.
protected com.gs.collections.api.map.MutableMap<K,C>	getMap()
protected void	incrementTotalSize() This method is provided to allow for subclasses to provide the behavior.
boolean	isEmpty() Returns true if there are no entries.
boolean	put(K key, V value)
boolean	putAll(K key, java.lang.Iterable<? extends V> values)
<KK extends K,VV extends V> boolean	putAll(com.gs.collections.api.multimap.Multimap<KK,VV> multimap)
boolean	putAllPairs(com.gs.collections.api.tuple.Pair<K,V>... pairs)
void	readExternal(java.io.ObjectInput in)
boolean	remove(java.lang.Object key, java.lang.Object value)
C	removeAll(java.lang.Object key)
C	replaceValues(K key, java.lang.Iterable<? extends V> values)
int	size() Use the size method directly instead of totalSize internally so subclasses can override if necessary.
int	sizeDistinct() Returns the number of distinct keys.
protected void	subtractFromTotalSize(int value) This method is provided to allow for subclasses to provide the behavior.
com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.RichIterable<V>>	toMap() Returns a new MutableMap of keys from this Multimap to the mapped values as a RichIterable.
void	writeExternal(java.io.ObjectOutput out)

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

containsKey, containsKeyAndValue, containsValue, createCollection, 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.MutableMultimap

newEmpty

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

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

Field Detail

map

protected com.gs.collections.api.map.MutableMap<K,C extends com.gs.collections.api.collection.MutableCollection<V>> map

totalSize

protected int totalSize

Constructor Detail

AbstractMutableMultimap

protected AbstractMutableMultimap()

AbstractMutableMultimap

protected AbstractMutableMultimap(com.gs.collections.api.map.MutableMap<K,C> newMap)

AbstractMutableMultimap

protected AbstractMutableMultimap(int size)

AbstractMutableMultimap

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

Constructs a Multimap containing all the Pairs.

Parameters:

pairs - the mappings to initialize the multimap.

Method Detail

createMap

protected abstract com.gs.collections.api.map.MutableMap<K,C> createMap()

createMapWithKeyCount

protected abstract com.gs.collections.api.map.MutableMap<K,C> createMapWithKeyCount(int keyCount)

getMap

protected com.gs.collections.api.map.MutableMap<K,C> getMap()

Specified by:

getMap in class AbstractMultimap<K,V,C extends com.gs.collections.api.collection.MutableCollection<V>>

size

public int size()

Use the size method directly instead of totalSize internally so subclasses can override if necessary.

Specified by:

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

incrementTotalSize

protected void incrementTotalSize()

This method is provided to allow for subclasses to provide the behavior. It should add 1 to the value that is returned by calling size().

decrementTotalSize

protected void decrementTotalSize()

This method is provided to allow for subclasses to provide the behavior. It should remove 1 from the value that is returned by calling size().

addToTotalSize

protected void addToTotalSize(int value)

This method is provided to allow for subclasses to provide the behavior. It should add the specified amount to the value that is returned by calling size().

subtractFromTotalSize

protected void subtractFromTotalSize(int value)

This method is provided to allow for subclasses to provide the behavior. It should subtract the specified amount from the value that is returned by calling size().

clearTotalSize

protected void clearTotalSize()

This method is provided to allow for subclasses to provide the behavior. It should set the value returned by size() to 0.

sizeDistinct

public int sizeDistinct()

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

Returns the number of distinct keys.

Specified by:

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

isEmpty

public boolean isEmpty()

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

Returns true if there are no entries.

Specified by:

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

put

public boolean put(K key,
          V value)

Specified by:

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

remove

public boolean remove(java.lang.Object key,
             java.lang.Object value)

Specified by:

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

putAllPairs

public boolean putAllPairs(com.gs.collections.api.tuple.Pair<K,V>... pairs)

Specified by:

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

putAll

public boolean putAll(K key,
             java.lang.Iterable<? extends V> values)

Specified by:

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

putAll

public <KK extends K,VV extends V> boolean putAll(com.gs.collections.api.multimap.Multimap<KK,VV> multimap)

Specified by:

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

replaceValues

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

Specified by:

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

removeAll

public C removeAll(java.lang.Object key)

Specified by:

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

clear

public void clear()

Specified by:

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

get

public C get(K key)

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

Specified by:

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

Parameters:

key - the key to search for

toMap

public com.gs.collections.api.map.MutableMap<K,com.gs.collections.api.RichIterable<V>> toMap()

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

Returns a new MutableMap of keys from this Multimap to the mapped values as a RichIterable.

Specified by:

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

writeExternal

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

Throws:

java.io.IOException

readExternal

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

Throws:

java.io.IOException

java.lang.ClassNotFoundException