Eclipse Collections 13.0.0 · org.eclipse.collections.impl.multimap.AbstractMutableMultimap

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

Access	Constructor and Description
protected	AbstractMutableMultimap()
protected	AbstractMutableMultimap(MutableMap<K, C> newMap)
protected	AbstractMutableMultimap(int size)
protected	AbstractMutableMultimap(Pair<K, V>... the mappings to initialize the multimap. pairs) Constructs a `Multimap` containing all the `Pair`s.
protected	AbstractMutableMultimap(Iterable<Pair<K, V>> the mappings to initialize the multimap. inputIterable) Constructs a `Multimap` containing `Iterable`.

Method Summary

Modifier and Type	Method and Description
protected void	addToTotalSize(int value) This method is provided to allow for subclasses to provide the behavior.
public void	clear() Implements org.eclipse.collections.api.multimap.MutableMultimap.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.
public C	get(K key) Implements org.eclipse.collections.api.multimap.MutableMultimap.get, org.eclipse.collections.api.multimap.Multimap.get. Returns a view of all values associated with the given key.
public C	getIfAbsentPutAll(K key, Iterable<? extends V> values) Implements org.eclipse.collections.api.multimap.MutableMultimap.getIfAbsentPutAll. Puts values into multimap if there are no values already associated with key.
private C	getIfAbsentPutCollection(K key)
protected MutableMap<K, C>	getMap() Implements abstract org.eclipse.collections.impl.multimap.AbstractMultimap.getMap.
protected void	incrementTotalSize() This method is provided to allow for subclasses to provide the behavior.
public boolean	isEmpty() Implements org.eclipse.collections.api.multimap.Multimap.isEmpty. Returns `true` if there are no entries.
public SetIterable<K>	keySet() Implements org.eclipse.collections.api.multimap.Multimap.keySet. Returns an unmodifiable `SetIterable` of keys with O(1) complexity.
public boolean	put(K key, V value) Implements org.eclipse.collections.api.multimap.MutableMultimap.put.
public boolean	putAll(K key, Iterable<? extends V> values) Implements org.eclipse.collections.api.multimap.MutableMultimap.putAll.
public <KK extends K, VV extends V> boolean	putAll(Multimap<KK, VV> multimap) Implements org.eclipse.collections.api.multimap.MutableMultimap.putAll.
private <KK extends K, VV extends V> boolean	putAllAbstractMutableMultimap(AbstractMutableMultimap<KK, VV, MutableCollection<VV>> other)
private boolean	putAllNotEmpty(K key, Iterable<? extends V> values)
private <KK extends K, VV extends V> boolean	putAllReadOnlyMultimap(Multimap<KK, VV> multimap)
public void	readExternal(ObjectInput in)
pack-priv void	readValuesFrom(ObjectInput in)
public boolean	remove(Object key, Object value) Implements org.eclipse.collections.api.multimap.MutableMultimap.remove.
public C	removeAll(Object key) Implements org.eclipse.collections.api.multimap.MutableMultimap.removeAll.
public C	replaceValues(K key, Iterable<? extends V> values) Implements org.eclipse.collections.api.multimap.MutableMultimap.replaceValues.
public int	size() Implements org.eclipse.collections.api.multimap.Multimap.size. Use the size method directly instead of totalSize internally so subclasses can override if necessary.
public int	sizeDistinct() Implements org.eclipse.collections.api.multimap.Multimap.sizeDistinct. Returns the number of distinct keys.
protected void	subtractFromTotalSize(int value) This method is provided to allow for subclasses to provide the behavior.
public MutableMap<K, RichIterable<V>>	toMap() Implements org.eclipse.collections.api.multimap.Multimap.toMap. Returns a new `MutableMap` of keys from this Multimap to the mapped values as a `RichIterable`.
public <R extends Collection<V>> MutableMap<K, R>	toMap(Function0<R> collectionFactory) Implements org.eclipse.collections.api.multimap.Multimap.toMap. Returns a new `MutableMap` of keys from this Multimap to the mapped values as a `RichIterable`.
public void	writeExternal(ObjectOutput out)

map	back to summary
protected MutableMap<K, C> map

totalSize	back to summary
protected int totalSize

