public interface SortedMapIterable<K,V> extends MapIterable<K,V>, ReversibleIterable<V>
| Modifier and Type | Method and Description |
|---|---|
<V1> ListIterable<V1> |
collect(Function<? super V,? extends V1> function)
Returns a new collection with the results of applying the specified function on each element of the source
collection.
|
<K2,V2> UnsortedMapIterable<K2,V2> |
collect(Function2<? super K,? super V,Pair<K2,V2>> function)
For each key and value of the map the function is evaluated.
|
BooleanList |
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. |
ByteList |
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. |
CharList |
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. |
DoubleList |
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. |
FloatList |
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. |
<V1> ListIterable<V1> |
collectIf(Predicate<? super V> predicate,
Function<? super V,? extends V1> 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.
|
IntList |
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. |
LongList |
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. |
ShortList |
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> SortedMapIterable<K,R> |
collectValues(Function2<? super K,? super V,? extends R> function)
For each key and value of the map the function is evaluated.
|
<P,V1> ListIterable<V1> |
collectWith(Function2<? super V,? super P,? extends V1> function,
P parameter)
Same as
RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block. |
default <V1> ListIterable<V1> |
collectWithIndex(ObjectIntToObjectFunction<? super V,? extends V1> function)
Returns a new OrderedIterable using results obtained by applying the specified function to each element
and its corresponding index.
|
Comparator<? super K> |
comparator() |
ListIterable<V> |
distinct()
Returns a new
OrderedIterable containing the distinct elements in this iterable. |
SortedMapIterable<K,V> |
drop(int count)
Returns an iterable after skipping the first
count elements
or an empty iterable if the count is greater than the length of the iterable. |
SortedMapIterable<K,V> |
dropWhile(Predicate<? super V> predicate)
Returns the final elements that do not satisfy the Predicate.
|
<V1> ListIterable<V1> |
flatCollect(Function<? super V,? extends Iterable<V1>> function)
flatCollect is a special case of RichIterable.collect(Function). |
default <P,V1> ListIterable<V1> |
flatCollectWith(Function2<? super V,? super P,? extends Iterable<V1>> function,
P parameter) |
SortedSetMultimap<V,K> |
flip()
Given a map from Domain
-> Range return a multimap from Range -> Domain. |
<VV> ListMultimap<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> ListMultimap<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. |
PartitionList<V> |
partition(Predicate<? super V> predicate)
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
PartitionList<V> |
partitionWhile(Predicate<? super V> predicate)
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
|
<P> PartitionList<V> |
partitionWith(Predicate2<? super V,? super P> predicate,
P parameter)
Filters a collection into a PartitionIterable based on the evaluation of the predicate.
|
ListIterable<V> |
reject(Predicate<? super V> predicate)
Returns all elements of the source collection that return false when evaluating of the predicate.
|
SortedMapIterable<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> ListIterable<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. |
ListIterable<V> |
select(Predicate<? super V> predicate)
Returns all elements of the source collection that return true when evaluating the predicate.
|
SortedMapIterable<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> ListIterable<S> |
selectInstancesOf(Class<S> clazz)
Returns all elements of the source collection that are instances of the Class
clazz. |
<P> ListIterable<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. |
SortedMapIterable<K,V> |
take(int count)
Returns the first
count elements of the iterable
or all the elements in the iterable if count is greater than the length of
the iterable. |
SortedMapIterable<K,V> |
takeWhile(Predicate<? super V> predicate)
Returns the initial elements that satisfy the Predicate.
|
SortedMapIterable<K,V> |
tap(Procedure<? super V> procedure)
Executes the Procedure for each value of the map and returns
this. |
ImmutableSortedMap<K,V> |
toImmutable()
Converts the SortedMapIterable to an immutable implementation.
|
SortedMapIterable<K,V> |
toReversed()
Returns a new ReversibleIterable in reverse order.
|
<S> ListIterable<Pair<V,S>> |
zip(Iterable<S> that)
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
ListIterable<Pair<V,Integer>> |
zipWithIndex()
Zips this
RichIterable with its indices. |
aggregateBy, containsKey, containsValue, detect, detectOptional, equals, flipUniqueValues, forEach, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getOrDefault, hashCode, ifPresentApply, injectIntoKeyValue, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesViewasReversed, detectLastIndex, reverseForEach, reverseForEachWithIndexcollectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, indexOf, max, min, rejectWithIndex, selectWithIndex, toStack, zip, zipWithIndexaggregateBy, aggregateBy, aggregateInPlaceBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countBy, countByEach, countByEach, countByWith, 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, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, 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, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetByforEach, forEachWithComparator<? super K> comparator()
SortedSetMultimap<V,K> flip()
MapIterable-> 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.
flip in interface MapIterable<K,V>SortedMapIterable<K,V> select(Predicate2<? super K,? super V> predicate)
MapIterable
MapIterable<City, Person> selected =
peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
select in interface MapIterable<K,V>SortedMapIterable<K,V> reject(Predicate2<? super K,? super V> predicate)
MapIterable
MapIterable<City, Person> rejected =
peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
reject in interface MapIterable<K,V><K2,V2> UnsortedMapIterable<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)
MapIterable
MapIterable<String, String> collected =
peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
collect in interface MapIterable<K,V><R> SortedMapIterable<K,R> collectValues(Function2<? super K,? super V,? extends R> function)
MapIterable
MapIterable<City, String> collected =
peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
collectValues in interface MapIterable<K,V>SortedMapIterable<K,V> tap(Procedure<? super V> procedure)
MapIterablethis.
return peopleByCity.tap(person -> LOGGER.info(person.getName()));
tap in interface MapIterable<K,V>tap in interface OrderedIterable<V>tap in interface ReversibleIterable<V>tap in interface RichIterable<V>RichIterable.forEach(Procedure)ListIterable<V> select(Predicate<? super V> predicate)
RichIterableExample using a Java 8 lambda expression:
RichIterable<Person> selected =
people.select(person -> person.getAddress().getCity().equals("London"));
select in interface OrderedIterable<V>select in interface ReversibleIterable<V>select in interface RichIterable<V><P> ListIterable<V> selectWith(Predicate2<? super V,? super P> predicate, P parameter)
RichIterableRichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
Example using a Java 8 lambda expression:
RichIterable<Person> selected =
people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));
selectWith in interface OrderedIterable<V>selectWith in interface ReversibleIterable<V>selectWith in interface RichIterable<V>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)ListIterable<V> reject(Predicate<? super V> predicate)
RichIterableExample using a Java 8 lambda expression:
RichIterable<Person> rejected =
people.reject(person -> person.person.getLastName().equals("Smith"));
reject in interface OrderedIterable<V>reject in interface ReversibleIterable<V>reject in interface RichIterable<V>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to false<P> ListIterable<V> rejectWith(Predicate2<? super V,? super P> predicate, P parameter)
RichIterableRichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
Example using a Java 8 lambda expression:
RichIterable<Person> rejected =
people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
rejectWith in interface OrderedIterable<V>rejectWith in interface ReversibleIterable<V>rejectWith in interface RichIterable<V>predicate - a Predicate2 to use as the select criteriaparameter - a parameter to pass in for evaluation of the second argument P in predicateRichIterable.select(Predicate)PartitionList<V> partition(Predicate<? super V> predicate)
RichIterableExample using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers =
people.partition(person -> person.getAddress().getState().getName().equals("New York"));
partition in interface OrderedIterable<V>partition in interface ReversibleIterable<V>partition in interface RichIterable<V><P> PartitionList<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)
RichIterableExample using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers =
people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
partitionWith in interface OrderedIterable<V>partitionWith in interface ReversibleIterable<V>partitionWith in interface RichIterable<V><S> ListIterable<S> selectInstancesOf(Class<S> clazz)
RichIterableclazz.
RichIterable<Integer> integers =
List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
selectInstancesOf in interface OrderedIterable<V>selectInstancesOf in interface ReversibleIterable<V>selectInstancesOf in interface RichIterable<V><V1> ListIterable<V1> collect(Function<? super V,? extends V1> function)
RichIterableExample using a Java 8 lambda expression:
RichIterable<String> names =
people.collect(person -> person.getFirstName() + " " + person.getLastName());
collect in interface OrderedIterable<V>collect in interface ReversibleIterable<V>collect in interface RichIterable<V>default <V1> ListIterable<V1> collectWithIndex(ObjectIntToObjectFunction<? super V,? extends V1> function)
OrderedIterablecollectWithIndex in interface OrderedIterable<V>collectWithIndex in interface ReversibleIterable<V>BooleanList 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.
Example using a Java 8 lambda expression:
BooleanIterable licenses =
people.collectBoolean(person -> person.hasDrivingLicense());
collectBoolean in interface OrderedIterable<V>collectBoolean in interface ReversibleIterable<V>collectBoolean in interface RichIterable<V>ByteList 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.
Example using a Java 8 lambda expression:
ByteIterable bytes =
people.collectByte(person -> person.getCode());
collectByte in interface OrderedIterable<V>collectByte in interface ReversibleIterable<V>collectByte in interface RichIterable<V>CharList 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.
Example using a Java 8 lambda expression:
CharIterable chars =
people.collectChar(person -> person.getMiddleInitial());
collectChar in interface OrderedIterable<V>collectChar in interface ReversibleIterable<V>collectChar in interface RichIterable<V>DoubleList 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.
Example using a Java 8 lambda expression:
DoubleIterable doubles =
people.collectDouble(person -> person.getMilesFromNorthPole());
collectDouble in interface OrderedIterable<V>collectDouble in interface ReversibleIterable<V>collectDouble in interface RichIterable<V>FloatList 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.
Example using a Java 8 lambda expression:
FloatIterable floats =
people.collectFloat(person -> person.getHeightInInches());
collectFloat in interface OrderedIterable<V>collectFloat in interface ReversibleIterable<V>collectFloat in interface RichIterable<V>IntList 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.
Example using a Java 8 lambda expression:
IntIterable ints =
people.collectInt(person -> person.getAge());
collectInt in interface OrderedIterable<V>collectInt in interface ReversibleIterable<V>collectInt in interface RichIterable<V>LongList 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.
Example using a Java 8 lambda expression:
LongIterable longs =
people.collectLong(person -> person.getGuid());
collectLong in interface OrderedIterable<V>collectLong in interface ReversibleIterable<V>collectLong in interface RichIterable<V>ShortList 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.
Example using a Java 8 lambda expression:
ShortIterable shorts =
people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
collectShort in interface OrderedIterable<V>collectShort in interface ReversibleIterable<V>collectShort in interface RichIterable<V><P,V1> ListIterable<V1> collectWith(Function2<? super V,? super P,? extends V1> function, P parameter)
RichIterableRichIterable.collect(Function) with a Function2 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));
collectWith in interface OrderedIterable<V>collectWith in interface ReversibleIterable<V>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 functionRichIterable that contains the transformed elements returned by Function2.value(Object, Object)RichIterable.collect(Function)<V1> ListIterable<V1> collectIf(Predicate<? super V> predicate, Function<? super V,? extends V1> function)
RichIterableExample 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());
collectIf in interface OrderedIterable<V>collectIf in interface ReversibleIterable<V>collectIf in interface RichIterable<V><V1> ListIterable<V1> flatCollect(Function<? super V,? extends Iterable<V1>> 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 = Person::getAddresses; RichIterable<Person> people = ...;Using
collect returns a collection of collections of addresses.
RichIterable<List<Address>> addresses = people.collect(addressFunction);Using
flatCollect returns a single flattened list of addresses.
RichIterable<Address> addresses = people.flatCollect(addressFunction);
flatCollect in interface OrderedIterable<V>flatCollect in interface ReversibleIterable<V>flatCollect in interface RichIterable<V>function - The Function to applyfunctiondefault <P,V1> ListIterable<V1> flatCollectWith(Function2<? super V,? super P,? extends Iterable<V1>> function, P parameter)
flatCollectWith in interface OrderedIterable<V>flatCollectWith in interface ReversibleIterable<V>flatCollectWith in interface RichIterable<V><S> ListIterable<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 OrderedIterable<V>zip in interface ReversibleIterable<V>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.ListIterable<Pair<V,Integer>> zipWithIndex()
RichIterableRichIterable with its indices.zipWithIndex in interface OrderedIterable<V>zipWithIndex in interface ReversibleIterable<V>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> ListMultimap<VV,V> groupBy(Function<? super V,? extends VV> function)
RichIterableExample using a Java 8 method reference:
Multimap<String, Person> peopleByLastName =
people.groupBy(Person::getLastName);
groupBy in interface OrderedIterable<V>groupBy in interface ReversibleIterable<V>groupBy in interface RichIterable<V><VV> ListMultimap<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 OrderedIterable<V>groupByEach in interface ReversibleIterable<V>groupByEach in interface RichIterable<V>SortedMapIterable<K,V> toReversed()
ReversibleIterabletoReversed in interface ReversibleIterable<V>SortedMapIterable<K,V> take(int count)
ReversibleIterablecount elements of the iterable
or all the elements in the iterable if count is greater than the length of
the iterable.take in interface ReversibleIterable<V>count - the number of items to take.SortedMapIterable<K,V> takeWhile(Predicate<? super V> predicate)
ReversibleIterabletakeWhile in interface OrderedIterable<V>takeWhile in interface ReversibleIterable<V>SortedMapIterable<K,V> drop(int count)
ReversibleIterablecount elements
or an empty iterable if the count is greater than the length of the iterable.drop in interface ReversibleIterable<V>count - the number of items to drop.SortedMapIterable<K,V> dropWhile(Predicate<? super V> predicate)
ReversibleIterabledropWhile in interface OrderedIterable<V>dropWhile in interface ReversibleIterable<V>PartitionList<V> partitionWhile(Predicate<? super V> predicate)
OrderedIterablepartitionWhile in interface OrderedIterable<V>partitionWhile in interface ReversibleIterable<V>ListIterable<V> distinct()
OrderedIterableOrderedIterable containing the distinct elements in this iterable.
Conceptually similar to RichIterable.toSet().RichIterable.toList() but retains the original order. If an element appears
multiple times in this iterable, the first one will be copied into the result.
distinct in interface OrderedIterable<V>distinct in interface ReversibleIterable<V>OrderedIterable of distinct elementsImmutableSortedMap<K,V> toImmutable()
toImmutable in interface MapIterable<K,V>Copyright © 2004–2023. All rights reserved.