Package org.eclipse.collections.impl.multimap

Class AbstractMutableMultimap<K,V,C extends MutableCollection<V>>

java.lang.Object

org.eclipse.collections.impl.multimap.AbstractMultimap<K,V,C>

org.eclipse.collections.impl.multimap.AbstractMutableMultimap<K,V,C>

All Implemented Interfaces:

Multimap<K,V>, MutableMultimap<K,V>

Direct Known Subclasses:

AbstractMutableBagMultimap, AbstractMutableListMultimap, AbstractMutableSetMultimap, AbstractSynchronizedPutMultimap, TreeBagMultimap, TreeBagMultimap, TreeBagMultimap, TreeSortedSetMultimap

public abstract class AbstractMutableMultimap<K,V,C extends MutableCollection<V>>
extends AbstractMultimap<K,V,C>
implements MutableMultimap<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
protected MutableMap<K,C>	map
protected int	totalSize

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMutableMultimap()
protected	AbstractMutableMultimap(int size)
protected	AbstractMutableMultimap(java.lang.Iterable<Pair<K,V>> inputIterable)	Constructs a Multimap containing Iterable.
protected	AbstractMutableMultimap(MutableMap<K,C> newMap)
protected	AbstractMutableMultimap(Pair<K,V>... pairs)	Constructs a Multimap containing all the Pairs.

Method Summary

Modifier and Type	Method	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 MutableMap<K,C>	createMap()
protected abstract 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.
C	getIfAbsentPutAll(K key, java.lang.Iterable<? extends V> values)	Puts values into multimap if there are no values already associated with key.
private C	getIfAbsentPutCollection(K key)
protected 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.
SetIterable<K>	keySet()	Returns an unmodifiable SetIterable of keys with O(1) complexity.
boolean	put(K key, V value)
boolean	putAll(K key, java.lang.Iterable<? extends V> values)
<KK extends K,VV extends V> boolean	putAll(Multimap<KK,VV> multimap)
private <KK extends K,VV extends V> boolean	putAllAbstractMutableMultimap(AbstractMutableMultimap<KK,VV,MutableCollection<VV>> other)
private boolean	putAllNotEmpty(K key, java.lang.Iterable<? extends V> values)
private <KK extends K,VV extends V> boolean	putAllReadOnlyMultimap(Multimap<KK,VV> multimap)
void	readExternal(java.io.ObjectInput in)
(package private) void	readValuesFrom(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.
MutableMap<K,RichIterable<V>>	toMap()	Returns a new MutableMap of keys from this Multimap to the mapped values as a RichIterable.
<R extends java.util.Collection<V>> MutableMap<K,R>	toMap(Function0<R> collectionFactory)	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 org.eclipse.collections.impl.multimap.AbstractMultimap

collectKeyMultiValues, 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 org.eclipse.collections.api.multimap.Multimap

collectKeyMultiValues, collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, equals, forEachKey, forEachKeyMultiValues, forEachKeyValue, forEachValue, hashCode, keyBag, keyMultiValuePairsView, keysView, keyValuePairsView, multiValuesView, notEmpty, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, toImmutable, toMutable, valuesView

Methods inherited from interface org.eclipse.collections.api.multimap.MutableMultimap

add, asSynchronized, collectKeyMultiValues, collectKeysValues, collectValues, flip, newEmpty, putAllPairs, putAllPairs, rejectKeysMultiValues, rejectKeysValues, selectKeysMultiValues, selectKeysValues, withKeyMultiValues, withKeyValue

Field Detail

map

protected MutableMap<K,C extends MutableCollection<V>> map

totalSize

protected int totalSize

Constructor Detail

AbstractMutableMultimap

protected AbstractMutableMultimap()

AbstractMutableMultimap

protected AbstractMutableMultimap(MutableMap<K,C> newMap)

AbstractMutableMultimap

protected AbstractMutableMultimap(int size)

AbstractMutableMultimap

protected AbstractMutableMultimap(Pair<K,V>... pairs)

Constructs a Multimap containing all the Pairs.

Parameters:

pairs - the mappings to initialize the multimap.

AbstractMutableMultimap

protected AbstractMutableMultimap(java.lang.Iterable<Pair<K,V>> inputIterable)

Constructs a Multimap containing Iterable.

Parameters:

inputIterable - the mappings to initialize the multimap.

Method Detail

createMap

protected abstract MutableMap<K,C> createMap()

createMapWithKeyCount

protected abstract MutableMap<K,C> createMapWithKeyCount(int keyCount)

getMap

protected MutableMap<K,C> getMap()

Specified by:

getMap in class AbstractMultimap<K,V,C extends 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 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: Multimap

Returns the number of distinct keys.

Specified by:

sizeDistinct in interface Multimap<K,V>

isEmpty

public boolean isEmpty()

Description copied from interface: Multimap

Returns true if there are no entries.

Specified by:

isEmpty in interface Multimap<K,V>

put

public boolean put(K key,
                   V value)

Specified by:

put in interface MutableMultimap<K,V>

remove

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

Specified by:

remove in interface MutableMultimap<K,V>

putAll

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

Specified by:

putAll in interface MutableMultimap<K,V>

putAllNotEmpty

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

putAll

public <KK extends K,VV extends V> boolean putAll(Multimap<KK,VV> multimap)

Specified by:

putAll in interface MutableMultimap<K,V>

putAllReadOnlyMultimap

private <KK extends K,VV extends V> boolean putAllReadOnlyMultimap(Multimap<KK,VV> multimap)

putAllAbstractMutableMultimap

private <KK extends K,VV extends V> boolean putAllAbstractMutableMultimap(AbstractMutableMultimap<KK,VV,MutableCollection<VV>> other)

replaceValues

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

Specified by:

replaceValues in interface MutableMultimap<K,V>

removeAll

public C removeAll(java.lang.Object key)

Specified by:

removeAll in interface MutableMultimap<K,V>

clear

public void clear()

Specified by:

clear in interface MutableMultimap<K,V>

keySet

public SetIterable<K> keySet()

Description copied from interface: Multimap

Returns an unmodifiable SetIterable of keys with O(1) complexity.

Specified by:

keySet in interface Multimap<K,V>

get

public C 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>

Specified by:

get in interface MutableMultimap<K,V>

Parameters:

key - the key to search for

getIfAbsentPutAll

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

Description copied from interface: MutableMultimap

Puts values into multimap if there are no values already associated with key. Then returns a view of the values associated with key, like the result of Multimap.get(Object)

Specified by:

getIfAbsentPutAll in interface MutableMultimap<K,V>

getIfAbsentPutCollection

private C getIfAbsentPutCollection(K key)

toMap

public MutableMap<K,RichIterable<V>> toMap()

Description copied from interface: Multimap

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

Specified by:

toMap in interface Multimap<K,V>

toMap

public <R extends java.util.Collection<V>> MutableMap<K,R> toMap(Function0<R> collectionFactory)

Description copied from interface: Multimap

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

Specified by:

toMap in interface Multimap<K,V>

Parameters:

collectionFactory - used to create the collections that hold the values and affects the return type

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

readValuesFrom

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

Throws:

java.io.IOException

java.lang.ClassNotFoundException