@Immutable public interface ImmutableSortedMap<K,V> extends SortedMapIterable<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.
|
SortedMap<K,V> |
castToSortedMap() |
<R> ImmutableList<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.
|
<R> ImmutableList<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.
|
<R> ImmutableSortedMap<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> ImmutableList<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
|
<R> ImmutableList<R> |
flatCollect(Function<? super V,? extends Iterable<R>> function)
flatCollect is a special case of RichIterable.collect(Function) . |
ImmutableSortedSetMultimap<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> ImmutableListMultimap<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> ImmutableListMultimap<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> ImmutableMap<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.
|
ImmutableSortedMap<K,V> |
newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs) |
ImmutableSortedMap<K,V> |
newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues) |
ImmutableSortedMap<K,V> |
newWithKeyValue(K key,
V value) |
ImmutableSortedMap<K,V> |
newWithoutAllKeys(Iterable<? extends K> keys) |
ImmutableSortedMap<K,V> |
newWithoutKey(K key) |
PartitionImmutableList<V> |
partition(Predicate<? super V> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
ImmutableList<V> |
reject(Predicate<? super V> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.
|
ImmutableSortedMap<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> ImmutableList<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 . |
ImmutableList<V> |
select(Predicate<? super V> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.
|
ImmutableSortedMap<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> ImmutableList<S> |
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz . |
<P> ImmutableList<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 . |
MutableSortedMap<K,V> |
toSortedMap() |
<S> ImmutableList<Pair<V,S>> |
zip(Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
ImmutableList<Pair<V,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
comparator, toImmutable
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, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, 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, partitionWith, reject, rejectWith, select, 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
ImmutableSortedSetMultimap<V,K> flip()
MapIterable
flip
in interface MapIterable<K,V>
flip
in interface SortedMapIterable<K,V>
ImmutableSortedMap<K,V> newWithKeyValue(K key, V value)
ImmutableSortedMap<K,V> newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
ImmutableSortedMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
ImmutableSortedMap<K,V> newWithoutKey(K key)
ImmutableSortedMap<K,V> newWithoutAllKeys(Iterable<? extends K> keys)
MutableSortedMap<K,V> toSortedMap()
ImmutableMap<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>
ImmutableSortedMap<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 SortedMapIterable<K,V>
<K2,V2> ImmutableMap<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>
ImmutableSortedMap<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 SortedMapIterable<K,V>
PartitionImmutableList<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>
partition
in interface SortedMapIterable<K,V>
<R> ImmutableSortedMap<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 SortedMapIterable<K,V>
ImmutableList<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>
select
in interface SortedMapIterable<K,V>
<P> ImmutableList<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
.selectWith
in interface RichIterable<V>
selectWith
in interface SortedMapIterable<K,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)
ImmutableList<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>
reject
in interface SortedMapIterable<K,V>
predicate
- a Predicate
to use as the reject criteriaPredicate.accept(Object)
method to evaluate to false<P> ImmutableList<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
.rejectWith
in interface RichIterable<V>
rejectWith
in interface SortedMapIterable<K,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)
<S> ImmutableList<S> selectInstancesOf(Class<S> clazz)
RichIterable
clazz
.selectInstancesOf
in interface RichIterable<V>
selectInstancesOf
in interface SortedMapIterable<K,V>
<R> ImmutableList<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>
<P,VV> ImmutableList<VV> collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)
RichIterable
Function2
and specified parameter which is passed to the block
e.g. Function2addParameterFunction = new Function2 () { public Integer value(final Integer each, final Integer parameter) { return each + parameter; } }; FastList.newListWith(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)
<R> ImmutableList<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> ImmutableList<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
<S> ImmutableList<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>
zip
in interface SortedMapIterable<K,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.ImmutableList<Pair<V,Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface RichIterable<V>
zipWithIndex
in interface SortedMapIterable<K,V>
RichIterable
containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)
<VV> ImmutableListMultimap<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>
groupBy
in interface SortedMapIterable<K,V>
<VV> ImmutableListMultimap<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>
groupByEach
in interface SortedMapIterable<K,V>
<VV> ImmutableMap<VV,V> groupByUniqueKey(Function<? super V,? extends VV> function)
RichIterable
groupByUniqueKey
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)
RichIterable
aggregateInPlaceBy
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)
RichIterable
aggregateBy
in interface RichIterable<V>
Copyright © 2004–2017. All rights reserved.