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>

Method Summary

Modifier and Type	Method	Description
void	clear()
C	get(K key)	Returns a view of all values associated with the given key.
C	getIfAbsentPutAll(K key, Iterable<? extends V> values)	Puts values into multimap if there are no values already associated with key.
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, Iterable<? extends V> values)
<KK extends K, VV extends V> boolean	putAll(Multimap<KK,VV> multimap)
void	readExternal(ObjectInput in)
boolean	remove(Object key, Object value)
C	removeAll(Object key)
C	replaceValues(K key, 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.
MutableMap<K,RichIterable<V>>	toMap()	Returns a new MutableMap of keys from this Multimap to the mapped values as a RichIterable.
<R extends 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(ObjectOutput out)

Methods inherited from class org.eclipse.collections.impl.multimap.AbstractMultimap

collectKeyMultiValues, collectKeysValues, collectValues, containsKey, containsKeyAndValue, containsValue, 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

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

Method Details

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>

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(Object key,
 Object value)

Specified by:

remove in interface MutableMultimap<K,V>

putAll

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

Specified by:

putAll in interface MutableMultimap<K,V>

putAll

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

Specified by:

putAll in interface MutableMultimap<K,V>

replaceValues

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

Specified by:

replaceValues in interface MutableMultimap<K,V>

removeAll

public C removeAll(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,
 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>

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 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(ObjectOutput out)
                   throws IOException

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException