Class AbstractMemoryEfficientMutableMap<K,V>

java.lang.Object

org.eclipse.collections.impl.AbstractRichIterable<V>

org.eclipse.collections.impl.map.AbstractMapIterable<K,V>

org.eclipse.collections.impl.map.mutable.AbstractMutableMapIterable<K,V>

org.eclipse.collections.impl.map.mutable.AbstractMutableMap<K,V>

org.eclipse.collections.impl.map.fixed.AbstractMemoryEfficientMutableMap<K,V>

All Implemented Interfaces:

Cloneable, Iterable<V>, Map<K,V>, InternalIterable<V>, FixedSizeMap<K,V>, MapIterable<K,V>, MutableMap<K,V>, MutableMapIterable<K,V>, UnsortedMapIterable<K,V>, RichIterable<V>

Direct Known Subclasses:

DoubletonMap, EmptyMap, SingletonMap, TripletonMap

abstract class AbstractMemoryEfficientMutableMap<K,V>
extends AbstractMutableMap<K,V>
implements FixedSizeMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from class AbstractMutableMap

AbstractMutableMap.ValuesCollectionCommon<V>

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
AbstractMemoryEfficientMutableMap()

Method Summary

Modifier and Type	Method	Description
void	clear()
abstract <K2,V2> FixedSizeMap<K2,V2>	collect(Function2<? super K, ? super V, Pair<K2,V2>> function)	For each key and value of the map the function is evaluated.
<E> MutableMap<K,V>	collectKeysAndValues(Iterable<E> iterable, Function<? super E, ? extends K> keyFunction, Function<? super E, ? extends V> valueFunction)	Adds all the entries derived from iterable to this.
abstract <R> FixedSizeMap<R,V>	collectKeysUnique(Function2<? super K, ? super V, ? extends R> function)	For each key and value of the map the function is evaluated.
abstract <R> FixedSizeMap<K,R>	collectValues(Function2<? super K, ? super V, ? extends R> function)	For each key and value of the map the function is evaluated.
V	merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction)
MutableMap<K,V>	newEmpty()	Creates a new instance of the same type, using the default capacity and growth parameters.
MutableMap<K,V>	newEmpty(int capacity)	Creates a new instance of the same type, using the given capacity and the default growth parameters.
V	put(K key, V value)
void	putAll(Map<? extends K, ? extends V> map)
abstract FixedSizeMap<K,V>	reject(Predicate2<? super K, ? super V> predicate)	For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.
V	remove(Object key)
boolean	removeAllKeys(Set<? extends K> keys)	Remove entries from the map at the specified keys.
boolean	removeIf(Predicate2<? super K, ? super V> predicate)	Remove an entry from the map if the predicate evaluates to true.
V	removeKey(K key)	Remove an entry from the map at the specified key.
abstract FixedSizeMap<K,V>	select(Predicate2<? super K, ? super V> predicate)	For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.
FixedSizeMap<K,V>	tap(Procedure<? super V> procedure)	Executes the Procedure for each element in the iterable and returns this.
V	updateValue(K key, Function0<? extends V> factory, Function<? super V, ? extends V> function)	Looks up the value associated with key, applies the function to it, and replaces the value.
<P> V	updateValueWith(K key, Function0<? extends V> factory, Function2<? super V, ? super P, ? extends V> function, P parameter)	Same as MutableMapIterable.updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.
MutableMap<K,V>	withAllKeyValueArguments(Pair<? extends K, ? extends V>... keyValues)	Convenience var-args version of withAllKeyValues
MutableMap<K,V>	withAllKeyValues(Iterable<? extends Pair<? extends K, ? extends V>> keyValues)	This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
MutableMap<K,V>	withoutAllKeys(Iterable<? extends K> keys)	This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.

Methods inherited from class AbstractMutableMap

asSynchronized, asUnmodifiable, clone, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, flip, groupBy, groupByEach, groupByUniqueKey, partition, partitionWith, reject, rejectWith, replaceAll, select, selectInstancesOf, selectWith, toImmutable, withKeyValue, withoutKey, zip, zipWithIndex

Methods inherited from class AbstractMutableMapIterable

aggregateBy, countBy, countByEach, countByWith, detect, detectOptional, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, iterator, keysView, keyValuesView, reduceBy, sumByDouble, sumByFloat, sumByInt, sumByLong, valuesView

Methods inherited from class AbstractMapIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asLazy, chunk, contains, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, getOnly, getOrDefault, ifPresentApply, isAbsent, keyAndValueEquals, keyAndValueHashCode, noneSatisfy, noneSatisfyWith, toArray, toArray

Methods inherited from class AbstractRichIterable

appendString, appendString, collect, collectIf, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, max, max, maxBy, min, min, minBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface FixedSizeMap

putAllMapIterable, withMap, withMapIterable

Methods inherited from interface InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface Iterable

iterator

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, putIfAbsent, remove, replace, replace, replaceAll, size, values

Methods inherited from interface MapIterable

containsKey, containsValue, detect, detectOptional, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, injectIntoKeyValue, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView

Methods inherited from interface MutableMap

aggregateBy, aggregateBy, aggregateInPlaceBy, asSynchronized, asUnmodifiable, clone, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, flatCollectWith, flip, flipUniqueValues, groupBy, groupByEach, groupByUniqueKey, partition, partitionWith, reduceBy, reject, rejectWith, select, selectInstancesOf, selectWith, withKeyValue, withoutKey, zip, zipWithIndex

Methods inherited from interface MutableMapIterable

add, countBy, countByEach, countByWith, forEach, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, getOrDefault, putPair, sumByDouble, sumByFloat, sumByInt, sumByLong, toImmutable

Methods inherited from interface RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from interface UnsortedMapIterable

toImmutable

Constructor Details

AbstractMemoryEfficientMutableMap

AbstractMemoryEfficientMutableMap()

Method Details

put

public V put(K key,
 V value)

Specified by:

put in interface FixedSizeMap<K,V>

Specified by:

put in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface FixedSizeMap<K,V>

Specified by:

remove in interface Map<K,V>

putAll

public void putAll(Map<? extends K, ? extends V> map)

Specified by:

putAll in interface FixedSizeMap<K,V>

Specified by:

putAll in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface FixedSizeMap<K,V>

Specified by:

clear in interface Map<K,V>

removeKey

public V removeKey(K key)

Description copied from interface: MutableMapIterable

Remove an entry from the map at the specified key.

Specified by:

removeKey in interface FixedSizeMap<K,V>

Specified by:

removeKey in interface MutableMapIterable<K,V>

Returns:

The value removed from entry at key, or null if not found.

See Also:

• Map.remove(Object)

removeAllKeys

public boolean removeAllKeys(Set<? extends K> keys)

Description copied from interface: MutableMapIterable

Remove entries from the map at the specified keys.

Specified by:

removeAllKeys in interface FixedSizeMap<K,V>

Specified by:

removeAllKeys in interface MutableMapIterable<K,V>

Returns:

true if this map changed as a result of the call

removeIf

