public abstract class AbstractMutableMap<K,V> extends AbstractMapIterable<K,V> implements MutableMap<K,V>
| Constructor and Description |
|---|
AbstractMutableMap() |
| 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.
|
abstract MutableMap<K,V> |
clone()
Returns a string representation of this map.
|
<R> MutableList<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.
|
MutableBooleanList |
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. |
MutableByteList |
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. |
MutableCharList |
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. |
MutableDoubleList |
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. |
MutableFloatList |
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> MutableList<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.
|
MutableIntList |
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. |
MutableLongList |
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. |
MutableShortList |
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.
|
<P,VV> MutableList<VV> |
collectWith(Function2<? super V,? super P,? extends VV> function,
P parameter)
Same as collect with a
Function2 and specified parameter which is passed to the block
|
Pair<K,V> |
detect(Predicate2<? super K,? super V> predicate)
Return the first key and value of the map for which the predicate evaluates to true when they are given
as arguments.
|
<R> MutableList<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.
|
Iterator<V> |
iterator() |
RichIterable<K> |
keysView()
Returns an unmodifiable lazy iterable wrapped around the keySet for the map
|
RichIterable<Pair<K,V>> |
keyValuesView()
Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map
|
abstract <K,V> MutableMap<K,V> |
newEmpty(int capacity)
Creates a new instance of the same type, using the given capacity and the default growth parameters.
|
PartitionMutableList<V> |
partition(Predicate<? super V> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
<P> PartitionMutableList<V> |
partitionWith(Predicate2<? super V,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
MutableList<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.
|
MutableList<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> MutableList<S> |
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz. |
<P> RichIterable<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. |
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
MutableMap.updateValue(Object, Function0, Function) with a Function2 and specified parameter which is
passed to the function. |
RichIterable<V> |
valuesView()
Returns an unmodifiable lazy iterable wrapped around the values for the map
|
MutableMap<K,V> |
withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValues)
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> MutableList<Pair<V,S>> |
zip(Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
MutableList<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, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, forEach, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, groupBy, groupByEach, ifPresentApply, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndexequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitcollectKeysAndValues, newEmpty, removeKeycontainsKey, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, toStringallSatisfy, 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, 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, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndexforEach, forEachWith, forEachWithIndexforEach, spliteratorclear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, valuespublic abstract MutableMap<K,V> clone()
This implementation creates an empty string buffer, appends a left brace, and iterates over the map's entrySet view, appending the string representation of each map.entry in turn. After appending each entry except the last, the string ", " is appended. Finally a right brace is appended. A string is obtained from the stringbuffer, and returned.
public abstract <K,V> MutableMap<K,V> newEmpty(int capacity)
public MutableMap<K,V> asUnmodifiable()
MutableMapUnsupportedOperationException.
The returned map will be Serializable if this map is Serializable.asUnmodifiable in interface MutableMap<K,V>public ImmutableMap<K,V> toImmutable()
MutableMaptoImmutable in interface MutableMap<K,V>toImmutable in interface UnsortedMapIterable<K,V>public MutableMap<K,V> asSynchronized()
MutableMapIt 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 MutableMap<K,V>public RichIterable<K> keysView()
MapIterablekeysView in interface MapIterable<K,V>public RichIterable<V> valuesView()
MapIterablevaluesView in interface MapIterable<K,V>public RichIterable<Pair<K,V>> keyValuesView()
MapIterablekeyValuesView in interface MapIterable<K,V>public MutableMap<V,K> flipUniqueValues()
MapIterable
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)));
flipUniqueValues in interface MapIterable<K,V>flipUniqueValues in interface MutableMap<K,V>public V getIfAbsentPut(K key, Function0<? extends V> function)
MutableMapgetIfAbsentPut in interface MutableMap<K,V>public MutableSetMultimap<V,K> flip()
MapIterableflip in interface MapIterable<K,V>flip in interface MutableMap<K,V>flip in interface UnsortedMapIterable<K,V>public V getIfAbsentPut(K key, V value)
MutableMapgetIfAbsentPut in interface MutableMap<K,V>public V getIfAbsentPutWithKey(K key, Function<? super K,? extends V> function)
MutableMapgetIfAbsentPutWithKey in interface MutableMap<K,V>public <P> V getIfAbsentPutWith(K key, Function<? super P,? extends V> function, P parameter)
MutableMapgetIfAbsentPutWith in interface MutableMap<K,V>public <K2,V2> MutableMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)
MapIterablee.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 MutableMap<K,V>collect in interface UnsortedMapIterable<K,V>public <R> MutableMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)
MapIterablee.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 MutableMap<K,V>collectValues in interface UnsortedMapIterable<K,V>public MutableMap<K,V> select(Predicate2<? super K,? super V> predicate)
MapIterablee.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 MutableMap<K,V>select in interface UnsortedMapIterable<K,V>public MutableMap<K,V> reject(Predicate2<? super K,? super V> predicate)
MapIterablee.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 MutableMap<K,V>reject in interface UnsortedMapIterable<K,V>public Pair<K,V> detect(Predicate2<? super K,? super V> predicate)
MapIterablee.g.
peopleByCity.detect(new Predicate2<City, Person>()
{
public boolean accept(City city, Person person)
{
return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
}
});
detect in interface MapIterable<K,V>public <R> MutableList<R> collect(Function<? super V,? extends R> function)
RichIterablee.g.
return people.collect(new Function<Person, String>()
{
public String valueOf(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
collect in interface MutableMap<K,V>collect in interface RichIterable<V>collect in class AbstractMapIterable<K,V>public MutableBooleanList collectBoolean(BooleanFunction<? super V> booleanFunction)
RichIterableboolean 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 MutableMap<K,V>collectBoolean in interface RichIterable<V>collectBoolean in class AbstractMapIterable<K,V>public MutableByteList collectByte(ByteFunction<? super V> byteFunction)
RichIterablebyte 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 MutableMap<K,V>collectByte in interface RichIterable<V>public MutableCharList collectChar(CharFunction<? super V> charFunction)
RichIterablechar 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 MutableMap<K,V>collectChar in interface RichIterable<V>public MutableDoubleList collectDouble(DoubleFunction<? super V> doubleFunction)
RichIterabledouble 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 MutableMap<K,V>collectDouble in interface RichIterable<V>public MutableFloatList collectFloat(FloatFunction<? super V> floatFunction)
RichIterablefloat 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 MutableMap<K,V>collectFloat in interface RichIterable<V>public MutableIntList collectInt(IntFunction<? super V> intFunction)
RichIterableint 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 MutableMap<K,V>collectInt in interface RichIterable<V>public MutableLongList collectLong(LongFunction<? super V> longFunction)
RichIterablelong 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 MutableMap<K,V>collectLong in interface RichIterable<V>public MutableShortList collectShort(ShortFunction<? super V> shortFunction)
RichIterableshort 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 MutableMap<K,V>collectShort in interface RichIterable<V>public <P,VV> MutableList<VV> collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)
RichIterableFunction2 and specified parameter which is passed to the block