Package org.eclipse.collections.api.bimap

Interface MutableBiMap<K,V>

All Superinterfaces:

BiMap<K,V>, Cloneable, InternalIterable<V>, Iterable<V>, Map<K,V>, MapIterable<K,V>, MutableMapIterable<K,V>, RichIterable<V>

All Known Implementing Classes:

HashBiMap, SynchronizedBiMap, UnmodifiableBiMap

public interface MutableBiMap<K,V>
extends BiMap<K,V>, MutableMapIterable<K,V>, Cloneable

A BiMap whose contents can be altered after initialization.

Since:

4.2

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Method Summary

Modifier and Type	Method	Description
MutableBiMap<K,V>	asSynchronized()	Returns a synchronized wrapper backed by this map.
MutableBiMap<K,V>	asUnmodifiable()	Returns an unmodifiable view of this map.
MutableBiMap<K,V>	clone()
<K2, V2> MutableBiMap<K2,V2>	collect(Function2<? super K,? super V,Pair<K2,V2>> function)	For each key and value of the map the function is evaluated.
<R> MutableBiMap<K,R>	collectValues(Function2<? super K,? super V,? extends R> function)	For each key and value of the map the function is evaluated.
MutableSetMultimap<V,K>	flip()	Given a map from Domain -> Range return a multimap from Range -> Domain.
MutableBiMap<V,K>	flipUniqueValues()	Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
V	forcePut(K key, V value)	Similar to put(Object, Object), except that it quietly removes any existing entry with the same value before putting the key-value pair.
<V1> MutableSetMultimap<V1,V>	groupBy(Function<? super V,? extends V1> function)	For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<V1> MutableSetMultimap<V1,V>	groupByEach(Function<? super V,? extends Iterable<V1>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
default <VV> MutableBiMap<VV,V>	groupByUniqueKey(Function<? super V,? extends VV> function)	For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
MutableBiMap<V,K>	inverse()	Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.
MutableBiMap<K,V>	newEmpty()	Creates a new instance of the same type, using the default capacity and growth parameters.
PartitionMutableSet<V>	partition(Predicate<? super V> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> PartitionMutableSet<V>	partitionWith(Predicate2<? super V,? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
V	put(K key, V value)	Similar to Map.put(Object, Object), except that it throws on the addition of a duplicate value.
MutableSet<V>	reject(Predicate<? super V> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
MutableBiMap<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.
<P> MutableSet<V>	rejectWith(Predicate2<? super V,? super P> predicate, P parameter)	Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
MutableSet<V>	select(Predicate<? super V> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
MutableBiMap<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.
<S> MutableSet<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> MutableSet<V>	selectWith(Predicate2<? super V,? super P> predicate, P parameter)	Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
MutableBiMap<K,V>	tap(Procedure<? super V> procedure)	Executes the Procedure for each value of the map and returns this.
MutableBiMap<K,V>	withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)	Convenience var-args version of withAllKeyValues
MutableBiMap<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.
MutableBiMap<K,V>	withKeyValue(K key, V value)	This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
default MutableBiMap<K,V>	withMap(Map<? extends K,? extends V> map)	Similar to Map.putAll(Map), but returns this instead of void
MutableBiMap<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.
MutableBiMap<K,V>	withoutKey(K key)	This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.
<S> MutableSet<Pair<V,S>>	zip(Iterable<S> that)	Deprecated. in 8.0.
MutableSet<Pair<V,Integer>>	zipWithIndex()	Deprecated. in 8.0.

Methods inherited from interface org.eclipse.collections.api.bimap.BiMap

toImmutable

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from interface java.util.Map

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

Methods inherited from interface org.eclipse.collections.api.map.MapIterable

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

Methods inherited from interface org.eclipse.collections.api.map.MutableMapIterable

add, aggregateBy, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, getOrDefault, putPair, removeAllKeys, removeIf, removeKey, sumByDouble, sumByFloat, sumByInt, sumByLong, toImmutable, updateValue, updateValueWith

Methods inherited from interface org.eclipse.collections.api.RichIterable

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

Method Details

newEmpty

MutableBiMap<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 MutableMapIterable<K,V>

inverse

MutableBiMap<V,K> inverse()

Description copied from interface: BiMap

Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.

Specified by:

inverse in interface BiMap<K,V>

flipUniqueValues

MutableBiMap<V,K> flipUniqueValues()

Description copied from interface: MapIterable

Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.

     MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     MapIterable<String, Integer> result = map.flipUniqueValues();
     Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
 

Specified by:

flipUniqueValues in interface BiMap<K,V>

Specified by:

flipUniqueValues in interface MapIterable<K,V>

Specified by:

flipUniqueValues in interface MutableMapIterable<K,V>

flip

MutableSetMultimap<V,K> flip()

Description copied from interface: MapIterable

Given a map from Domain -> Range return a multimap from Range -> Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.

Since the keys in the input are unique, the values in the output are unique, so the return type should be a SetMultimap. However since SetMultimap and SortedSetMultimap don't inherit from one another, SetMultimap here does not allow SortedMapIterable to have a SortedSetMultimap return. Thus we compromise and call this Multimap, even though all implementations will be a SetMultimap or SortedSetMultimap.

Specified by:

flip in interface BiMap<K,V>

Specified by:

flip in interface MapIterable<K,V>

Specified by:

flip in interface MutableMapIterable<K,V>

put

V put(K key, V value)

Similar to Map.put(Object, Object), except that it throws on the addition of a duplicate value.

Specified by:

put in interface Map<K,V>

Throws:

IllegalArgumentException - if the value already exists in the bimap.

forcePut

V forcePut(K key, V value)

Similar to put(Object, Object), except that it quietly removes any existing entry with the same value before putting the key-value pair.

asSynchronized

MutableBiMap<K,V> asSynchronized()

Description copied from interface: MutableMapIterable

Returns a synchronized wrapper backed by this map. This is the equivalent of calling Collections.synchronizedMap(this) only with the more feature rich return type of MutableMapIterable.

The preferred way of iterating over a synchronized map is to use the forEachKey(), forEachValue() and forEachKeyValue() methods which are properly synchronized internally.

  MutableMap synchedMap = map.asSynchronized();

  synchedMap.forEachKey(key -> ... );
  synchedMap.forEachValue(value -> ... );
  synchedMap.forEachKeyValue((key, value) -> ... );
 

If you want to iterate imperatively over the keySet(), values(), or entrySet(), you will need to protect the iteration by wrapping the code in a synchronized block on the map.

Specified by:

asSynchronized in interface MutableMapIterable<K,V>

See Also:

Collections.synchronizedMap(Map)

asUnmodifiable

MutableBiMap<K,V> asUnmodifiable()

Description copied from interface: MutableMapIterable

Returns an unmodifiable view of this map. This is the equivalent of using Collections.unmodifiableMap(this) only with a return type that supports the full iteration protocols available on MutableMapIterable. Methods which would mutate the underlying map will throw UnsupportedOperationExceptions.

Specified by:

asUnmodifiable in interface MutableMapIterable<K,V>

Returns:

an unmodifiable view of this map.

See Also:

Collections.unmodifiableMap(Map)

clone

MutableBiMap<K,V> clone()

tap

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

Description copied from interface: MapIterable

Executes the Procedure for each value of the map and returns this.

 return peopleByCity.tap(person -> LOGGER.info(person.getName()));
 

Specified by:

tap in interface BiMap<K,V>

Specified by:

tap in interface MapIterable<K,V>

Specified by:

tap in interface MutableMapIterable<K,V>

Specified by:

tap in interface RichIterable<K>

See Also:

RichIterable.forEach(Procedure)

select

MutableBiMap<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 BiMap<K,V>

Specified by:

select in interface MapIterable<K,V>

Specified by:

select in interface MutableMapIterable<K,V>

reject

MutableBiMap<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 BiMap<K,V>

Specified by:

reject in interface MapIterable<K,V>

Specified by:

reject in interface MutableMapIterable<K,V>

collect

<K2, V2> MutableBiMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)

Description copied from interface: BiMap

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()));
 

Implementations are expected to delegate to put(Object, Object), ImmutableBiMap.newWithKeyValue(Object, Object), or equivalent, not forcePut(Object, Object).

Specified by:

collect in interface BiMap<K,V>

Specified by:

collect in interface MapIterable<K,V>

Specified by:

collect in interface MutableMapIterable<K,V>

collectValues

<R> MutableBiMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)

