com.gs.collections.impl.bimap.mutable

Class HashBiMap<K,V>

java.lang.Object

com.gs.collections.impl.bimap.AbstractBiMap<K,V>

com.gs.collections.impl.bimap.mutable.HashBiMap<K,V>

All Implemented Interfaces:

com.gs.collections.api.bimap.BiMap<K,V>, com.gs.collections.api.bimap.MutableBiMap<K,V>, com.gs.collections.api.InternalIterable<V>, com.gs.collections.api.map.MapIterable<K,V>, com.gs.collections.api.map.MutableMapIterable<K,V>, com.gs.collections.api.RichIterable<V>, java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<V>, java.util.Map<K,V>

public class HashBiMap<K,V>
extends AbstractBiMap<K,V>
implements java.io.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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
HashBiMap()
HashBiMap(int initialSize)
HashBiMap(java.util.Map<K,V> map)

Method Summary

Methods

Modifier and Type	Method and Description
V	add(com.gs.collections.api.tuple.Pair<K,V> keyValuePair) This method allows mutable map the ability to add an element in the form of Pair.
<K2,V2> com.gs.collections.api.map.MutableMap<K2,V2>	aggregateBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy, com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory, com.gs.collections.api.block.function.Function2<? super V2,? super V,? extends V2> nonMutatingAggregator) Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
<K2,V2> com.gs.collections.api.map.MutableMap<K2,V2>	aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy, com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory, com.gs.collections.api.block.procedure.Procedure2<? super V2,? super V> mutatingAggregator) Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
com.gs.collections.api.bimap.MutableBiMap<K,V>	asSynchronized() Returns a synchronized (thread-safe) map backed by the specified map.
com.gs.collections.api.bimap.MutableBiMap<K,V>	asUnmodifiable() Returns an unmodifiable view of this map.
void	clear()
com.gs.collections.api.bimap.MutableBiMap<K,V>	clone()
<VV> com.gs.collections.api.bag.MutableBag<VV>	collect(com.gs.collections.api.block.function.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(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function) For each key and value of the map the function is evaluated.
com.gs.collections.api.bag.primitive.MutableBooleanBag	collectBoolean(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.bag.primitive.MutableByteBag	collectByte(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.bag.primitive.MutableCharBag	collectChar(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.bag.primitive.MutableDoubleBag	collectDouble(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.bag.primitive.MutableFloatBag	collectFloat(com.gs.collections.api.block.function.primitive.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> com.gs.collections.api.bag.MutableBag<VV>	collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, com.gs.collections.api.block.function.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.
com.gs.collections.api.bag.primitive.MutableIntBag	collectInt(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.bag.primitive.MutableLongBag	collectLong(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.bag.primitive.MutableShortBag	collectShort(com.gs.collections.api.block.function.primitive.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(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function) For each key and value of the map the function is evaluated.
<P,VV> com.gs.collections.api.bag.MutableBag<VV>	collectWith(com.gs.collections.api.block.function.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.
java.util.Set<java.util.Map.Entry<K,V>>	entrySet()
<VV> com.gs.collections.api.bag.MutableBag<VV>	flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<VV>> function) flatCollect is a special case of RichIterable.collect(Function).
com.gs.collections.api.multimap.set.MutableSetMultimap<V,K>	flip() Given a map from Domain -> Range return a multimap from Range -> Domain.
com.gs.collections.api.bimap.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(com.gs.collections.api.block.procedure.Procedure<? super V> procedure) Calls the procedure with each value of the map.
protected UnifiedMap<K,V>	getDelegate()
V	getIfAbsentPut(K key, com.gs.collections.api.block.function.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, com.gs.collections.api.block.function.Function<? super P,? extends V> function, P parameter) Get and return the value in the Map at the specified key.
V	getIfAbsentPutWithKey(K key, com.gs.collections.api.block.function.Function<? super K,? extends V> function) Get and return the value in the Map at the specified key.
protected UnifiedMap<V,K>	getInverse()
<VV> com.gs.collections.api.multimap.set.MutableSetMultimap<VV,V>	groupBy(com.gs.collections.api.block.function.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> com.gs.collections.api.multimap.set.MutableSetMultimap<VV,V>	groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<VV>> function) Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<VV> com.gs.collections.api.bimap.MutableBiMap<VV,V>	groupByUniqueKey(com.gs.collections.api.block.function.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.
com.gs.collections.api.bimap.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.
java.util.Iterator<V>	iterator()
java.util.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)
com.gs.collections.api.partition.set.PartitionMutableSet<V>	partition(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> com.gs.collections.api.partition.set.PartitionMutableSet<V>	partitionWith(com.gs.collections.api.block.predicate.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(java.util.Map<? extends K,? extends V> map)
void	readExternal(java.io.ObjectInput in)
com.gs.collections.api.set.MutableSet<V>	reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns all elements of the source collection that return false when evaluating of the predicate.
HashBiMap<K,V>	reject(com.gs.collections.api.block.predicate.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> com.gs.collections.api.set.MutableSet<V>	rejectWith(com.gs.collections.api.block.predicate.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(java.lang.Object key)
V	removeKey(K key) Remove an entry from the map at the specified key.
com.gs.collections.api.set.MutableSet<V>	select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns all elements of the source collection that return true when evaluating the predicate.
HashBiMap<K,V>	select(com.gs.collections.api.block.predicate.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> com.gs.collections.api.set.MutableSet<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> com.gs.collections.api.set.MutableSet<V>	selectWith(com.gs.collections.api.block.predicate.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.
com.gs.collections.api.bimap.MutableBiMap<K,V>	tap(com.gs.collections.api.block.procedure.Procedure<? super V> procedure) Executes the Procedure for each value of the map and returns this.
com.gs.collections.api.bimap.ImmutableBiMap<K,V>	toImmutable() Converts the BiMap to an ImmutableBiMap.
V	updateValue(K key, com.gs.collections.api.block.function.Function0<? extends V> factory, com.gs.collections.api.block.function.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, com.gs.collections.api.block.function.Function0<? extends V> factory, com.gs.collections.api.block.function.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.
java.util.Collection<V>	values()
com.gs.collections.api.bimap.MutableBiMap<K,V>	withAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs) Convenience var-args version of withAllKeyValues
com.gs.collections.api.bimap.MutableBiMap<K,V>	withAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.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)
com.gs.collections.api.bimap.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.
com.gs.collections.api.bimap.MutableBiMap<K,V>	withoutAllKeys(java.lang.Iterable<? extends K> keys) This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.
com.gs.collections.api.bimap.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(java.io.ObjectOutput out)
<S> com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<V,S>>	zip(java.lang.Iterable<S> that) Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.

Methods inherited from class com.gs.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, detectWith, detectWithIfNone, each, equals, flatCollect, forEach, forEachKey, forEachKeyValue, forEachWith, forEachWithIndex, get, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, groupBy, groupByEach, groupByUniqueKey, hashCode, ifPresentApply, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, keysView, keyValuesView, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, valuesView, zip, zipWithIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Methods inherited from interface com.gs.collections.api.map.MapIterable

containsKey, containsValue, detect, equals, forEachKey, forEachKeyValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, toString, valuesView

Methods inherited from interface com.gs.collections.api.RichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, each, flatCollect, getFirst, getLast, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable

forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, hashCode, isEmpty, size

Constructor Detail

HashBiMap

public HashBiMap()

HashBiMap

public HashBiMap(int initialSize)

HashBiMap

public HashBiMap(java.util.Map<K,V> map)

Method Detail

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)

getDelegate

protected UnifiedMap<K,V> getDelegate()

Specified by:

getDelegate in class AbstractBiMap<K,V>

getInverse

protected UnifiedMap<V,K> getInverse()

Specified by:

getInverse in class AbstractBiMap<K,V>

newEmpty

public HashBiMap<K,V> newEmpty()

Description copied from interface: com.gs.collections.api.map.MutableMapIterable

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

Specified by:

newEmpty in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

newEmpty in interface com.gs.collections.api.map.MutableMapIterable<K,V>

withKeyValue

public com.gs.collections.api.bimap.MutableBiMap<K,V> withKeyValue(K key,
                                                          V value)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

withKeyValue in interface com.gs.collections.api.map.MutableMapIterable<K,V>

See Also:

Map.put(Object, Object)

withAllKeyValues

public com.gs.collections.api.bimap.MutableBiMap<K,V> withAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

withAllKeyValues in interface com.gs.collections.api.map.MutableMapIterable<K,V>

See Also:

Map.put(Object, Object)

withAllKeyValueArguments

public com.gs.collections.api.bimap.MutableBiMap<K,V> withAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs)

Description copied from interface: com.gs.collections.api.map.MutableMapIterable

Convenience var-args version of withAllKeyValues

Specified by:

withAllKeyValueArguments in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

withAllKeyValueArguments in interface com.gs.collections.api.map.MutableMapIterable<K,V>

See Also:

MutableMapIterable.withAllKeyValues(Iterable)

withoutKey

public com.gs.collections.api.bimap.MutableBiMap<K,V> withoutKey(K key)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

withoutKey in interface com.gs.collections.api.map.MutableMapIterable<K,V>

See Also:

Map.remove(Object)

withoutAllKeys

public com.gs.collections.api.bimap.MutableBiMap<K,V> withoutAllKeys(java.lang.Iterable<? extends K> keys)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

withoutAllKeys in interface com.gs.collections.api.map.MutableMapIterable<K,V>

See Also:

Map.remove(Object)

inverse

public com.gs.collections.api.bimap.MutableBiMap<V,K> inverse()

Description copied from interface: com.gs.collections.api.bimap.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

inverse in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

flip

public com.gs.collections.api.multimap.set.MutableSetMultimap<V,K> flip()

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

flip in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

flip in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

flip in interface com.gs.collections.api.map.MutableMapIterable<K,V>

flipUniqueValues

public com.gs.collections.api.bimap.MutableBiMap<V,K> flipUniqueValues()

Description copied from interface: com.gs.collections.api.map.MapIterable

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

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

Specified by:

flipUniqueValues in interface com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

flipUniqueValues in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

flipUniqueValues in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

flipUniqueValues in interface com.gs.collections.api.map.MutableMapIterable<K,V>

put

public V put(K key,
    V value)

Description copied from interface: com.gs.collections.api.bimap.MutableBiMap

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

Specified by:

put in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

put in interface java.util.Map<K,V>

forcePut

public V forcePut(K key,
         V value)

Description copied from interface: com.gs.collections.api.bimap.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 com.gs.collections.api.bimap.MutableBiMap<K,V>

putAll

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

Specified by:

putAll in interface java.util.Map<K,V>

add

public V add(com.gs.collections.api.tuple.Pair<K,V> keyValuePair)

Description copied from interface: com.gs.collections.api.map.MutableMapIterable

This method allows mutable map the ability to add an element in the form of Pair.

Specified by:

add in interface com.gs.collections.api.map.MutableMapIterable<K,V>

See Also:

Map.put(Object, Object)

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K,V>

removeKey

public V removeKey(K key)

Description copied from interface: com.gs.collections.api.map.MutableMapIterable

Remove an entry from the map at the specified key.

Specified by:

removeKey in interface com.gs.collections.api.map.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 java.util.Map<K,V>

getIfAbsentPut

public V getIfAbsentPut(K key,
               V value)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MutableMapIterable<K,V>

getIfAbsentPut

public V getIfAbsentPut(K key,
               com.gs.collections.api.block.function.Function0<? extends V> function)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MutableMapIterable<K,V>

getIfAbsentPutWith

public <P> V getIfAbsentPutWith(K key,
                       com.gs.collections.api.block.function.Function<? super P,? extends V> function,
                       P parameter)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MutableMapIterable<K,V>

getIfAbsentPutWithKey

public V getIfAbsentPutWithKey(K key,
                      com.gs.collections.api.block.function.Function<? super K,? extends V> function)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MutableMapIterable<K,V>

updateValue

public V updateValue(K key,
            com.gs.collections.api.block.function.Function0<? extends V> factory,
            com.gs.collections.api.block.function.Function<? super V,? extends V> function)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MutableMapIterable<K,V>

updateValueWith

public <P> V updateValueWith(K key,
                    com.gs.collections.api.block.function.Function0<? extends V> factory,
                    com.gs.collections.api.block.function.Function2<? super V,? super P,? extends V> function,
                    P parameter)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MutableMapIterable<K,V>

keySet

public java.util.Set<K> keySet()

Specified by:

keySet in interface java.util.Map<K,V>

values

public java.util.Collection<V> values()

Specified by:

values in interface java.util.Map<K,V>

entrySet

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

Specified by:

entrySet in interface java.util.Map<K,V>

iterator

public java.util.Iterator<V> iterator()

Specified by:

iterator in interface java.lang.Iterable<V>

toImmutable

public com.gs.collections.api.bimap.ImmutableBiMap<K,V> toImmutable()

Description copied from interface: com.gs.collections.api.bimap.BiMap

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

Specified by:

toImmutable in interface com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

toImmutable in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

toImmutable in interface com.gs.collections.api.map.MutableMapIterable<K,V>

asSynchronized

public com.gs.collections.api.bimap.MutableBiMap<K,V> asSynchronized()

Description copied from interface: com.gs.collections.api.map.MutableMapIterable

Returns a synchronized (thread-safe) map backed by the specified map. In order to guarantee serial access, it is critical that all access to the backing map is accomplished through the returned map.

It is imperative that the user manually synchronize on the returned map when iterating over any of its collection views:

  MutableMap map = myMutableMap.asSynchronized();
      ...
  Set set = map.keySet();  // Needn't be in synchronized block
      ...
  synchronized(map)
  {  // Synchronizing on map, not set!
      Iterator i = s.iterator(); // Must be in synchronized block
      while (i.hasNext())
          foo(i.next());
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.

  MutableMap map = myMutableMap.asSynchronized();
      ...
  Set set = map.keySet();  // Needn't be in synchronized block
     ...
  Iterate.forEach(set, new Procedure()
  {
      public void value(Object each)
      {
          ...
      }
  });
 

The returned map will be serializable if the specified map is serializable.

Specified by:

asSynchronized in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

asSynchronized in interface com.gs.collections.api.map.MutableMapIterable<K,V>

asUnmodifiable

public com.gs.collections.api.bimap.MutableBiMap<K,V> asUnmodifiable()

Description copied from interface: com.gs.collections.api.map.MutableMapIterable

Returns an unmodifiable view of this map. This method allows modules to provide users with "read-only" access to internal maps. Any query operations on the returned map that "read through" to this map and attempt to modify the returned map, whether direct or via its iterator, result in an UnsupportedOperationException. The returned map will be Serializable if this map is Serializable.

Specified by:

asUnmodifiable in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

asUnmodifiable in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Returns:

an unmodifiable view of this map.

clone

public com.gs.collections.api.bimap.MutableBiMap<K,V> clone()

Specified by:

clone in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Overrides:

clone in class java.lang.Object

tap

public com.gs.collections.api.bimap.MutableBiMap<K,V> tap(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)

Description copied from interface: com.gs.collections.api.map.MapIterable

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

e.g.
 return peopleByCity.tap(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

Specified by:

tap in interface com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

tap in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

tap in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

tap in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

tap in interface com.gs.collections.api.RichIterable<V>

See Also:

InternalIterable.forEach(Procedure)

select

public HashBiMap<K,V> select(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)

Description copied from interface: com.gs.collections.api.map.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.

e.g.
 peopleByCity.select(new Predicate2<City, Person>()
 {
     public boolean accept(City city, Person person)
     {
         return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
     }
 });
 

Specified by:

select in interface com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

select in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

select in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

select in interface com.gs.collections.api.map.MutableMapIterable<K,V>

reject

public HashBiMap<K,V> reject(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)

Description copied from interface: com.gs.collections.api.map.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.

e.g.
 peopleByCity.reject(new Predicate2<City, Person>()
 {
     public boolean accept(City city, Person person)
     {
         return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
     }
 });
 

Specified by:

reject in interface com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

reject in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

reject in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

reject in interface com.gs.collections.api.map.MutableMapIterable<K,V>

collect

public <K2,V2> HashBiMap<K2,V2> collect(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function)

Description copied from interface: com.gs.collections.api.bimap.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.

e.g.
 peopleByCity.collect(new Function2<City, Person, String>()
 {
     public String value(City city, Person person)
     {
         return 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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

collect in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

collect in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

collect in interface com.gs.collections.api.map.MutableMapIterable<K,V>

collectValues

public <R> HashBiMap<K,R> collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function)

Description copied from interface: com.gs.collections.api.bimap.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.

e.g.
 peopleByCity.collectValues(new Function2<City, Person, String>()
 {
     public String value(City city, Person person)
     {
         return 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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

collectValues in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

collectValues in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

collectValues in interface com.gs.collections.api.map.MutableMapIterable<K,V>

collect

public <VV> com.gs.collections.api.bag.MutableBag<VV> collect(com.gs.collections.api.block.function.Function<? super V,? extends VV> function)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

collectWith

public <P,VV> com.gs.collections.api.bag.MutableBag<VV> collectWith(com.gs.collections.api.block.function.Function2<? super V,? super P,? extends VV> function,
                                                           P parameter)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

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> com.gs.collections.api.bag.MutableBag<VV> flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<VV>> function)

Description copied from interface: com.gs.collections.api.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;
 MutableList<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

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

Using flatCollect returns a single flattened list of addresses.

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

Specified by:

flatCollect in interface com.gs.collections.api.RichIterable<V>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

collectBoolean

public com.gs.collections.api.bag.primitive.MutableBooleanBag collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super V> booleanFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

collectByte

public com.gs.collections.api.bag.primitive.MutableByteBag collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super V> byteFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

collectChar

public com.gs.collections.api.bag.primitive.MutableCharBag collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super V> charFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

collectDouble

public com.gs.collections.api.bag.primitive.MutableDoubleBag collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> doubleFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

collectFloat

public com.gs.collections.api.bag.primitive.MutableFloatBag collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> floatFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

collectInt

public com.gs.collections.api.bag.primitive.MutableIntBag collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> intFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

collectLong

public com.gs.collections.api.bag.primitive.MutableLongBag collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> longFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

collectShort

public com.gs.collections.api.bag.primitive.MutableShortBag collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super V> shortFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.RichIterable<V>

collectIf

public <VV> com.gs.collections.api.bag.MutableBag<VV> collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
                                                       com.gs.collections.api.block.function.Function<? super V,? extends VV> function)

Description copied from interface: com.gs.collections.api.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 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 com.gs.collections.api.RichIterable<V>

zipWithIndex

public com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>> zipWithIndex()

Description copied from interface: com.gs.collections.api.RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

zipWithIndex in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

zipWithIndex in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

zipWithIndex in interface com.gs.collections.api.RichIterable<V>

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> com.gs.collections.api.multimap.set.MutableSetMultimap<VV,V> groupBy(com.gs.collections.api.block.function.Function<? super V,? extends VV> function)

Description copied from interface: com.gs.collections.api.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 value(Person person)
         {
             return person.getLastName();
         }
     });
 

Specified by:

groupBy in interface com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

groupBy in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

groupBy in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

groupBy in interface com.gs.collections.api.RichIterable<V>

groupByEach

public <VV> com.gs.collections.api.multimap.set.MutableSetMultimap<VV,V> groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<VV>> function)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

groupByEach in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

groupByEach in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

groupByEach in interface com.gs.collections.api.RichIterable<V>

zip

public <S> com.gs.collections.api.set.MutableSet<com.gs.collections.api.tuple.Pair<V,S>> zip(java.lang.Iterable<S> that)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

zip in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

zip in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

zip in interface com.gs.collections.api.RichIterable<V>

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 com.gs.collections.api.set.MutableSet<V> select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

select in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

select in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

select in interface com.gs.collections.api.RichIterable<V>

selectWith

public <P> com.gs.collections.api.set.MutableSet<V> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                      P parameter)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

selectWith in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

selectWith in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

selectWith in interface com.gs.collections.api.RichIterable<V>

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 com.gs.collections.api.set.MutableSet<V> reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

reject in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

reject in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

reject in interface com.gs.collections.api.RichIterable<V>

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> com.gs.collections.api.set.MutableSet<V> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                      P parameter)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

rejectWith in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

rejectWith in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

rejectWith in interface com.gs.collections.api.RichIterable<V>

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 com.gs.collections.api.partition.set.PartitionMutableSet<V> partition(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

partition in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

partition in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

partition in interface com.gs.collections.api.RichIterable<V>

partitionWith

public <P> com.gs.collections.api.partition.set.PartitionMutableSet<V> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                                            P parameter)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

partitionWith in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

partitionWith in interface com.gs.collections.api.RichIterable<V>

forEachValue

public void forEachValue(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MapIterable<K,V>

Overrides:

forEachValue in class AbstractBiMap<K,V>

groupByUniqueKey

public <VV> com.gs.collections.api.bimap.MutableBiMap<VV,V> groupByUniqueKey(com.gs.collections.api.block.function.Function<? super V,? extends VV> function)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

groupByUniqueKey in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

groupByUniqueKey in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

groupByUniqueKey in interface com.gs.collections.api.RichIterable<V>

See Also:

RichIterable.groupBy(Function)

aggregateBy

public <K2,V2> com.gs.collections.api.map.MutableMap<K2,V2> aggregateBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy,
                                                               com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory,
                                                               com.gs.collections.api.block.function.Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)

Description copied from interface: com.gs.collections.api.RichIterable

Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).

Specified by:

aggregateBy in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

aggregateBy in interface com.gs.collections.api.RichIterable<V>

aggregateInPlaceBy

public <K2,V2> com.gs.collections.api.map.MutableMap<K2,V2> aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy,
                                                                      com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory,
                                                                      com.gs.collections.api.block.procedure.Procedure2<? super V2,? super V> mutatingAggregator)

Description copied from interface: com.gs.collections.api.RichIterable

Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).

Specified by:

aggregateInPlaceBy in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

aggregateInPlaceBy in interface com.gs.collections.api.RichIterable<V>

selectInstancesOf

public <S> com.gs.collections.api.set.MutableSet<S> selectInstancesOf(java.lang.Class<S> clazz)

Description copied from interface: com.gs.collections.api.RichIterable

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

Specified by:

selectInstancesOf in interface com.gs.collections.api.bimap.BiMap<K,V>

Specified by:

selectInstancesOf in interface com.gs.collections.api.bimap.MutableBiMap<K,V>

Specified by:

selectInstancesOf in interface com.gs.collections.api.map.MutableMapIterable<K,V>

Specified by:

selectInstancesOf in interface com.gs.collections.api.RichIterable<V>

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException