@Immutable public interface ImmutableMap<K,V> extends UnsortedMapIterable<K,V>
| Modifier and Type | Method and Description |
|---|---|
<K2,V2> ImmutableMap<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> ImmutableMap<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.
|
Map<K,V> |
castToMap() |
<R> ImmutableCollection<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> ImmutableMap<K2,V2> |
collect(Function2<? super K,? super V,Pair<K2,V2>> function)
For each key and value of the map the function is evaluated.
|
ImmutableBooleanCollection |
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. |
ImmutableByteCollection |
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. |
ImmutableCharCollection |
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. |
ImmutableDoubleCollection |
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. |
ImmutableFloatCollection |
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> ImmutableCollection<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.
|
ImmutableIntCollection |
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. |
ImmutableLongCollection |
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. |
ImmutableShortCollection |
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> ImmutableMap<K,R> |
collectValues(Function2<? super K,? super V,? extends R> function)
For each key and value of the map the function is evaluated.
|
<R> ImmutableCollection<R> |
flatCollect(Function<? super V,? extends Iterable<R>> function)
flatCollect is a special case of RichIterable.collect(Function). |
ImmutableSetMultimap<V,K> |
flip()
Given a map from Domain -> Range return a multimap from Range -> Domain.
|
ImmutableMap<V,K> |
flipUniqueValues()
Return the MapIterable that is obtained by flipping the direction of this map and making the associations
from value to key.
|
<VV> ImmutableMultimap<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> ImmutableMultimap<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> ImmutableMap<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.
|
ImmutableMap<K,V> |
newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs) |
ImmutableMap<K,V> |
newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues) |
ImmutableMap<K,V> |
newWithKeyValue(K key,
V value) |
ImmutableMap<K,V> |
newWithoutAllKeys(Iterable<? extends K> keys) |
ImmutableMap<K,V> |
newWithoutKey(K key) |
PartitionImmutableCollection<V> |
partition(Predicate<? super V> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
<P> PartitionImmutableCollection<V> |
partitionWith(Predicate2<? super V,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
ImmutableCollection<V> |
reject(Predicate<? super V> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.
|
ImmutableMap<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.
|
ImmutableCollection<V> |
select(Predicate<? super V> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.
|
ImmutableMap<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> ImmutableCollection<S> |
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz. |
MutableMap<K,V> |
toMap() |
<S> ImmutableCollection<Pair<V,S>> |
zip(Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
ImmutableCollection<Pair<V,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
toImmutablecontainsKey, containsValue, detect, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, toString, valuesViewallSatisfy, 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, zipWithIndexforEach, forEachWith, forEachWithIndexforEach, iterator, spliteratorImmutableMap<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 UnsortedMapIterable<K,V><K2,V2> ImmutableMap<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 UnsortedMapIterable<K,V><R> ImmutableMap<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 UnsortedMapIterable<K,V>ImmutableMap<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 UnsortedMapIterable<K,V>ImmutableMap<K,V> newWithKeyValue(K key, V value)
ImmutableMap<K,V> newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
ImmutableMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
ImmutableMap<K,V> newWithoutKey(K key)
ImmutableMap<K,V> newWithoutAllKeys(Iterable<? extends K> keys)
MutableMap<K,V> toMap()
ImmutableSetMultimap<V,K> flip()
MapIterableflip in interface MapIterable<K,V>flip in interface UnsortedMapIterable<K,V><R> ImmutableCollection<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 RichIterable<V>ImmutableBooleanCollection 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 RichIterable<V>ImmutableByteCollection 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 RichIterable<V>ImmutableCharCollection 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 RichIterable<V>ImmutableDoubleCollection 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 RichIterable<V>ImmutableFloatCollection 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 RichIterable<V>ImmutableIntCollection 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 RichIterable<V>ImmutableLongCollection 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 RichIterable<V>ImmutableShortCollection 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 RichIterable<V><R> ImmutableCollection<R> collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> function)
RichIterablee.g. Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
collectIf in interface RichIterable<V><R> ImmutableCollection<R> flatCollect(Function<? super V,? extends Iterable<R>> function)
RichIterableflatCollect 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 applyfunctionImmutableCollection<V> select(Predicate<? super V> predicate)
RichIterablee.g.
return people.select(new Predicate<Person>()
{
public boolean accept(Person person)
{
return person.getAddress().getCity().equals("Metuchen");
}
});
select in interface RichIterable<V>ImmutableCollection<V> reject(Predicate<? super V> predicate)
RichIterablee.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 falsePartitionImmutableCollection<V> partition(Predicate<? super V> predicate)
RichIterablee.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> PartitionImmutableCollection<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)
RichIterablee.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> ImmutableCollection<S> selectInstancesOf(Class<S> clazz)
RichIterableclazz.selectInstancesOf in interface RichIterable<V><S> ImmutableCollection<Pair<V,S>> zip(Iterable<S> that)
RichIterableRichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its
remaining elements are ignored.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.ImmutableCollection<Pair<V,Integer>> zipWithIndex()
RichIterableRichIterable 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)<VV> ImmutableMultimap<VV,V> groupBy(Function<? super V,? extends VV> function)
RichIterablee.g.
return people.groupBy(new Function<Person, String>()
{
public String value(Person person)
{
return person.getFirstName() + " " + person.getLastName();
}
});
groupBy in interface RichIterable<V><VV> ImmutableMultimap<VV,V> groupByEach(Function<? super V,? extends Iterable<VV>> function)
RichIterableRichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value.groupByEach in interface RichIterable<V><V1> ImmutableMap<V1,V> groupByUniqueKey(Function<? super V,? extends V1> function)
RichIterablegroupByUniqueKey in interface RichIterable<V>RichIterable.groupBy(Function)<K2,V2> ImmutableMap<K2,V2> aggregateInPlaceBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Procedure2<? super V2,? super V> mutatingAggregator)
RichIterableaggregateInPlaceBy in interface RichIterable<V><K2,V2> ImmutableMap<K2,V2> aggregateBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)
RichIterableaggregateBy in interface RichIterable<V>ImmutableMap<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>Copyright © 2004–2017. All rights reserved.