Description copied from interface: BiMap

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());
 

Implementations are expected to delegate to put(Object, Object), ImmutableBiMap.newWithKeyValue(Object, Object), or equivalent, not forcePut(Object, Object).

Specified by:

collectValues in interface BiMap<K,V>

Specified by:

collectValues in interface MapIterable<K,V>

Specified by:

collectValues in interface MutableMapIterable<K,V>

select

MutableSet<V> select(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

Example using a Java 8 lambda expression:

 RichIterable<Person> selected =
     people.select(person -> person.getAddress().getCity().equals("London"));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });
 

Specified by:

select in interface BiMap<K,V>

Specified by:

select in interface MutableMapIterable<K,V>

Specified by:

select in interface RichIterable<K>

selectWith

<P> MutableSet<V> selectWith(Predicate2<? super V,? super P> predicate, P parameter)

Description copied from interface: RichIterable

Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge()>= age;
         }
     }, Integer.valueOf(18));
 

Specified by:

selectWith in interface BiMap<K,V>

Specified by:

selectWith in interface MutableMapIterable<K,V>

Specified by:

selectWith in interface RichIterable<K>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

RichIterable.select(Predicate)

reject

MutableSet<V> reject(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

Example using a Java 8 lambda expression:

 RichIterable<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"));
 

Example using an anonymous inner class:

 RichIterable<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     });
 

Specified by:

reject in interface BiMap<K,V>

Specified by:

reject in interface MutableMapIterable<K,V>

Specified by:

reject in interface RichIterable<K>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

rejectWith

<P> MutableSet<V> rejectWith(Predicate2<? super V,? super P> predicate, P parameter)

Description copied from interface: RichIterable

Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 

Specified by:

rejectWith in interface BiMap<K,V>

Specified by:

rejectWith in interface MutableMapIterable<K,V>

Specified by:

rejectWith in interface RichIterable<K>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

RichIterable.select(Predicate)

partition

PartitionMutableSet<V> partition(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 

Example using an anonymous inner class:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
 

Specified by:

partition in interface BiMap<K,V>

Specified by:

partition in interface MutableMapIterable<K,V>

Specified by:

partition in interface RichIterable<K>

partitionWith

<P> PartitionMutableSet<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)

Description copied from interface: RichIterable

Filters a collection into a PartitionIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
 

Example using an anonymous inner class:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String state)
         {
             return person.getAddress().getState().getName().equals(state);
         }
     }, "New York");
 

Specified by:

partitionWith in interface BiMap<K,V>

Specified by:

partitionWith in interface RichIterable<K>

selectInstancesOf

<S> MutableSet<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: RichIterable

Returns all elements of the source collection that are instances of the Class clazz.

 RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
 

Specified by:

selectInstancesOf in interface BiMap<K,V>

Specified by:

selectInstancesOf in interface MutableMapIterable<K,V>

Specified by:

selectInstancesOf in interface RichIterable<K>

zip

@Deprecated <S> MutableSet<Pair<V,S>> zip(Iterable<S> that)

Deprecated.

in 8.0. Use OrderedIterable.zip(Iterable) instead.

Description copied from interface: RichIterable

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface BiMap<K,V>

Specified by:

zip in interface MutableMapIterable<K,V>

Specified by:

zip in interface RichIterable<K>

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

zipWithIndex

@Deprecated MutableSet<Pair<V,Integer>> zipWithIndex()

Deprecated.

in 8.0. Use OrderedIterable.zipWithIndex() instead.

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface BiMap<K,V>

Specified by:

zipWithIndex in interface MutableMapIterable<K,V>

Specified by:

zipWithIndex in interface RichIterable<K>

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

RichIterable.zip(Iterable)

groupBy

<V1> MutableSetMultimap<V1,V> groupBy(Function<? super V,? extends V1> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

Example using a Java 8 method reference:

 Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
 

Example using an anonymous inner class:

 Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     });
 

Specified by:

groupBy in interface BiMap<K,V>

Specified by:

groupBy in interface MutableMapIterable<K,V>

Specified by:

groupBy in interface RichIterable<K>

groupByEach

<V1> MutableSetMultimap<V1,V> groupByEach(Function<? super V,? extends Iterable<V1>> function)

Description copied from interface: RichIterable

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface BiMap<K,V>

Specified by:

groupByEach in interface MutableMapIterable<K,V>

Specified by:

groupByEach in interface RichIterable<K>

groupByUniqueKey

default <VV> MutableBiMap<VV,V> groupByUniqueKey(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface BiMap<K,V>

Specified by:

groupByUniqueKey in interface MutableMapIterable<K,V>

Specified by:

groupByUniqueKey in interface RichIterable<K>

See Also:

RichIterable.groupBy(Function)

withKeyValue

MutableBiMap<K,V> withKeyValue(K key, V value)

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 the additional key and value. 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.withKeyValue("new key", "new value");
 

In the case of FixedSizeMap, a new instance will be returned by withKeyValue, 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:

withKeyValue in interface MutableMapIterable<K,V>

See Also:

Map.put(Object, Object)

withMap

default MutableBiMap<K,V> withMap(Map<? extends K,? extends V> map)

Description copied from interface: MutableMapIterable

Similar to Map.putAll(Map), but returns this instead of void

Specified by:

withMap in interface MutableMapIterable<K,V>

See Also:

Map.putAll(Map)

withAllKeyValues

MutableBiMap<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 of 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 MutableMapIterable<K,V>

See Also:

Map.put(Object, Object)

withAllKeyValueArguments

MutableBiMap<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)

Description copied from interface: MutableMapIterable

Convenience var-args version of withAllKeyValues

Specified by:

withAllKeyValueArguments in interface MutableMapIterable<K,V>

See Also:

MutableMapIterable.withAllKeyValues(Iterable)

withoutKey

MutableBiMap<K,V> withoutKey(K key)

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 the key and value 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.withoutKey("key");
 

In the case of FixedSizeMap, a new instance will be returned by withoutKey, 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:

withoutKey in interface MutableMapIterable<K,V>

See Also:

Map.remove(Object)

withoutAllKeys

MutableBiMap<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 of 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 MutableMapIterable<K,V>

See Also:

Map.remove(Object)