AbstractMutableMultimap	back to summary
protected AbstractMutableMultimap()

AbstractMutableMultimap	back to summary
protected AbstractMutableMultimap(MutableMap<K, C> newMap)

AbstractMutableMultimap	back to summary
protected AbstractMutableMultimap(int size)

AbstractMutableMultimap	back to summary
protected AbstractMutableMultimap(Pair<K, V>... pairs) Constructs a `Multimap` containing all the `Pair`s. Parameters pairs:Pair<K, V>[] the mappings to initialize the multimap.

AbstractMutableMultimap	back to summary
protected AbstractMutableMultimap(Iterable<Pair<K, V>> inputIterable) Constructs a `Multimap` containing `Iterable`. Parameters inputIterable:Iterable<Pair<K, V>> the mappings to initialize the multimap.

Method Detail

addToTotalSize	back to summary
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().

clear	back to summary
public void clear() Implements org.eclipse.collections.api.multimap.MutableMultimap.clear. Annotations @Override

clear

back to summary

public void clear()

Implements org.eclipse.collections.api.multimap.MutableMultimap.clear.

Annotations

@Override

clearTotalSize	back to summary
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.

createMap	back to summary
protected abstract MutableMap<K, C> createMap()

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

decrementTotalSize	back to summary
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().

get back to summary

get	back to summary
public C get(K key) Implements org.eclipse.collections.api.multimap.MutableMultimap.get, org.eclipse.collections.api.multimap.Multimap.get. Doc from org.eclipse.collections.api.multimap.Multimap.get. Returns a view of all values associated with the given key. If the given key does not exist, an empty `RichIterable` is returned. Annotations @Override

public C get(K key)

Implements org.eclipse.collections.api.multimap.MutableMultimap.get, org.eclipse.collections.api.multimap.Multimap.get.

Doc from org.eclipse.collections.api.multimap.Multimap.get.

Returns a view of all values associated with the given key.

If the given key does not exist, an empty RichIterable is returned.

Annotations

@Override

getIfAbsentPutAll back to summary