public boolean removeIf(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MutableMapIterable

Remove an entry from the map if the predicate evaluates to true.

Specified by:

removeIf in interface FixedSizeMap<K,V>

Specified by:

removeIf in interface MutableMapIterable<K,V>

Returns:

true if any entry is removed.

collectKeysAndValues

public <E> MutableMap<K,V> collectKeysAndValues(Iterable<E> iterable,
 Function<? super E, ? extends K> keyFunction,
 Function<? super E, ? extends V> valueFunction)

Description copied from interface: MutableMap

Adds all the entries derived from iterable to this. The key and value for each entry is determined by applying the keyFunction and valueFunction to each item in collection. Any entry in map that has the same key as an entry in this will have its value replaced by that in map.

Specified by:

collectKeysAndValues in interface MutableMap<K,V>

updateValue

public V updateValue(K key,
 Function0<? extends V> factory,
 Function<? super V, ? extends V> function)

Description copied from interface: MutableMapIterable

Looks up the value associated with key, applies the function to it, and replaces the value. If there is no value associated with key, starts it off with a value supplied by factory.

Specified by:

updateValue in interface MutableMapIterable<K,V>

Overrides:

updateValue in class AbstractMutableMapIterable<K,V>

updateValueWith

public <P> V updateValueWith(K key,
 Function0<? extends V> factory,
 Function2<? super V, ? super P, ? extends V> function,
 P parameter)

Description copied from interface: MutableMapIterable

Same as MutableMapIterable.updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.

Specified by:

updateValueWith in interface MutableMapIterable<K,V>

Overrides:

updateValueWith in class AbstractMutableMapIterable<K,V>

merge

public V merge(K key,
 V value,
 BiFunction<? super V, ? super V, ? extends V> remappingFunction)

Specified by:

merge in interface Map<K,V>

newEmpty

public MutableMap<K,V> newEmpty()

Description copied from interface: MutableMapIterable

Creates a new instance of the same type, using the default capacity and growth parameters.

Specified by:

newEmpty in interface MutableMap<K,V>

Specified by:

newEmpty in interface MutableMapIterable<K,V>

newEmpty

public MutableMap<K,V> newEmpty(int capacity)

Description copied from class: AbstractMutableMap

Creates a new instance of the same type, using the given capacity and the default growth parameters.

Specified by:

newEmpty in class AbstractMutableMap<K,V>

withAllKeyValues

public MutableMap<K,V> withAllKeyValues(Iterable<? extends Pair<? extends K, ? extends V>> keyValues)

Description copied from interface: MutableMapIterable

This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus all the additional keys and values. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

map = map.withAllKeyValues(FastList.newListWith(PairImpl.of("new key", "new value")));

In the case of FixedSizeMap, a new instance will be returned by withAllKeyValues, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.

Specified by:

withAllKeyValues in interface MutableMap<K,V>

Specified by:

withAllKeyValues in interface MutableMapIterable<K,V>

Overrides:

withAllKeyValues in class AbstractMutableMap<K,V>

See Also:

• Map.put(Object, Object)

withAllKeyValueArguments

public MutableMap<K,V> withAllKeyValueArguments(Pair<? extends K, ? extends V>... keyValues)

Description copied from interface: MutableMapIterable

Convenience var-args version of withAllKeyValues

Specified by:

withAllKeyValueArguments in interface MutableMap<K,V>

Specified by:

withAllKeyValueArguments in interface MutableMapIterable<K,V>

Overrides:

withAllKeyValueArguments in class AbstractMutableMap<K,V>

See Also:

• MutableMapIterable.withAllKeyValues(Iterable)

withoutAllKeys

public MutableMap<K,V> withoutAllKeys(Iterable<? extends K> keys)

Description copied from interface: MutableMapIterable

This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus all the keys and values to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

map = map.withoutAllKeys(FastList.newListWith("key1", "key2"));

In the case of FixedSizeMap, a new instance will be returned by withoutAllKeys, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.

Specified by:

withoutAllKeys in interface MutableMap<K,V>

Specified by:

withoutAllKeys in interface MutableMapIterable<K,V>

Overrides:

withoutAllKeys in class AbstractMutableMap<K,V>

See Also:

• Map.remove(Object)

tap

public FixedSizeMap<K,V> tap(Procedure<? super V> procedure)

Description copied from interface: RichIterable

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

RichIterable<Person> tapped =
    people.tap(person -> LOGGER.info(person.getName()));

Specified by:

tap in interface FixedSizeMap<K,V>

Specified by:

tap in interface MapIterable<K,V>

Specified by:

tap in interface MutableMap<K,V>

Specified by:

tap in interface MutableMapIterable<K,V>

Specified by:

tap in interface RichIterable<K>

Specified by:

tap in interface UnsortedMapIterable<K,V>

Overrides:

tap in class AbstractMutableMap<K,V>

See Also:

• RichIterable.each(Procedure)
• RichIterable.forEach(Procedure)

select

public abstract FixedSizeMap<K,V> select(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MapIterable

For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.

MapIterable<City, Person> selected =
    peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));

Specified by:

select in interface MapIterable<K,V>

Specified by:

select in interface MutableMap<K,V>

Specified by:

select in interface MutableMapIterable<K,V>

Specified by:

select in interface UnsortedMapIterable<K,V>

Overrides:

select in class AbstractMutableMap<K,V>

collectValues

public abstract <R> FixedSizeMap<K,R> collectValues(Function2<? super K, ? super V, ? extends R> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

MapIterable<City, String> collected =
    peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());

Specified by:

collectValues in interface MapIterable<K,V>

Specified by:

collectValues in interface MutableMap<K,V>

Specified by:

collectValues in interface MutableMapIterable<K,V>

Specified by:

collectValues in interface UnsortedMapIterable<K,V>

Overrides:

collectValues in class AbstractMutableMap<K,V>

collectKeysUnique

public abstract <R> FixedSizeMap<R,V> collectKeysUnique(Function2<? super K, ? super V, ? extends R> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the keys projected from the function rather than the original keys.

Specified by:

collectKeysUnique in interface MapIterable<K,V>

Specified by:

collectKeysUnique in interface MutableMap<K,V>

Specified by:

collectKeysUnique in interface MutableMapIterable<K,V>

Overrides:

collectKeysUnique in class AbstractMutableMap<K,V>

collect

public abstract <K2,V2> FixedSizeMap<K2,V2> collect(Function2<? super K, ? super V, Pair<K2,V2>> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

MapIterable<String, String> collected =
    peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));

Specified by:

collect in interface MapIterable<K,V>

Specified by:

collect in interface MutableMap<K,V>

Specified by:

collect in interface MutableMapIterable<K,V>

Specified by:

collect in interface UnsortedMapIterable<K,V>

Overrides:

collect in class AbstractMutableMapIterable<K,V>

reject

public abstract FixedSizeMap<K,V> reject(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MapIterable

For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.

MapIterable<City, Person> rejected =
    peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));

Specified by:

reject in interface MapIterable<K,V>

Specified by:

reject in interface MutableMap<K,V>

Specified by:

reject in interface MutableMapIterable<K,V>

Specified by:

reject in interface UnsortedMapIterable<K,V>

Overrides:

reject in class AbstractMutableMap<K,V>