public interface MutableMap<K,V> extends UnsortedMapIterable<K,V>, Map<K,V>, Cloneable
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.
|
MutableMap<K,V> |
asSynchronized()
Returns a synchronized (thread-safe) map backed by the specified map.
|
MutableMap<K,V> |
asUnmodifiable()
Returns an unmodifiable view of this map.
|
MutableMap<K,V> |
clone() |
<R> MutableCollection<R> |
collect(Function<? super V,? extends R> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection.
|
<K2,V2> MutableMap<K2,V2> |
collect(Function2<? super K,? super V,Pair<K2,V2>> function)
For each key and value of the map the function is evaluated.
|
MutableBooleanCollection |
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. |
MutableByteCollection |
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. |
MutableCharCollection |
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. |
MutableDoubleCollection |
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. |
MutableFloatCollection |
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. |
<R> MutableCollection<R> |
collectIf(Predicate<? super V> predicate,
Function<? super V,? extends R> 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.
|
MutableIntCollection |
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. |
<E> MutableMap<K,V> |
collectKeysAndValues(Iterable<E> iterable,
Function<? super E,? extends K> keyFunction,
Function<? super E,? extends V> valueFunction)
Adds all the entries derived from
collection to this . |
MutableLongCollection |
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. |
MutableShortCollection |
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> MutableMap<K,R> |
collectValues(Function2<? super K,? super V,? extends R> function)
For each key and value of the map the function is evaluated.
|
<R> MutableCollection<R> |
flatCollect(Function<? super V,? extends Iterable<R>> 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.
|
MutableMap<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.
|
<VV> MutableMultimap<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> MutableMultimap<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. |
<V1> MutableMap<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.
|
MutableMap<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.
|
<P> PartitionMutableCollection<V> |
partitionWith(Predicate2<? super V,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable 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.
|
MutableMap<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.
|
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.
|
MutableMap<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(Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz . |
ImmutableMap<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. |
MutableMap<K,V> |
withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
Convenience var-args version of withAllKeyValues
|
MutableMap<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.
|
MutableMap<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.
|
MutableMap<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.
|
MutableMap<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(Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
MutableCollection<Pair<V,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
containsKey, containsValue, detect, equals, forEachKey, forEachKeyValue, forEachValue, 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, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, rejectWith, select, selectWith, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex
forEach, forEachWith, forEachWithIndex
forEach, iterator, spliterator
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values
MutableMap<K,V> newEmpty()
<E> MutableMap<K,V> collectKeysAndValues(Iterable<E> iterable, Function<? super E,? extends K> keyFunction, Function<? super E,? extends V> valueFunction)
collection
to this
. The key and value for each entry
is determined by applying the keyFunction
and valueFunction
to each item in
collection
. Any entry in map
that has the same key as an entry in this
will have it's value replaced by that in map
.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)
MutableMap<K,V> clone()
MutableMap<K,V> asUnmodifiable()
UnsupportedOperationException
.
The returned map will be Serializable if this map is Serializable.ImmutableMap<K,V> toImmutable()
toImmutable
in interface UnsortedMapIterable<K,V>
MutableMap<K,V> asSynchronized()
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.
MutableSetMultimap<V,K> flip()
MapIterable
flip
in interface MapIterable<K,V>
flip
in interface UnsortedMapIterable<K,V>
MutableMap<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 MapIterable<K,V>
select
in interface UnsortedMapIterable<K,V>
<R> MutableMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)
MapIterable
e.g. peopleByCity.collectValues(new Function2<City, Person, String>() { public String value(City city, Person person) { return person.getFirstName() + " " + person.getLastName(); } });
collectValues
in interface MapIterable<K,V>
collectValues
in interface UnsortedMapIterable<K,V>
<K2,V2> MutableMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)
MapIterable
e.g. peopleByCity.collect(new Function2<City, Person, String>() { public String value(City city, Person person) { return Pair.of(city.getCountry(), person.getAddress().getCity()); } });
collect
in interface MapIterable<K,V>
collect
in interface UnsortedMapIterable<K,V>
MutableMap<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 MapIterable<K,V>
reject
in interface UnsortedMapIterable<K,V>
<R> MutableCollection<R> collect(Function<? super V,? extends R> function)
RichIterable
e.g. return people.collect(new Function<Person, String>() { public String valueOf(Person person) { return person.getFirstName() + " " + person.getLastName(); } });
collect
in interface RichIterable<V>
MutableBooleanCollection 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.
e.g. return people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
collectBoolean
in interface RichIterable<V>
MutableByteCollection 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.
e.g. return people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
collectByte
in interface RichIterable<V>
MutableCharCollection 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.
e.g. return people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
collectChar
in interface RichIterable<V>
MutableDoubleCollection 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.
e.g. return people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
collectDouble
in interface RichIterable<V>
MutableFloatCollection 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.
e.g. return people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
collectFloat
in interface RichIterable<V>
MutableIntCollection 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.
e.g. return people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
collectInt
in interface RichIterable<V>
MutableLongCollection 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.
e.g. return people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
collectLong
in interface RichIterable<V>
MutableShortCollection 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.
e.g. return people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
collectShort
in interface RichIterable<V>
<R> MutableCollection<R> collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> function)
RichIterable
e.g. Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
collectIf
in interface RichIterable<V>
<R> MutableCollection<R> flatCollect(Function<? super V,? extends Iterable<R>> 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 = new Function<Person, List<Address>>() { public List<Address> valueOf(Person person) { return 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
MutableCollection<V> reject(Predicate<? super V> predicate)
RichIterable
e.g. return people.reject(new Predicate<Person>() { public boolean accept(Person person) { return person.person.getLastName().equals("Smith"); } });
e.g. return people.reject(Predicates.attributeEqual("lastName", "Smith"));
reject
in interface RichIterable<V>
predicate
- a Predicate
to use as the reject criteriaPredicate.accept(Object)
method to evaluate to falseMutableCollection<V> select(Predicate<? super V> predicate)
RichIterable
e.g. return people.select(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getCity().equals("Metuchen"); } });
select
in interface RichIterable<V>
PartitionMutableCollection<V> partition(Predicate<? super V> predicate)
RichIterable
e.g. return people.partition(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getState().getName().equals("New York"); } });
partition
in interface RichIterable<V>
<P> PartitionMutableCollection<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)
RichIterable
e.g. return 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 RichIterable<V>
<S> MutableCollection<S> selectInstancesOf(Class<S> clazz)
RichIterable
clazz
.selectInstancesOf
in interface RichIterable<V>
<S> MutableCollection<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 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.MutableCollection<Pair<V,Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.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)
MutableMap<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 MapIterable<K,V>
V add(Pair<K,V> keyValuePair)
Map.put(Object, Object)
MutableMap<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)
MutableMap<K,V> withAllKeyValues(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)
MutableMap<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
withAllKeyValues(Iterable)
MutableMap<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)
MutableMap<K,V> withoutAllKeys(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)
<VV> MutableMultimap<VV,V> groupBy(Function<? super V,? extends VV> function)
RichIterable
e.g. return people.groupBy(new Function<Person, String>() { public String value(Person person) { return person.getFirstName() + " " + person.getLastName(); } });
groupBy
in interface RichIterable<V>
<VV> MutableMultimap<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 RichIterable<V>
<V1> MutableMap<V1,V> groupByUniqueKey(Function<? super V,? extends V1> function)
RichIterable
groupByUniqueKey
in interface RichIterable<V>
RichIterable.groupBy(Function)
<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 RichIterable<V>
<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 RichIterable<V>
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
.Copyright © 2004–2016. All rights reserved.