Interface ImmutableSortedMap<K,V>
- All Superinterfaces:
ImmutableMapIterable<K,V>
,InternalIterable<V>
,Iterable<V>
,MapIterable<K,V>
,OrderedIterable<V>
,ReversibleIterable<V>
,RichIterable<V>
,SortedMapIterable<K,V>
- All Known Implementing Classes:
AbstractImmutableSortedMap
,ImmutableTreeMap
public interface ImmutableSortedMap<K,V> extends SortedMapIterable<K,V>, ImmutableMapIterable<K,V>
-
Method Summary
Modifier and Type Method Description default <K1, V1, V2> ImmutableMap<K1,V2>
aggregateBy(Function<? super K,? extends K1> keyFunction, Function<? super V,? extends V1> valueFunction, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V1,? extends V2> nonMutatingAggregator)
Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions.default <KK, VV> ImmutableMap<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.default <KK, VV> ImmutableMap<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.SortedMap<K,V>
castToMap()
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.ImmutableBooleanList
collectBoolean(BooleanFunction<? super V> booleanFunction)
Returns a new primitiveboolean
iterable with the results of applying the specified function on each element of the source collection.ImmutableByteList
collectByte(ByteFunction<? super V> byteFunction)
Returns a new primitivebyte
iterable with the results of applying the specified function on each element of the source collection.ImmutableCharList
collectChar(CharFunction<? super V> charFunction)
Returns a new primitivechar
iterable with the results of applying the specified function on each element of the source collection.ImmutableDoubleList
collectDouble(DoubleFunction<? super V> doubleFunction)
Returns a new primitivedouble
iterable with the results of applying the specified function on each element of the source collection.ImmutableFloatList
collectFloat(FloatFunction<? super V> floatFunction)
Returns a new primitivefloat
iterable with the results of applying the specified function on each element of the source collection.<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.ImmutableIntList
collectInt(IntFunction<? super V> intFunction)
Returns a new primitiveint
iterable with the results of applying the specified function on each element of the source collection.ImmutableLongList
collectLong(LongFunction<? super V> longFunction)
Returns a new primitivelong
iterable with the results of applying the specified function on each element of the source collection.ImmutableShortList
collectShort(ShortFunction<? super V> shortFunction)
Returns a new primitiveshort
iterable with the results of applying the specified function on each element of the source collection.<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 asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.default <R> ImmutableList<R>
collectWithIndex(ObjectIntToObjectFunction<? super V,? extends R> function)
Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.<R> ImmutableList<R>
flatCollect(Function<? super V,? extends Iterable<R>> function)
flatCollect
is a special case ofRichIterable.collect(Function)
.default <P, R> ImmutableList<R>
flatCollectWith(Function2<? super V,? super P,? extends Iterable<R>> function, P parameter)
ImmutableSortedSetMultimap<V,K>
flip()
Given a map from Domain->
Range return a multimap from Range->
Domain.<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 toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.default <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.<P> PartitionImmutableList<V>
partitionWith(Predicate2<? super V,? super P> predicate, P parameter)
Filters a collection into a PartitionIterable 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 toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.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 Classclazz
.<P> ImmutableList<V>
selectWith(Predicate2<? super V,? super P> predicate, P parameter)
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.ImmutableSortedMap<K,V>
tap(Procedure<? super V> procedure)
Executes the Procedure for each value of the map and returnsthis
.MutableSortedMap<K,V>
toSortedMap()
<S> ImmutableList<Pair<V,S>>
zip(Iterable<S> that)
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs.ImmutableList<Pair<V,Integer>>
zipWithIndex()
Zips thisRichIterable
with its indices.Methods inherited from interface org.eclipse.collections.api.map.ImmutableMapIterable
countBy, countByEach, countByWith, flipUniqueValues
Methods inherited from interface org.eclipse.collections.api.map.MapIterable
containsKey, containsValue, detect, detectOptional, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getOrDefault, hashCode, ifPresentApply, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView
Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
collectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, indexOf, max, min, toStack, zip, zipWithIndex
Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable
asReversed, detectLastIndex, reverseForEach, reverseForEachWithIndex
Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsBy, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy
Methods inherited from interface org.eclipse.collections.api.map.sorted.SortedMapIterable
comparator, distinct, drop, dropWhile, partitionWhile, take, takeWhile, toImmutable, toReversed
-
Method Details
-
castToMap
- Specified by:
castToMap
in interfaceImmutableMapIterable<K,V>
-
castToSortedMap
-
flip
ImmutableSortedSetMultimap<V,K> flip()Description copied from interface:MapIterable
Given a map from Domain->
Range return a multimap from Range->
Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.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.
- Specified by:
flip
in interfaceImmutableMapIterable<K,V>
- Specified by:
flip
in interfaceMapIterable<K,V>
- Specified by:
flip
in interfaceSortedMapIterable<K,V>
-
newWithKeyValue
- Specified by:
newWithKeyValue
in interfaceImmutableMapIterable<K,V>
-
newWithAllKeyValues
ImmutableSortedMap<K,V> newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)- Specified by:
newWithAllKeyValues
in interfaceImmutableMapIterable<K,V>
-
newWithAllKeyValueArguments
ImmutableSortedMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)- Specified by:
newWithAllKeyValueArguments
in interfaceImmutableMapIterable<K,V>
-
newWithoutKey
- Specified by:
newWithoutKey
in interfaceImmutableMapIterable<K,V>
-
newWithoutAllKeys
- Specified by:
newWithoutAllKeys
in interfaceImmutableMapIterable<K,V>
-
toSortedMap
MutableSortedMap<K,V> toSortedMap() -
select
Description copied from interface:MapIterable
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.MapIterable<City, Person> selected = peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
select
in interfaceImmutableMapIterable<K,V>
- Specified by:
select
in interfaceMapIterable<K,V>
- Specified by:
select
in interfaceSortedMapIterable<K,V>
-
reject
Description copied from interface:MapIterable
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.MapIterable<City, Person> rejected = peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
reject
in interfaceImmutableMapIterable<K,V>
- Specified by:
reject
in interfaceMapIterable<K,V>
- Specified by:
reject
in interfaceSortedMapIterable<K,V>
-
tap
Description copied from interface:MapIterable
Executes the Procedure for each value of the map and returnsthis
.return peopleByCity.tap(person -> LOGGER.info(person.getName()));
- Specified by:
tap
in interfaceImmutableMapIterable<K,V>
- Specified by:
tap
in interfaceMapIterable<K,V>
- Specified by:
tap
in interfaceOrderedIterable<K>
- Specified by:
tap
in interfaceReversibleIterable<K>
- Specified by:
tap
in interfaceRichIterable<K>
- Specified by:
tap
in interfaceSortedMapIterable<K,V>
- See Also:
RichIterable.forEach(Procedure)
-
select
Description copied from interface:RichIterable
Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.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"); } });
- Specified by:
select
in interfaceImmutableMapIterable<K,V>
- Specified by:
select
in interfaceOrderedIterable<K>
- Specified by:
select
in interfaceReversibleIterable<K>
- Specified by:
select
in interfaceRichIterable<K>
- Specified by:
select
in interfaceSortedMapIterable<K,V>
-
selectWith
Description copied from interface:RichIterable
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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));
- Specified by:
selectWith
in interfaceImmutableMapIterable<K,V>
- Specified by:
selectWith
in interfaceOrderedIterable<K>
- Specified by:
selectWith
in interfaceReversibleIterable<K>
- Specified by:
selectWith
in interfaceRichIterable<K>
- Specified by:
selectWith
in interfaceSortedMapIterable<K,V>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
reject
Description copied from interface:RichIterable
Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).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"); } });
- Specified by:
reject
in interfaceImmutableMapIterable<K,V>
- Specified by:
reject
in interfaceOrderedIterable<K>
- Specified by:
reject
in interfaceReversibleIterable<K>
- Specified by:
reject
in interfaceRichIterable<K>
- Specified by:
reject
in interfaceSortedMapIterable<K,V>
- Parameters:
predicate
- aPredicate
to use as the reject criteria- Returns:
- a RichIterable that contains elements that cause
Predicate.accept(Object)
method to evaluate to false
-
rejectWith
Description copied from interface:RichIterable
Similar toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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));
- Specified by:
rejectWith
in interfaceImmutableMapIterable<K,V>
- Specified by:
rejectWith
in interfaceOrderedIterable<K>
- Specified by:
rejectWith
in interfaceReversibleIterable<K>
- Specified by:
rejectWith
in interfaceRichIterable<K>
- Specified by:
rejectWith
in interfaceSortedMapIterable<K,V>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
selectInstancesOf
Description copied from interface:RichIterable
Returns all elements of the source collection that are instances of the Classclazz
.RichIterable<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
- Specified by:
selectInstancesOf
in interfaceImmutableMapIterable<K,V>
- Specified by:
selectInstancesOf
in interfaceOrderedIterable<K>
- Specified by:
selectInstancesOf
in interfaceReversibleIterable<K>
- Specified by:
selectInstancesOf
in interfaceRichIterable<K>
- Specified by:
selectInstancesOf
in interfaceSortedMapIterable<K,V>
-
partition
Description copied from interface:RichIterable
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.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"); } });
- Specified by:
partition
in interfaceImmutableMapIterable<K,V>
- Specified by:
partition
in interfaceOrderedIterable<K>
- Specified by:
partition
in interfaceReversibleIterable<K>
- Specified by:
partition
in interfaceRichIterable<K>
- Specified by:
partition
in interfaceSortedMapIterable<K,V>
-
partitionWith
<P> PartitionImmutableList<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)Description copied from interface:RichIterable
Filters a collection into a PartitionIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return person.getAddress().getState().getName().equals(state); } }, "New York");
- Specified by:
partitionWith
in interfaceOrderedIterable<K>
- Specified by:
partitionWith
in interfaceReversibleIterable<K>
- Specified by:
partitionWith
in interfaceRichIterable<K>
- Specified by:
partitionWith
in interfaceSortedMapIterable<K,V>
-
collect
Description copied from interface:RichIterable
Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
RichIterable<String> names = people.collect(person -> person.getFirstName() + " " + person.getLastName());
Example using an anonymous inner class:
RichIterable<String> names = people.collect(new Function<Person, String>() { public String valueOf(Person person) { return person.getFirstName() + " " + person.getLastName(); } });
- Specified by:
collect
in interfaceOrderedIterable<K>
- Specified by:
collect
in interfaceReversibleIterable<K>
- Specified by:
collect
in interfaceRichIterable<K>
- Specified by:
collect
in interfaceSortedMapIterable<K,V>
-
collectWithIndex
default <R> ImmutableList<R> collectWithIndex(ObjectIntToObjectFunction<? super V,? extends R> function)Description copied from interface:OrderedIterable
Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.- Specified by:
collectWithIndex
in interfaceOrderedIterable<K>
- Specified by:
collectWithIndex
in interfaceReversibleIterable<K>
- Specified by:
collectWithIndex
in interfaceSortedMapIterable<K,V>
- Since:
- 9.1.
-
collectWith
<P, VV> ImmutableList<VV> collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)Description copied from interface:RichIterable
Same asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.Example using a Java 8 lambda expression:
RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
Example using an anonymous inner class:
Function2<Integer, Integer, Integer> addParameterFunction = new Function2<Integer, Integer, Integer>() { public Integer value(Integer each, Integer parameter) { return each + parameter; } }; RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
- Specified by:
collectWith
in interfaceOrderedIterable<K>
- Specified by:
collectWith
in interfaceReversibleIterable<K>
- Specified by:
collectWith
in interfaceRichIterable<K>
- Specified by:
collectWith
in interfaceSortedMapIterable<K,V>
- Parameters:
function
- AFunction2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argumentP
infunction
- Returns:
- A new
RichIterable
that contains the transformed elements returned byFunction2.value(Object, Object)
- See Also:
RichIterable.collect(Function)
-
collect
Description copied from interface:MapIterable
For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.MapIterable<String, String> collected = peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
- Specified by:
collect
in interfaceImmutableMapIterable<K,V>
- Specified by:
collect
in interfaceMapIterable<K,V>
- Specified by:
collect
in interfaceSortedMapIterable<K,V>
-
collectValues
Description copied from interface:MapIterable
For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.MapIterable<City, String> collected = peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
- Specified by:
collectValues
in interfaceImmutableMapIterable<K,V>
- Specified by:
collectValues
in interfaceMapIterable<K,V>
- Specified by:
collectValues
in interfaceSortedMapIterable<K,V>
-
collectIf
<R> ImmutableList<R> collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> function)Description copied from interface:RichIterable
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. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).Example using a Java 8 lambda and method reference:
RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
Example using Predicates factory:
RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
- Specified by:
collectIf
in interfaceOrderedIterable<K>
- Specified by:
collectIf
in interfaceReversibleIterable<K>
- Specified by:
collectIf
in interfaceRichIterable<K>
- Specified by:
collectIf
in interfaceSortedMapIterable<K,V>
-
flatCollect
Description copied from interface:RichIterable
flatCollect
is a special case ofRichIterable.collect(Function)
. Withcollect
, when theFunction
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 eachPerson
has a list ofAddress
objects. Take the followingFunction
:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
Usingcollect
returns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction);
UsingflatCollect
returns a single flattened list of addresses.RichIterable<Address> addresses = people.flatCollect(addressFunction);
- Specified by:
flatCollect
in interfaceOrderedIterable<K>
- Specified by:
flatCollect
in interfaceReversibleIterable<K>
- Specified by:
flatCollect
in interfaceRichIterable<K>
- Specified by:
flatCollect
in interfaceSortedMapIterable<K,V>
- Parameters:
function
- TheFunction
to apply- Returns:
- a new flattened collection produced by applying the given
function
-
flatCollectWith
default <P, R> ImmutableList<R> flatCollectWith(Function2<? super V,? super P,? extends Iterable<R>> function, P parameter)- Specified by:
flatCollectWith
in interfaceOrderedIterable<K>
- Specified by:
flatCollectWith
in interfaceReversibleIterable<K>
- Specified by:
flatCollectWith
in interfaceRichIterable<K>
- Specified by:
flatCollectWith
in interfaceSortedMapIterable<K,V>
- Since:
- 9.2
-
collectBoolean
Description copied from interface:RichIterable
Returns a new primitiveboolean
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.Example using a Java 8 lambda expression:
BooleanIterable licenses = people.collectBoolean(person -> person.hasDrivingLicense());
Example using an anonymous inner class:
BooleanIterable licenses = people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
- Specified by:
collectBoolean
in interfaceOrderedIterable<K>
- Specified by:
collectBoolean
in interfaceReversibleIterable<K>
- Specified by:
collectBoolean
in interfaceRichIterable<K>
- Specified by:
collectBoolean
in interfaceSortedMapIterable<K,V>
-
collectByte
Description copied from interface:RichIterable
Returns a new primitivebyte
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.Example using a Java 8 lambda expression:
ByteIterable bytes = people.collectByte(person -> person.getCode());
Example using an anonymous inner class:
ByteIterable bytes = people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
- Specified by:
collectByte
in interfaceOrderedIterable<K>
- Specified by:
collectByte
in interfaceReversibleIterable<K>
- Specified by:
collectByte
in interfaceRichIterable<K>
- Specified by:
collectByte
in interfaceSortedMapIterable<K,V>
-
collectChar
Description copied from interface:RichIterable
Returns a new primitivechar
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.Example using a Java 8 lambda expression:
CharIterable chars = people.collectChar(person -> person.getMiddleInitial());
Example using an anonymous inner class:
CharIterable chars = people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
- Specified by:
collectChar
in interfaceOrderedIterable<K>
- Specified by:
collectChar
in interfaceReversibleIterable<K>
- Specified by:
collectChar
in interfaceRichIterable<K>
- Specified by:
collectChar
in interfaceSortedMapIterable<K,V>
-
collectDouble
Description copied from interface:RichIterable
Returns a new primitivedouble
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.Example using a Java 8 lambda expression:
DoubleIterable doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
Example using an anonymous inner class:
DoubleIterable doubles = people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
- Specified by:
collectDouble
in interfaceOrderedIterable<K>
- Specified by:
collectDouble
in interfaceReversibleIterable<K>
- Specified by:
collectDouble
in interfaceRichIterable<K>
- Specified by:
collectDouble
in interfaceSortedMapIterable<K,V>
-
collectFloat
Description copied from interface:RichIterable
Returns a new primitivefloat
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.Example using a Java 8 lambda expression:
FloatIterable floats = people.collectFloat(person -> person.getHeightInInches());
Example using an anonymous inner class:
FloatIterable floats = people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
- Specified by:
collectFloat
in interfaceOrderedIterable<K>
- Specified by:
collectFloat
in interfaceReversibleIterable<K>
- Specified by:
collectFloat
in interfaceRichIterable<K>
- Specified by:
collectFloat
in interfaceSortedMapIterable<K,V>
-
collectInt
Description copied from interface:RichIterable
Returns a new primitiveint
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.Example using a Java 8 lambda expression:
IntIterable ints = people.collectInt(person -> person.getAge());
Example using an anonymous inner class:
IntIterable ints = people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
- Specified by:
collectInt
in interfaceOrderedIterable<K>
- Specified by:
collectInt
in interfaceReversibleIterable<K>
- Specified by:
collectInt
in interfaceRichIterable<K>
- Specified by:
collectInt
in interfaceSortedMapIterable<K,V>
-
collectLong
Description copied from interface:RichIterable
Returns a new primitivelong
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.Example using a Java 8 lambda expression:
LongIterable longs = people.collectLong(person -> person.getGuid());
Example using an anonymous inner class:
LongIterable longs = people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
- Specified by:
collectLong
in interfaceOrderedIterable<K>
- Specified by:
collectLong
in interfaceReversibleIterable<K>
- Specified by:
collectLong
in interfaceRichIterable<K>
- Specified by:
collectLong
in interfaceSortedMapIterable<K,V>
-
collectShort
Description copied from interface:RichIterable
Returns a new primitiveshort
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.Example using a Java 8 lambda expression:
ShortIterable shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
Example using an anonymous inner class:
ShortIterable shorts = people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
- Specified by:
collectShort
in interfaceOrderedIterable<K>
- Specified by:
collectShort
in interfaceReversibleIterable<K>
- Specified by:
collectShort
in interfaceRichIterable<K>
- Specified by:
collectShort
in interfaceSortedMapIterable<K,V>
-
zip
Description copied from interface:RichIterable
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs. If one of the twoRichIterable
s is longer than the other, its remaining elements are ignored.- Specified by:
zip
in interfaceImmutableMapIterable<K,V>
- Specified by:
zip
in interfaceOrderedIterable<K>
- Specified by:
zip
in interfaceReversibleIterable<K>
- Specified by:
zip
in interfaceRichIterable<K>
- Specified by:
zip
in interfaceSortedMapIterable<K,V>
- Type Parameters:
S
- the type of the second half of the returned pairs- Parameters:
that
- TheRichIterable
providing the second half of each result pair- Returns:
- A new
RichIterable
containing pairs consisting of corresponding elements of thisRichIterable
and that. The length of the returnedRichIterable
is the minimum of the lengths of thisRichIterable
and that.
-
zipWithIndex
ImmutableList<Pair<V,Integer>> zipWithIndex()Description copied from interface:RichIterable
Zips thisRichIterable
with its indices.- Specified by:
zipWithIndex
in interfaceImmutableMapIterable<K,V>
- Specified by:
zipWithIndex
in interfaceOrderedIterable<K>
- Specified by:
zipWithIndex
in interfaceReversibleIterable<K>
- Specified by:
zipWithIndex
in interfaceRichIterable<K>
- Specified by:
zipWithIndex
in interfaceSortedMapIterable<K,V>
- Returns:
- A new
RichIterable
containing pairs consisting of all elements of thisRichIterable
paired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
groupBy
Description copied from interface:RichIterable
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.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(); } });
- Specified by:
groupBy
in interfaceImmutableMapIterable<K,V>
- Specified by:
groupBy
in interfaceOrderedIterable<K>
- Specified by:
groupBy
in interfaceReversibleIterable<K>
- Specified by:
groupBy
in interfaceRichIterable<K>
- Specified by:
groupBy
in interfaceSortedMapIterable<K,V>
-
groupByEach
<VV> ImmutableListMultimap<VV,V> groupByEach(Function<? super V,? extends Iterable<VV>> function)Description copied from interface:RichIterable
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.- Specified by:
groupByEach
in interfaceImmutableMapIterable<K,V>
- Specified by:
groupByEach
in interfaceOrderedIterable<K>
- Specified by:
groupByEach
in interfaceReversibleIterable<K>
- Specified by:
groupByEach
in interfaceRichIterable<K>
- Specified by:
groupByEach
in interfaceSortedMapIterable<K,V>
-
groupByUniqueKey
Description copied from interface:RichIterable
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. The generated keys must each be unique, or else an exception is thrown.- Specified by:
groupByUniqueKey
in interfaceImmutableMapIterable<K,V>
- Specified by:
groupByUniqueKey
in interfaceRichIterable<K>
- See Also:
RichIterable.groupBy(Function)
-
aggregateInPlaceBy
default <KK, VV> ImmutableMap<KK,VV> aggregateInPlaceBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Procedure2<? super VV,? super V> mutatingAggregator)Description copied from interface:RichIterable
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).- Specified by:
aggregateInPlaceBy
in interfaceImmutableMapIterable<K,V>
- Specified by:
aggregateInPlaceBy
in interfaceRichIterable<K>
-
aggregateBy
default <KK, VV> ImmutableMap<KK,VV> aggregateBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Function2<? super VV,? super V,? extends VV> nonMutatingAggregator)Description copied from interface:RichIterable
Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).- Specified by:
aggregateBy
in interfaceImmutableMapIterable<K,V>
- Specified by:
aggregateBy
in interfaceRichIterable<K>
-
aggregateBy
default <K1, V1, V2> ImmutableMap<K1,V2> aggregateBy(Function<? super K,? extends K1> keyFunction, Function<? super V,? extends V1> valueFunction, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V1,? extends V2> nonMutatingAggregator)Description copied from interface:MapIterable
Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with.MapIterable<String, Interval> map = Maps.mutable.with("oneToFive", Interval.fromTo(1, 5), "sixToNine", Interval.fromTo(6, 9)); MapIterable<String, Long> result = map.aggregateBy( eachKey -> { return eachKey.equals("oneToFive") ? "lessThanSix" : "greaterOrEqualsToSix"; }, each -> each.sumOfInt(Integer::intValue), () -> 0L, (argument1, argument2) -> argument1 + argument2); MapIterable<String, Long> expected = Maps.mutable.with("lessThanSix", Interval.fromTo(1, 5).sumOfInt(Integer::intValue), "greaterOrEqualsToSix", Interval.fromTo(6, 9).sumOfInt(Integer::intValue)); Assert.assertEquals(expected, result);
- Specified by:
aggregateBy
in interfaceImmutableMapIterable<K,V>
- Specified by:
aggregateBy
in interfaceMapIterable<K,V>
-