getIfAbsentPutAll	back to summary
public C getIfAbsentPutAll(K key, Iterable<? extends V> values) Implements org.eclipse.collections.api.multimap.MutableMultimap.getIfAbsentPutAll. Doc from org.eclipse.collections.api.multimap.MutableMultimap.getIfAbsentPutAll. 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)` Annotations @Override

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

Implements org.eclipse.collections.api.multimap.MutableMultimap.getIfAbsentPutAll.

Doc from org.eclipse.collections.api.multimap.MutableMultimap.getIfAbsentPutAll.

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)

Annotations

@Override

getIfAbsentPutCollection	back to summary
private C getIfAbsentPutCollection(K key)

getMap	back to summary
protected MutableMap<K, C> getMap() Implements abstract org.eclipse.collections.impl.multimap.AbstractMultimap.getMap. Annotations @Override

getMap

back to summary

protected MutableMap<K, C> getMap()

Implements abstract org.eclipse.collections.impl.multimap.AbstractMultimap.getMap.

Annotations

@Override

incrementTotalSize	back to summary
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().

isEmpty back to summary

isEmpty	back to summary
public boolean isEmpty() Implements org.eclipse.collections.api.multimap.Multimap.isEmpty. Doc from org.eclipse.collections.api.multimap.Multimap.isEmpty. Returns `true` if there are no entries. Annotations @Override

public boolean isEmpty()

Implements org.eclipse.collections.api.multimap.Multimap.isEmpty.

Doc from org.eclipse.collections.api.multimap.Multimap.isEmpty.

Returns true if there are no entries.

Annotations

@Override

keySet back to summary

keySet	back to summary
public SetIterable<K> keySet() Implements org.eclipse.collections.api.multimap.Multimap.keySet. Doc from org.eclipse.collections.api.multimap.Multimap.keySet. Returns an unmodifiable `SetIterable` of keys with O(1) complexity. Annotations @Override

public SetIterable<K> keySet()

Implements org.eclipse.collections.api.multimap.Multimap.keySet.

Doc from org.eclipse.collections.api.multimap.Multimap.keySet.

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

Annotations

@Override

put	back to summary
public boolean put(K key, V value) Implements org.eclipse.collections.api.multimap.MutableMultimap.put. Annotations @Override

put

back to summary

public boolean put(K key, V value)

Implements org.eclipse.collections.api.multimap.MutableMultimap.put.

Annotations

@Override

putAll	back to summary
public boolean putAll(K key, Iterable<? extends V> values) Implements org.eclipse.collections.api.multimap.MutableMultimap.putAll. Annotations @Override

putAll

back to summary

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

Implements org.eclipse.collections.api.multimap.MutableMultimap.putAll.

Annotations

@Override

putAll	back to summary
public <KK extends K, VV extends V> boolean putAll(Multimap<KK, VV> multimap) Implements org.eclipse.collections.api.multimap.MutableMultimap.putAll. Annotations @Override

putAll

back to summary

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

Implements org.eclipse.collections.api.multimap.MutableMultimap.putAll.

Annotations

@Override

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

putAllNotEmpty	back to summary
private boolean putAllNotEmpty(K key, Iterable<? extends V> values)

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

readExternal	back to summary
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException

readValuesFrom	back to summary
pack-priv void readValuesFrom(ObjectInput in) throws IOException, ClassNotFoundException

remove	back to summary
public boolean remove(Object key, Object value) Implements org.eclipse.collections.api.multimap.MutableMultimap.remove. Annotations @Override

remove

back to summary

public boolean remove(Object key, Object value)

Implements org.eclipse.collections.api.multimap.MutableMultimap.remove.

Annotations

@Override

removeAll	back to summary
public C removeAll(Object key) Implements org.eclipse.collections.api.multimap.MutableMultimap.removeAll. Annotations @Override

removeAll

back to summary

public C removeAll(Object key)

Implements org.eclipse.collections.api.multimap.MutableMultimap.removeAll.

Annotations

@Override

replaceValues	back to summary
public C replaceValues(K key, Iterable<? extends V> values) Implements org.eclipse.collections.api.multimap.MutableMultimap.replaceValues. Annotations @Override

replaceValues

back to summary

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

Implements org.eclipse.collections.api.multimap.MutableMultimap.replaceValues.

Annotations

@Override

size	back to summary
public int size() Implements org.eclipse.collections.api.multimap.Multimap.size. Use the size method directly instead of totalSize internally so subclasses can override if necessary. Annotations @Override

size

back to summary

public int size()

Implements org.eclipse.collections.api.multimap.Multimap.size.

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

Annotations

@Override

sizeDistinct	back to summary
public int sizeDistinct() Implements org.eclipse.collections.api.multimap.Multimap.sizeDistinct. Doc from org.eclipse.collections.api.multimap.Multimap.sizeDistinct. Returns the number of distinct keys. Annotations @Override

sizeDistinct

back to summary

public int sizeDistinct()

Implements org.eclipse.collections.api.multimap.Multimap.sizeDistinct.

Doc from org.eclipse.collections.api.multimap.Multimap.sizeDistinct.

Returns the number of distinct keys.

Annotations

@Override

subtractFromTotalSize	back to summary
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().

toMap back to summary

toMap	back to summary
public MutableMap<K, RichIterable<V>> toMap() Implements org.eclipse.collections.api.multimap.Multimap.toMap. Doc from org.eclipse.collections.api.multimap.Multimap.toMap. Returns a new `MutableMap` of keys from this Multimap to the mapped values as a `RichIterable`. Annotations @Override

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

Implements org.eclipse.collections.api.multimap.Multimap.toMap.

Doc from org.eclipse.collections.api.multimap.Multimap.toMap.

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

Annotations

@Override

toMap back to summary

toMap	back to summary
public <R extends Collection<V>> MutableMap<K, R> toMap(Function0<R> collectionFactory) Implements org.eclipse.collections.api.multimap.Multimap.toMap. Doc from org.eclipse.collections.api.multimap.Multimap.toMap. Returns a new `MutableMap` of keys from this Multimap to the mapped values as a `RichIterable`. Annotations @Override

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

Implements org.eclipse.collections.api.multimap.Multimap.toMap.

Doc from org.eclipse.collections.api.multimap.Multimap.toMap.

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

Annotations

@Override

writeExternal	back to summary
public void writeExternal(ObjectOutput out) throws IOException

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

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail