InternalIterable<K>
, java.lang.Iterable<K>
, java.util.Map<K,V>
, MapIterable<K,V>
, RichIterable<K>
ConcurrentMutableMap<K,V>
, FixedSizeMap<K,V>
, MutableBiMap<K,V>
, MutableMap<K,V>
, MutableOrderedMap<K,V>
, MutableSortedMap<K,V>
AbstractMutableMap
, AbstractMutableMapIterable
, AbstractMutableSortedMap
, AbstractSynchronizedMapIterable
, ConcurrentHashMap
, ConcurrentHashMapUnsafe
, ConcurrentMutableHashMap
, HashBiMap
, MapAdapter
, SortedMapAdapter
, SynchronizedBiMap
, SynchronizedMutableMap
, SynchronizedSortedMap
, TreeSortedMap
, UnifiedMap
, UnifiedMapWithHashingStrategy
, UnmodifiableBiMap
, UnmodifiableMutableMap
, UnmodifiableTreeMap
public interface MutableMapIterable<K,V> extends MapIterable<K,V>, java.util.Map<K,V>
Modifier and Type | Method | Description |
---|---|---|
default V |
add(Pair<K,V> keyValuePair) |
This method allows mutable map the ability to add an element in the form of Pair
|
<KK,VV> MutableMap<KK,VV> |
aggregateBy(Function<? super V,? extends KK> groupBy,
Function0<? extends VV> zeroValueFactory,
Function2<? super VV,? super V,? extends VV> nonMutatingAggregator) |
Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
|
<KK,VV> MutableMap<KK,VV> |
aggregateInPlaceBy(Function<? super V,? extends KK> groupBy,
Function0<? extends VV> zeroValueFactory,
Procedure2<? super VV,? super V> mutatingAggregator) |
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
|
MutableMapIterable<K,V> |
asSynchronized() |
Returns a synchronized wrapper backed by this map.
|
MutableMapIterable<K,V> |
asUnmodifiable() |
Returns an unmodifiable view of this map.
|
<K2,V2> MutableMapIterable<K2,V2> |
collect(Function2<? super K,? super V,Pair<K2,V2>> function) |
For each key and value of the map the function is evaluated.
|
<R> MutableMapIterable<K,R> |
collectValues(Function2<? super K,? super V,? extends R> function) |
For each key and value of the map the function is evaluated.
|
default <V1> MutableBag<V1> |
countBy(Function<? super V,? extends V1> function) |
This method will count the number of occurrences of each value calculated by applying the
function to each element of the collection.
|
default <V1,P> MutableBag<V1> |
countByWith(Function2<? super V,? super P,? extends V1> function,
P parameter) |
This method will count the number of occurrences of each value calculated by applying the
function to each element of the collection with the specified parameter as the second argument.
|
MutableMultimap<V,K> |
flip() |
Given a map from Domain -> Range return a multimap from Range -> Domain.
|
MutableMapIterable<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 |
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.
|
<V1> MutableMultimap<V1,V> |
groupBy(Function<? super V,? extends V1> function) |
For each element of the iterable, the function is evaluated and the results of these evaluations are collected
into a new multimap, where the transformed value is the key and the original values are added to the same (or similar)
species of collection as the source iterable.
|
<V1> MutableMultimap<V1,V> |
groupByEach(Function<? super V,? extends java.lang.Iterable<V1>> function) |
Similar to
RichIterable.groupBy(Function) , except the result of evaluating function will return a collection of keys
for each value. |
<V1> MutableMapIterable<V1,V> |
groupByUniqueKey(Function<? super V,? extends V1> 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.
|
MutableMapIterable<K,V> |
newEmpty() |
Creates a new instance of the same type, using the default capacity and growth parameters.
|
PartitionMutableCollection<V> |
partition(Predicate<? super V> predicate) |
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
MutableCollection<V> |
reject(Predicate<? super V> predicate) |
Returns all elements of the source collection that return false when evaluating of the predicate.
|
MutableMapIterable<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> MutableCollection<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 |
removeKey(K key) |
Remove an entry from the map at the specified
key . |
MutableCollection<V> |
select(Predicate<? super V> predicate) |
Returns all elements of the source collection that return true when evaluating the predicate.
|
MutableMapIterable<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> MutableCollection<S> |
selectInstancesOf(java.lang.Class<S> clazz) |
Returns all elements of the source collection that are instances of the Class
clazz . |
<P> MutableCollection<V> |
selectWith(Predicate2<? super V,? super P> predicate,
P parameter) |
Similar to
RichIterable.select(Predicate) , except with an evaluation parameter for the second generic argument in Predicate2 . |
<V1> MutableObjectDoubleMap<V1> |
sumByDouble(Function<? super V,? extends V1> groupBy,
DoubleFunction<? super V> function) |
Groups and sums the values using the two specified functions.
|
<V1> MutableObjectDoubleMap<V1> |
sumByFloat(Function<? super V,? extends V1> groupBy,
FloatFunction<? super V> function) |
Groups and sums the values using the two specified functions.
|
<V1> MutableObjectLongMap<V1> |
sumByInt(Function<? super V,? extends V1> groupBy,
IntFunction<? super V> function) |
Groups and sums the values using the two specified functions.
|
<V1> MutableObjectLongMap<V1> |
sumByLong(Function<? super V,? extends V1> groupBy,
LongFunction<? super V> function) |
Groups and sums the values using the two specified functions.
|
MutableMapIterable<K,V> |
tap(Procedure<? super V> procedure) |
Executes the Procedure for each value of the map and returns
this . |
ImmutableMapIterable<K,V> |
toImmutable() |
Returns an immutable copy of this map.
|
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
updateValue(Object, Function0, Function) with a Function2 and specified parameter which is
passed to the function. |
MutableMapIterable<K,V> |
withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs) |
Convenience var-args version of withAllKeyValues
|
MutableMapIterable<K,V> |
withAllKeyValues(java.lang.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.
|
MutableMapIterable<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.
|
MutableMapIterable<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.
|
MutableMapIterable<K,V> |
withoutKey(K key) |
This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing
elements.
|
<S> MutableCollection<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. |
MutableCollection<Pair<V,java.lang.Integer>> |
zipWithIndex() |
Zips this
RichIterable with its indices. |
forEach, forEach, forEachWith, forEachWithIndex
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entry, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
containsKey, containsValue, detect, detectOptional, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countBy, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollect, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, partitionWith, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex
default V add(Pair<K,V> keyValuePair)
Map.put(Object, Object)
V removeKey(K key)
key
.Map.remove(Object)
V getIfAbsentPut(K key, Function0<? extends V> function)
V getIfAbsentPut(K key, V value)
V getIfAbsentPutWithKey(K key, Function<? super K,? extends V> function)
<P> V getIfAbsentPutWith(K key, Function<? super P,? extends V> function, P parameter)
V updateValue(K key, Function0<? extends V> factory, Function<? super V,? extends V> function)
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
.<P> V updateValueWith(K key, Function0<? extends V> factory, Function2<? super V,? super P,? extends V> function, P parameter)
updateValue(Object, Function0, Function)
with a Function2 and specified parameter which is
passed to the function.MutableMapIterable<K,V> withKeyValue(K key, V value)
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.
Map.put(Object, Object)
MutableMapIterable<K,V> withAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)
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.
Map.put(Object, Object)
MutableMapIterable<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
withAllKeyValues(Iterable)
MutableMapIterable<K,V> withoutKey(K key)
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.
Map.remove(Object)
MutableMapIterable<K,V> withoutAllKeys(java.lang.Iterable<? extends K> keys)
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.
Map.remove(Object)
MutableMapIterable<K,V> newEmpty()
MutableMapIterable<K,V> asUnmodifiable()
Collections.unmodifiableMap(this)
only with a return type that supports the full
iteration protocols available on MutableMapIterable
. Methods which would
mutate the underlying map will throw UnsupportedOperationExceptions.Collections.unmodifiableMap(Map)
MutableMapIterable<K,V> asSynchronized()
Collections.synchronizedMap(this)
only with the more feature rich return type of
MutableMapIterable
.
The preferred way of iterating over a synchronized map is to use the forEachKey(), forEachValue() and forEachKeyValue() methods which are properly synchronized internally.
MutableMap synchedMap = map.asSynchronized(); synchedMap.forEachKey(key -> ... ); synchedMap.forEachValue(value -> ... ); synchedMap.forEachKeyValue((key, value) -> ... );
If you want to iterate imperatively over the keySet(), values(), or entrySet(), you will need to protect the iteration by wrapping the code in a synchronized block on the map.
Collections.synchronizedMap(Map)
ImmutableMapIterable<K,V> toImmutable()
toImmutable
in interface MapIterable<K,V>
MutableMapIterable<K,V> tap(Procedure<? super V> procedure)
MapIterable
this
.
return peopleByCity.tap(person -> LOGGER.info(person.getName()));
tap
in interface MapIterable<K,V>
tap
in interface RichIterable<K>
InternalIterable.forEach(Procedure)
MutableMapIterable<V,K> flipUniqueValues()
MapIterable
MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3"); MapIterable<String, Integer> result = map.flipUniqueValues(); Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
flipUniqueValues
in interface MapIterable<K,V>
MutableMultimap<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 MapIterable<K,V>
MutableMapIterable<K,V> select(Predicate2<? super K,? super V> predicate)
MapIterable
MapIterable<City, Person> selected = peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
select
in interface MapIterable<K,V>
MutableMapIterable<K,V> reject(Predicate2<? super K,? super V> predicate)
MapIterable
MapIterable<City, Person> rejected = peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
reject
in interface MapIterable<K,V>
<K2,V2> MutableMapIterable<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)
MapIterable
MapIterable<String, String> collected = peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
collect
in interface MapIterable<K,V>
<R> MutableMapIterable<K,R> collectValues(Function2<? super K,? super V,? extends R> function)
MapIterable
MapIterable<City, String> collected = peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
collectValues
in interface MapIterable<K,V>
MutableCollection<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 RichIterable<K>
<P> MutableCollection<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 RichIterable<K>
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)
MutableCollection<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 RichIterable<K>
predicate
- a Predicate
to use as the reject criteriaPredicate.accept(Object)
method to evaluate to false<P> MutableCollection<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 RichIterable<K>
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)
PartitionMutableCollection<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 RichIterable<K>
<S> MutableCollection<S> selectInstancesOf(java.lang.Class<S> clazz)
RichIterable
clazz
.
RichIterable<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
selectInstancesOf
in interface RichIterable<K>
<V1> MutableObjectLongMap<V1> sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)
RichIterable
sumByInt
in interface RichIterable<K>
<V1> MutableObjectDoubleMap<V1> sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)
RichIterable
sumByFloat
in interface RichIterable<K>
<V1> MutableObjectLongMap<V1> sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)
RichIterable
sumByLong
in interface RichIterable<K>
<V1> MutableObjectDoubleMap<V1> sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)
RichIterable
sumByDouble
in interface RichIterable<K>
default <V1> MutableBag<V1> countBy(Function<? super V,? extends V1> function)
RichIterable
countBy
in interface RichIterable<K>
default <V1,P> MutableBag<V1> countByWith(Function2<? super V,? super P,? extends V1> function, P parameter)
RichIterable
countByWith
in interface RichIterable<K>
<V1> MutableMultimap<V1,V> groupBy(Function<? super V,? extends V1> 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 valueOf(Person person) { return person.getLastName(); } });
groupBy
in interface RichIterable<K>
<V1> MutableMultimap<V1,V> groupByEach(Function<? super V,? extends java.lang.Iterable<V1>> function)
RichIterable
RichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys
for each value.groupByEach
in interface RichIterable<K>
<V1> MutableMapIterable<V1,V> groupByUniqueKey(Function<? super V,? extends V1> function)
RichIterable
groupByUniqueKey
in interface RichIterable<K>
RichIterable.groupBy(Function)
<S> MutableCollection<Pair<V,S>> zip(java.lang.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 RichIterable<K>
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.MutableCollection<Pair<V,java.lang.Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface RichIterable<K>
RichIterable
containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)
<KK,VV> MutableMap<KK,VV> aggregateInPlaceBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Procedure2<? super VV,? super V> mutatingAggregator)
RichIterable
aggregateInPlaceBy
in interface RichIterable<K>
<KK,VV> MutableMap<KK,VV> aggregateBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Function2<? super VV,? super V,? extends VV> nonMutatingAggregator)
RichIterable
aggregateBy
in interface RichIterable<K>
Copyright © 2004–2017. All rights reserved.