public class HashBiMap<K,V> extends AbstractBiMap<K,V> implements Externalizable
MutableBiMap
which uses two hash tables as its underlying data store.Constructor and Description |
---|
HashBiMap() |
HashBiMap(int initialSize) |
HashBiMap(Map<K,V> map) |
Modifier and Type | Method and Description |
---|---|
V |
add(Pair<K,V> keyValuePair)
This method allows mutable map the ability to add an element in the form of Pair
|
<K2,V2> MutableMap<K2,V2> |
aggregateBy(Function<? super V,? extends K2> groupBy,
Function0<? extends V2> zeroValueFactory,
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> MutableMap<K2,V2> |
aggregateInPlaceBy(Function<? super V,? extends K2> groupBy,
Function0<? extends V2> zeroValueFactory,
Procedure2<? super V2,? super V> mutatingAggregator)
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
|
MutableBiMap<K,V> |
asSynchronized()
Returns a synchronized (thread-safe) map backed by the specified 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 he results of these evaluations are collected
into a new map, where the transformed value is the key.
|
MutableBiMap<V,K> |
inverse()
Returns an inversed view of this BiMap, where the associations are in the direction of this bimap's values to keys.
|
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 . |
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)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
MutableSet<Pair<V,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
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
readExternal, writeExternal
containsKey, containsValue, detect, equals, forEachKey, forEachKeyValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, toString, valuesView
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
forEach, forEachWith, forEachWithIndex
forEach, spliterator
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size
public static <K,V> HashBiMap<K,V> newMap()
public static <K,V> HashBiMap<K,V> newWithKeysValues(K key, V value)
public static <K,V> HashBiMap<K,V> newWithKeysValues(K key1, V value1, K key2, V value2)
public static <K,V> HashBiMap<K,V> newWithKeysValues(K key1, V value1, K key2, V value2, K key3, V value3)
public static <K,V> HashBiMap<K,V> newWithKeysValues(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)
public HashBiMap<K,V> withKeysValues(K key1, V value1, K key2, V value2, K key3, V value3)
public HashBiMap<K,V> withKeysValues(K key1, V value1, K key2, V value2, K key3, V value3, K key4, V value4)
public HashBiMap<K,V> newEmpty()
MutableMapIterable
newEmpty
in interface MutableBiMap<K,V>
newEmpty
in interface MutableMapIterable<K,V>
public MutableBiMap<K,V> withKeyValue(K key, V value)
MutableMapIterable
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.
withKeyValue
in interface MutableBiMap<K,V>
withKeyValue
in interface MutableMapIterable<K,V>
Map.put(Object, Object)
public MutableBiMap<K,V> withAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
MutableMapIterable
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.
withAllKeyValues
in interface MutableBiMap<K,V>
withAllKeyValues
in interface MutableMapIterable<K,V>
Map.put(Object, Object)
public MutableBiMap<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
MutableMapIterable
withAllKeyValueArguments
in interface MutableBiMap<K,V>
withAllKeyValueArguments
in interface MutableMapIterable<K,V>
MutableMapIterable.withAllKeyValues(Iterable)
public MutableBiMap<K,V> withoutKey(K key)
MutableMapIterable
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.
withoutKey
in interface MutableBiMap<K,V>
withoutKey
in interface MutableMapIterable<K,V>
Map.remove(Object)
public MutableBiMap<K,V> withoutAllKeys(Iterable<? extends K> keys)
MutableMapIterable
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.
withoutAllKeys
in interface MutableBiMap<K,V>
withoutAllKeys
in interface MutableMapIterable<K,V>
Map.remove(Object)
public MutableBiMap<V,K> inverse()
BiMap
inverse
in interface BiMap<K,V>
inverse
in interface MutableBiMap<K,V>
public MutableSetMultimap<V,K> flip()
MapIterable
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.
flip
in interface BiMap<K,V>
flip
in interface MutableBiMap<K,V>
flip
in interface MapIterable<K,V>
flip
in interface MutableMapIterable<K,V>
public MutableBiMap<V,K> flipUniqueValues()
MapIterable
MapIterablemap = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3"); MapIterable result = map.flipUniqueValues(); Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
flipUniqueValues
in interface BiMap<K,V>
flipUniqueValues
in interface MutableBiMap<K,V>
flipUniqueValues
in interface MapIterable<K,V>
flipUniqueValues
in interface MutableMapIterable<K,V>
public V put(K key, V value)
MutableBiMap
Map.put(Object, Object)
, except that it throws on the addition of a duplicate value.put
in interface Map<K,V>
put
in interface MutableBiMap<K,V>
public V forcePut(K key, V value)
MutableBiMap
MutableBiMap.put(Object, Object)
, except that it quietly removes any existing entry with the same
value before putting the key-value pair.forcePut
in interface MutableBiMap<K,V>
public void putAll(Map<? extends K,? extends V> map)
public V add(Pair<K,V> keyValuePair)
MutableMapIterable
add
in interface MutableMapIterable<K,V>
Map.put(Object, Object)
public V removeKey(K key)
MutableMapIterable
key
.removeKey
in interface MutableMapIterable<K,V>
Map.remove(Object)
public V getIfAbsentPut(K key, V value)
MutableMapIterable
getIfAbsentPut
in interface MutableMapIterable<K,V>
public V getIfAbsentPut(K key, Function0<? extends V> function)
MutableMapIterable
getIfAbsentPut
in interface MutableMapIterable<K,V>
public <P> V getIfAbsentPutWith(K key, Function<? super P,? extends V> function, P parameter)
MutableMapIterable
getIfAbsentPutWith
in interface MutableMapIterable<K,V>
public V getIfAbsentPutWithKey(K key, Function<? super K,? extends V> function)
MutableMapIterable
getIfAbsentPutWithKey
in interface MutableMapIterable<K,V>
public V updateValue(K key, Function0<? extends V> factory, Function<? super V,? extends V> function)
MutableMapIterable
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
.updateValue
in interface MutableMapIterable<K,V>
public <P> V updateValueWith(K key, Function0<? extends V> factory, Function2<? super V,? super P,? extends V> function, P parameter)
MutableMapIterable
MutableMapIterable.updateValue(Object, Function0, Function)
with a Function2 and specified parameter which is
passed to the function.updateValueWith
in interface MutableMapIterable<K,V>
public Collection<V> values()
public ImmutableBiMap<K,V> toImmutable()
BiMap
toImmutable
in interface BiMap<K,V>
toImmutable
in interface MapIterable<K,V>
toImmutable
in interface MutableMapIterable<K,V>
public MutableBiMap<K,V> asSynchronized()
MutableMapIterable
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.
asSynchronized
in interface MutableBiMap<K,V>
asSynchronized
in interface MutableMapIterable<K,V>
public MutableBiMap<K,V> asUnmodifiable()
MutableMapIterable
UnsupportedOperationException
.
The returned map will be Serializable if this map is Serializable.asUnmodifiable
in interface MutableBiMap<K,V>
asUnmodifiable
in interface MutableMapIterable<K,V>
public MutableBiMap<K,V> clone()
clone
in interface MutableBiMap<K,V>
clone
in class Object
public MutableBiMap<K,V> tap(Procedure<? super V> procedure)
MapIterable
this
.
e.g. return peopleByCity.tap(new Procedure() { public void value(Person person) { LOGGER.info(person.getName()); } });
tap
in interface BiMap<K,V>
tap
in interface MutableBiMap<K,V>
tap
in interface MapIterable<K,V>
tap
in interface MutableMapIterable<K,V>
tap
in interface RichIterable<V>
InternalIterable.forEach(Procedure)
public HashBiMap<K,V> select(Predicate2<? super K,? super V> predicate)
MapIterable
e.g. peopleByCity.select(new Predicate2<City, Person>() { public boolean accept(City city, Person person) { return city.getName().equals("Anytown") && person.getLastName().equals("Smith"); } });
select
in interface BiMap<K,V>
select
in interface MutableBiMap<K,V>
select
in interface MapIterable<K,V>
select
in interface MutableMapIterable<K,V>
public HashBiMap<K,V> reject(Predicate2<? super K,? super V> predicate)
MapIterable
e.g. peopleByCity.reject(new Predicate2<City, Person>() { public boolean accept(City city, Person person) { return city.getName().equals("Anytown") && person.getLastName().equals("Smith"); } });
reject
in interface BiMap<K,V>
reject
in interface MutableBiMap<K,V>
reject
in interface MapIterable<K,V>
reject
in interface MutableMapIterable<K,V>
public <K2,V2> HashBiMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)
BiMap
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)
.collect
in interface BiMap<K,V>
collect
in interface MutableBiMap<K,V>
collect
in interface MapIterable<K,V>
collect
in interface MutableMapIterable<K,V>
public <R> HashBiMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)
BiMap
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)
.collectValues
in interface BiMap<K,V>
collectValues
in interface MutableBiMap<K,V>
collectValues
in interface MapIterable<K,V>
collectValues
in interface MutableMapIterable<K,V>
public <VV> MutableBag<VV> collect(Function<? super V,? extends VV> function)
RichIterable
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(); } });
collect
in interface RichIterable<V>
public <P,VV> MutableBag<VV> collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)
RichIterable
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));
collectWith
in interface RichIterable<V>
function
- A Function2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argument P
in function
RichIterable
that contains the transformed elements returned by Function2.value(Object, Object)
RichIterable.collect(Function)
public <VV> MutableBag<VV> flatCollect(Function<? super V,? extends Iterable<VV>> function)
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);
flatCollect
in interface RichIterable<V>
function
- The Function
to applyfunction
public MutableBooleanBag collectBoolean(BooleanFunction<? super V> booleanFunction)
RichIterable
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(); } });
collectBoolean
in interface RichIterable<V>
public MutableByteBag collectByte(ByteFunction<? super V> byteFunction)
RichIterable
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(); } });
collectByte
in interface RichIterable<V>
public MutableCharBag collectChar(CharFunction<? super V> charFunction)
RichIterable
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(); } });
collectChar
in interface RichIterable<V>
public MutableDoubleBag collectDouble(DoubleFunction<? super V> doubleFunction)
RichIterable
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(); } });
collectDouble
in interface RichIterable<V>
public MutableFloatBag collectFloat(FloatFunction<? super V> floatFunction)
RichIterable
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(); } });
collectFloat
in interface RichIterable<V>
public MutableIntBag collectInt(IntFunction<? super V> intFunction)
RichIterable
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(); } });
collectInt
in interface RichIterable<V>
public MutableLongBag collectLong(LongFunction<? super V> longFunction)
RichIterable
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(); } });
collectLong
in interface RichIterable<V>
public MutableShortBag collectShort(ShortFunction<? super V> shortFunction)
RichIterable
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(); } });
collectShort
in interface RichIterable<V>
public <VV> MutableBag<VV> collectIf(Predicate<? super V> predicate, Function<? super V,? extends VV> function)
RichIterable
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());
collectIf
in interface RichIterable<V>
public MutableSet<Pair<V,Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface BiMap<K,V>
zipWithIndex
in interface MutableBiMap<K,V>
zipWithIndex
in interface MutableMapIterable<K,V>
zipWithIndex
in interface RichIterable<V>
RichIterable
containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)
public <VV> MutableSetMultimap<VV,V> groupBy(Function<? super V,? extends VV> function)
RichIterable
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(); } });
groupBy
in interface BiMap<K,V>
groupBy
in interface MutableBiMap<K,V>
groupBy
in interface MutableMapIterable<K,V>
groupBy
in interface RichIterable<V>
public <VV> MutableSetMultimap<VV,V> groupByEach(Function<? super V,? extends Iterable<VV>> function)
RichIterable
RichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys
for each value.groupByEach
in interface BiMap<K,V>
groupByEach
in interface MutableBiMap<K,V>
groupByEach
in interface MutableMapIterable<K,V>
groupByEach
in interface RichIterable<V>
public <S> MutableSet<Pair<V,S>> zip(Iterable<S> that)
RichIterable
RichIterable
formed from this RichIterable
and another RichIterable
by
combining corresponding elements in pairs. If one of the two RichIterable
s is longer than the other, its
remaining elements are ignored.zip
in interface BiMap<K,V>
zip
in interface MutableBiMap<K,V>
zip
in interface MutableMapIterable<K,V>
zip
in interface RichIterable<V>
S
- the type of the second half of the returned pairsthat
- The RichIterable
providing the second half of each result pairRichIterable
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.public MutableSet<V> select(Predicate<? super V> predicate)
RichIterable
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"); } });
select
in interface BiMap<K,V>
select
in interface MutableBiMap<K,V>
select
in interface MutableMapIterable<K,V>
select
in interface RichIterable<V>
public <P> MutableSet<V> selectWith(Predicate2<? super V,? super P> predicate, P parameter)
RichIterable
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));
selectWith
in interface BiMap<K,V>
selectWith
in interface MutableBiMap<K,V>
selectWith
in interface MutableMapIterable<K,V>
selectWith
in interface RichIterable<V>
predicate
- a Predicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argument P
in predicate
RichIterable.select(Predicate)
public MutableSet<V> reject(Predicate<? super V> predicate)
RichIterable
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"); } });
reject
in interface BiMap<K,V>
reject
in interface MutableBiMap<K,V>
reject
in interface MutableMapIterable<K,V>
reject
in interface RichIterable<V>
predicate
- a Predicate
to use as the reject criteriaPredicate.accept(Object)
method to evaluate to falsepublic <P> MutableSet<V> rejectWith(Predicate2<? super V,? super P> predicate, P parameter)
RichIterable
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));
rejectWith
in interface BiMap<K,V>
rejectWith
in interface MutableBiMap<K,V>
rejectWith
in interface MutableMapIterable<K,V>
rejectWith
in interface RichIterable<V>
predicate
- a Predicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argument P
in predicate
RichIterable.select(Predicate)
public PartitionMutableSet<V> partition(Predicate<? super V> predicate)
RichIterable
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"); } });
partition
in interface BiMap<K,V>
partition
in interface MutableBiMap<K,V>
partition
in interface MutableMapIterable<K,V>
partition
in interface RichIterable<V>
public <P> PartitionMutableSet<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)
RichIterable
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");
partitionWith
in interface BiMap<K,V>
partitionWith
in interface MutableBiMap<K,V>
partitionWith
in interface RichIterable<V>
public void forEachValue(Procedure<? super V> procedure)
MapIterable
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);
forEachValue
in interface MapIterable<K,V>
forEachValue
in class AbstractBiMap<K,V>
public <VV> MutableBiMap<VV,V> groupByUniqueKey(Function<? super V,? extends VV> function)
RichIterable
groupByUniqueKey
in interface BiMap<K,V>
groupByUniqueKey
in interface MutableBiMap<K,V>
groupByUniqueKey
in interface MutableMapIterable<K,V>
groupByUniqueKey
in interface RichIterable<V>
RichIterable.groupBy(Function)
public <K2,V2> MutableMap<K2,V2> aggregateBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)
RichIterable
aggregateBy
in interface MutableMapIterable<K,V>
aggregateBy
in interface RichIterable<V>
public <K2,V2> MutableMap<K2,V2> aggregateInPlaceBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Procedure2<? super V2,? super V> mutatingAggregator)
RichIterable
aggregateInPlaceBy
in interface MutableMapIterable<K,V>
aggregateInPlaceBy
in interface RichIterable<V>
public <S> MutableSet<S> selectInstancesOf(Class<S> clazz)
RichIterable
clazz
.selectInstancesOf
in interface BiMap<K,V>
selectInstancesOf
in interface MutableBiMap<K,V>
selectInstancesOf
in interface MutableMapIterable<K,V>
selectInstancesOf
in interface RichIterable<V>
public void writeExternal(ObjectOutput out) throws IOException
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
IOException
ClassNotFoundException
Copyright © 2004–2016. All rights reserved.