Package org.eclipse.collections.impl.bimap.mutable

Class HashBiMap<K,V>

java.lang.Object

org.eclipse.collections.impl.bimap.AbstractBiMap<K,V>

org.eclipse.collections.impl.bimap.mutable.HashBiMap<K,V>

All Implemented Interfaces:

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

public class HashBiMap<K,V>
extends AbstractBiMap<K,V>
implements Externalizable

A MutableBiMap which uses two hash tables as its underlying data store.

Since:

4.2

See Also:

• Serialized Form

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
HashBiMap()
HashBiMap(int initialSize)
HashBiMap(Map<K,V> map)

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.
void	clear()
MutableBiMap<K,V>	clone()
<VV> MutableBag<VV>	collect(Function<? super V,? extends VV> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
<K2, V2> HashBiMap<K2,V2>	collect(Function2<? super K,? super V,Pair<K2,V2>> function)	For each key and value of the map the function is evaluated.
MutableBooleanBag	collectBoolean(BooleanFunction<? super V> booleanFunction)	Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
MutableByteBag	collectByte(ByteFunction<? super V> byteFunction)	Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
MutableCharBag	collectChar(CharFunction<? super V> charFunction)	Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
MutableDoubleBag	collectDouble(DoubleFunction<? super V> doubleFunction)	Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
MutableFloatBag	collectFloat(FloatFunction<? super V> floatFunction)	Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<VV> MutableBag<VV>	collectIf(Predicate<? super V> predicate, Function<? super V,? extends VV> function)	Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
MutableIntBag	collectInt(IntFunction<? super V> intFunction)	Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
MutableLongBag	collectLong(LongFunction<? super V> longFunction)	Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
MutableShortBag	collectShort(ShortFunction<? super V> shortFunction)	Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<R> HashBiMap<K,R>	collectValues(Function2<? super K,? super V,? extends R> function)	For each key and value of the map the function is evaluated.
<P, VV> MutableBag<VV>	collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
Set<Map.Entry<K,V>>	entrySet()
<VV> MutableBag<VV>	flatCollect(Function<? super V,? extends Iterable<VV>> function)	flatCollect is a special case of RichIterable.collect(Function).
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 MutableBiMap.put(Object, Object), except that it quietly removes any existing entry with the same value before putting the key-value pair.
void	forEachValue(Procedure<? super V> procedure)	Calls the procedure with each value of the map.
V	getIfAbsentPut(K key, Function0<? extends V> function)	Get and return the value in the Map at the specified key.
V	getIfAbsentPut(K key, V value)	Get and return the value in the Map at the specified key.
<P> V	getIfAbsentPutWith(K key, Function<? super P,? extends V> function, P parameter)	Get and return the value in the Map at the specified key.
V	getIfAbsentPutWithKey(K key, Function<? super K,? extends V> function)	Get and return the value in the Map at the specified key.
<VV> MutableSetMultimap<VV,V>	groupBy(Function<? super V,? extends VV> 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.
<VV> MutableSetMultimap<VV,V>	groupByEach(Function<? super V,? extends Iterable<VV>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<VV> MutableBiMap<VV,V>	groupByUniqueKey(Function<? super V,? extends VV> function)	For each element of the iterable, the function is evaluated, and the 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.
Iterator<V>	iterator()
Set<K>	keySet()
HashBiMap<K,V>	newEmpty()	Creates a new instance of the same type, using the default capacity and growth parameters.
static <K, V> HashBiMap<K,V>	newMap()
static <K, V> HashBiMap<K,V>	newWithKeysValues(K key, V value)
static <K, V> HashBiMap<K,V>	newWithKeysValues(K key1, V value1, K key2, V value2)
static <K, V> HashBiMap<K,V>	newWithKeysValues(K key1, V value1, K key2, V value2, K key3, V value3)
static <K, V> HashBiMap<K,V>	newWithKeysValues(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)
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.
void	putAll(Map<? extends K,? extends V> map)
void	readExternal(ObjectInput in)
MutableSet<V>	reject(Predicate<? super V> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
HashBiMap<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.
V	remove(Object key)
V	removeKey(K key)	Remove an entry from the map at the specified key.
MutableSet<V>	select(Predicate<? super V> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
HashBiMap<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.
<V1> MutableObjectDoubleMap<V1>	sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> MutableObjectDoubleMap<V1>	sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> MutableObjectLongMap<V1>	sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> MutableObjectLongMap<V1>	sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)	Groups and sums the values using the two specified functions.
MutableBiMap<K,V>	tap(Procedure<? super V> procedure)	Executes the Procedure for each value of the map and returns this.
ImmutableBiMap<K,V>	toImmutable()	Converts the BiMap to an ImmutableBiMap.
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.
Collection<V>	values()
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.
HashBiMap<K,V>	withKeysValues(K key, V value)
HashBiMap<K,V>	withKeysValues(K key1, V value1, K key2, V value2)
HashBiMap<K,V>	withKeysValues(K key1, V value1, K key2, V value2, K key3, V value3)
HashBiMap<K,V>	withKeysValues(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)
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.
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.
void	writeExternal(ObjectOutput out)
<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 class org.eclipse.collections.impl.bimap.AbstractBiMap

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsKey, containsValue, count, countWith, detect, detect, detectIfNone, detectOptional, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, equals, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, forEachKey, forEachKeyValue, forEachWith, forEachWithIndex, get, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, getOnly, getOrDefault, groupBy, groupByEach, groupByUniqueKey, hashCode, ifPresentApply, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, keysView, keyValuesView, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedList, toSortedList, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toString, valuesView, zip, zipWithIndex

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

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

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size

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

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

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

aggregateBy, aggregateBy, withMap, withMapIterable

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

add, aggregateInPlaceBy, countBy, countByEach, countByWith, getOrDefault, putAllMapIterable, putPair, removeAllKeys, removeIf

Methods inherited from interface org.eclipse.collections.api.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, 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, 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

Constructor Details

HashBiMap

public HashBiMap()

HashBiMap

public HashBiMap(int initialSize)

HashBiMap

public HashBiMap(Map<K,V> map)

Method Details

newMap

public static <K,
V> HashBiMap<K,V> newMap()

newWithKeysValues

public static <K,
V> HashBiMap<K,V> newWithKeysValues(K key,
 V value)

newWithKeysValues

public static <K,
V> HashBiMap<K,V> newWithKeysValues(K key1,
 V value1,
 K key2,
 V value2)

newWithKeysValues

public static <K,
V> HashBiMap<K,V> newWithKeysValues(K key1,
 V value1,
 K key2,
 V value2,
 K key3,
 V value3)

newWithKeysValues

public static <K,
V> HashBiMap<K,V> newWithKeysValues(K key1,
 V value1,
 K key2,
 V value2,
 K key3,
 V value3,
 K key4,
 V value4)

withKeysValues

public HashBiMap<K,V> withKeysValues(K key,
 V value)

withKeysValues

public HashBiMap<K,V> withKeysValues(K key1,
 V value1,
 K key2,
 V value2)

withKeysValues

public HashBiMap<K,V> withKeysValues(K key1,
 V value1,
 K key2,
 V value2,
 K key3,
 V value3)

withKeysValues

public HashBiMap<K,V> withKeysValues(K key1,
 V value1,
 K key2,
 V value2,
 K key3,
 V value3,
 K key4,
 V value4)

newEmpty

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

Specified by:

newEmpty in interface MutableMapIterable<K,V>

withKeyValue

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

Specified by:

withKeyValue in interface MutableMapIterable<K,V>

See Also:

• Map.put(Object, Object)

withAllKeyValues

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

Specified by:

withAllKeyValues in interface MutableMapIterable<K,V>

See Also:

• Map.put(Object, Object)

withAllKeyValueArguments

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

Specified by:

withAllKeyValueArguments in interface MutableMapIterable<K,V>

See Also:

• MutableMapIterable.withAllKeyValues(Iterable)

withoutKey

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

Specified by:

withoutKey in interface MutableMapIterable<K,V>

See Also:

• Map.remove(Object)

withoutAllKeys

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

Specified by:

withoutAllKeys in interface MutableMapIterable<K,V>

See Also:

• Map.remove(Object)

inverse

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

Specified by:

inverse in interface MutableBiMap<K,V>

flip

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

Specified by:

flip in interface MutableMapIterable<K,V>

flipUniqueValues

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

Specified by:

flipUniqueValues in interface MutableMapIterable<K,V>

put

public V put(K key,
 V value)

Description copied from interface: MutableBiMap

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>

Specified by:

put in interface MutableBiMap<K,V>

forcePut

public V forcePut(K key,
 V value)

Description copied from interface: MutableBiMap

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

Specified by:

forcePut in interface MutableBiMap<K,V>

putAll

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

Specified by:

putAll in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

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

Returns:

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

See Also:

• Map.remove(Object)

clear

public void clear()

Specified by:

clear in interface Map<K,V>

getIfAbsentPut

public V getIfAbsentPut(K key,
 V value)

Description copied from interface: MutableMapIterable

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the specified value, and put that value in the map at the specified key.

Specified by:

getIfAbsentPut in interface MutableMapIterable<K,V>

getIfAbsentPut

public V getIfAbsentPut(K key,
 Function0<? extends V> function)

Description copied from interface: MutableMapIterable

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the result of evaluating the specified Function0, and put that value in the map at the specified key.

Specified by:

getIfAbsentPut in interface MutableMapIterable<K,V>

getIfAbsentPutWith

public <P> V getIfAbsentPutWith(K key,
 Function<? super P,? extends V> function,
 P parameter)

Description copied from interface: MutableMapIterable

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified parameter, and put that value in the map at the specified key.

Specified by:

getIfAbsentPutWith in interface MutableMapIterable<K,V>

getIfAbsentPutWithKey

public V getIfAbsentPutWithKey(K key,
 Function<? super K,? extends V> function)

Description copied from interface: MutableMapIterable

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified key, and put that value in the map at the specified key.

Specified by:

getIfAbsentPutWithKey in interface MutableMapIterable<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>

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>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<K>

toImmutable

public ImmutableBiMap<K,V> toImmutable()

Description copied from interface: BiMap

Converts the BiMap to an ImmutableBiMap. If the bimap is immutable, it returns itself.

Specified by:

toImmutable in interface BiMap<K,V>

Specified by:

toImmutable in interface MapIterable<K,V>

Specified by:

toImmutable in interface MutableMapIterable<K,V>

asSynchronized

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

Specified by:

asSynchronized in interface MutableMapIterable<K,V>

See Also:

• Collections.synchronizedMap(Map)

asUnmodifiable

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

Specified by:

asUnmodifiable in interface MutableMapIterable<K,V>

Returns:

an unmodifiable view of this map.

See Also:

• Collections.unmodifiableMap(Map)

clone

public MutableBiMap<K,V> clone()

Specified by:

clone in interface MutableBiMap<K,V>

tap

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

Specified by:

tap in interface MutableMapIterable<K,V>

Specified by:

tap in interface RichIterable<K>

See Also:

• RichIterable.forEach(Procedure)

select

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

Specified by:

select in interface MutableMapIterable<K,V>

reject

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

Specified by:

reject in interface MutableMapIterable<K,V>

collect

public <K2,
V2> HashBiMap<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 MutableBiMap.put(Object, Object), ImmutableBiMap.newWithKeyValue(Object, Object), or equivalent, not MutableBiMap.forcePut(Object, Object).

Specified by:

collect in interface BiMap<K,V>

Specified by:

collect in interface MapIterable<K,V>

Specified by:

collect in interface MutableBiMap<K,V>

Specified by:

collect in interface MutableMapIterable<K,V>

collectValues

public <R> HashBiMap<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 MutableBiMap.put(Object, Object), ImmutableBiMap.newWithKeyValue(Object, Object), or equivalent, not MutableBiMap.forcePut(Object, Object).

Specified by:

collectValues in interface BiMap<K,V>

Specified by:

collectValues in interface MapIterable<K,V>

Specified by:

collectValues in interface MutableBiMap<K,V>

Specified by:

collectValues in interface MutableMapIterable<K,V>

collect

public <VV> MutableBag<VV> collect(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 RichIterable<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName());
 

Example using an anonymous inner class:

 RichIterable<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     });
 

Specified by:

collect in interface RichIterable<K>

collectWith

public <P,
VV> MutableBag<VV> collectWith(Function2<? super V,? super P,? extends VV> function,
 P parameter)

Description copied from interface: RichIterable

Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
 

Example using an anonymous inner class:

 Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(Integer each, Integer parameter)
         {
             return each + parameter;
         }
     };
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 

Specified by:

collectWith in interface RichIterable<K>

Parameters:

function - A Function2 to use as the collect transformation function

parameter - A parameter to pass in for evaluation of the second argument P in function

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

• RichIterable.collect(Function)

flatCollect

public <VV> MutableBag<VV> flatCollect(Function<? super V,? extends Iterable<VV>> function)

Description copied from interface: RichIterable

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

 Function<Person, List<Address>> addressFunction = Person::getAddresses;
 RichIterable<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

 RichIterable<List<Address>> addresses = people.collect(addressFunction);
 

Using flatCollect returns a single flattened list of addresses.

 RichIterable<Address> addresses = people.flatCollect(addressFunction);
 

Specified by:

flatCollect in interface RichIterable<K>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

collectBoolean

public MutableBooleanBag collectBoolean(BooleanFunction<? super V> booleanFunction)

Description copied from interface: RichIterable

Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 BooleanIterable licenses =
     people.collectBoolean(person -> person.hasDrivingLicense());
 

Example using an anonymous inner class:

 BooleanIterable licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     });
 

Specified by:

collectBoolean in interface RichIterable<K>

collectByte

public MutableByteBag collectByte(ByteFunction<? super V> byteFunction)

Description copied from interface: RichIterable

Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 ByteIterable bytes =
     people.collectByte(person -> person.getCode());
 

Example using an anonymous inner class:

 ByteIterable bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     });
 

Specified by:

collectByte in interface RichIterable<K>

collectChar

public MutableCharBag collectChar(CharFunction<? super V> charFunction)

Description copied from interface: RichIterable

Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 CharIterable chars =
     people.collectChar(person -> person.getMiddleInitial());
 

Example using an anonymous inner class:

 CharIterable chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     });
 

Specified by:

collectChar in interface RichIterable<K>

collectDouble

public MutableDoubleBag collectDouble(DoubleFunction<? super V> doubleFunction)

Description copied from interface: RichIterable

Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 DoubleIterable doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole());
 

Example using an anonymous inner class:

 DoubleIterable doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     });
 

Specified by:

collectDouble in interface RichIterable<K>

collectFloat

public MutableFloatBag collectFloat(FloatFunction<? super V> floatFunction)

Description copied from interface: RichIterable

Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 FloatIterable floats =
     people.collectFloat(person -> person.getHeightInInches());
 

Example using an anonymous inner class:

 FloatIterable floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     });
 

Specified by:

collectFloat in interface RichIterable<K>

collectInt

public MutableIntBag collectInt(IntFunction<? super V> intFunction)

Description copied from interface: RichIterable

Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 IntIterable ints =
     people.collectInt(person -> person.getAge());
 

Example using an anonymous inner class:

 IntIterable ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     });
 

Specified by:

collectInt in interface RichIterable<K>

collectLong

public MutableLongBag collectLong(LongFunction<? super V> longFunction)

Description copied from interface: RichIterable

Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 LongIterable longs =
     people.collectLong(person -> person.getGuid());
 

Example using an anonymous inner class:

 LongIterable longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     });
 

Specified by:

collectLong in interface RichIterable<K>

collectShort

public MutableShortBag collectShort(ShortFunction<? super V> shortFunction)

Description copied from interface: RichIterable

Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

 ShortIterable shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
 

Example using an anonymous inner class:

 ShortIterable shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth();
         }
     });
 

Specified by:

collectShort in interface RichIterable<K>

collectIf

public <VV> MutableBag<VV> collectIf(Predicate<? super V> predicate,
 Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the optimized equivalent of calling iterable.select(predicate).collect(function).

Example using a Java 8 lambda and method reference:

 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
 

Example using Predicates factory:

 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
 

Specified by:

collectIf in interface RichIterable<K>

zipWithIndex

@Deprecated
public 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 MutableBiMap<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

public <VV> MutableSetMultimap<VV,V> groupBy(Function<? super V,? extends VV> 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 MutableBiMap<K,V>

Specified by:

groupBy in interface MutableMapIterable<K,V>

Specified by:

groupBy in interface RichIterable<K>

groupByEach

public <VV> MutableSetMultimap<VV,V> groupByEach(Function<? super V,? extends Iterable<VV>> 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 MutableBiMap<K,V>

Specified by:

groupByEach in interface MutableMapIterable<K,V>

Specified by:

groupByEach in interface RichIterable<K>

zip

@Deprecated
public <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 MutableBiMap<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.

select

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

Specified by:

select in interface MutableMapIterable<K,V>

Specified by:

select in interface RichIterable<K>

selectWith

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

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

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

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

Specified by:

partition in interface MutableMapIterable<K,V>

Specified by:

partition in interface RichIterable<K>

partitionWith

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

Specified by:

partitionWith in interface RichIterable<K>

forEachValue

public void forEachValue(Procedure<? super V> procedure)

Description copied from interface: MapIterable

Calls the procedure with each value of the map.

     Set<String> result = UnifiedSet.newSet();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three", 4, "Four");
     map.forEachValue(new CollectionAddProcedure<String>(result));
     Verify.assertSetsEqual(UnifiedSet.newSetWith("One", "Two", "Three", "Four"), result);
 

Specified by:

forEachValue in interface MapIterable<K,V>

Overrides:

forEachValue in class AbstractBiMap<K,V>

groupByUniqueKey

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

Specified by:

groupByUniqueKey in interface MutableMapIterable<K,V>

Specified by:

groupByUniqueKey in interface RichIterable<K>

See Also:

• RichIterable.groupBy(Function)

sumByInt

public <V1> MutableObjectLongMap<V1> sumByInt(Function<? super V,? extends V1> groupBy,
 IntFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface MutableMapIterable<K,V>

Specified by:

sumByInt in interface RichIterable<K>

sumByFloat

public <V1> MutableObjectDoubleMap<V1> sumByFloat(Function<? super V,? extends V1> groupBy,
 FloatFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByFloat in interface MutableMapIterable<K,V>

Specified by:

sumByFloat in interface RichIterable<K>

sumByLong

public <V1> MutableObjectLongMap<V1> sumByLong(Function<? super V,? extends V1> groupBy,
 LongFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface MutableMapIterable<K,V>

Specified by:

sumByLong in interface RichIterable<K>

sumByDouble

public <V1> MutableObjectDoubleMap<V1> sumByDouble(Function<? super V,? extends V1> groupBy,
 DoubleFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByDouble in interface MutableMapIterable<K,V>

Specified by:

sumByDouble in interface RichIterable<K>

selectInstancesOf

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

Specified by:

selectInstancesOf in interface MutableMapIterable<K,V>

Specified by:

selectInstancesOf in interface RichIterable<K>

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException