Iterable<K>
, Map<K,V>
, SortedMap<K,V>
, InternalIterable<K>
, ImmutableMapIterable<K,V>
, MapIterable<K,V>
, ImmutableSortedMap<K,V>
, SortedMapIterable<K,V>
, OrderedIterable<K>
, ReversibleIterable<K>
, RichIterable<K>
ImmutableTreeMap
public abstract class AbstractImmutableSortedMap<K,V> extends AbstractMapIterable<K,V> implements ImmutableSortedMap<K,V>, SortedMap<K,V>
Constructor | Description |
---|---|
AbstractImmutableSortedMap() |
Modifier and Type | Method | 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.
|
LazyIterable<V> |
asReversed() |
Returns a reversed view of this ReversibleIterable.
|
SortedMap<K,V> |
castToMap() |
|
SortedMap<K,V> |
castToSortedMap() |
|
void |
clear() |
|
<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 primitive
boolean 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 primitive
byte 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 primitive
char 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 primitive
double 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 primitive
float 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 primitive
int 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 primitive
long 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 primitive
short 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 as
RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block. |
<S> boolean |
corresponds(OrderedIterable<S> other,
Predicate2<? super V,? super S> predicate) |
Returns true if both OrderedIterables have the same length
and
predicate returns true for all corresponding elements e1 of
this OrderedIterable and e2 of other . |
<V1> ImmutableBag<V1> |
countBy(Function<? super V,? extends V1> function) |
This method will count the number of occurrences of each value calculated by applying the
function to each element of the collection.
|
<V1> ImmutableBag<V1> |
countByEach(Function<? super V,? extends Iterable<V1>> function) |
This method will count the number of occurrences of each value calculated by applying the
function to each element of the collection.
|
<V1,P> ImmutableBag<V1> |
countByWith(Function2<? super V,? super P,? extends V1> function,
P parameter) |
This method will count the number of occurrences of each value calculated by applying the
function to each element of the collection with the specified parameter as the second argument.
|
Pair<K,V> |
detect(Predicate2<? super K,? super V> predicate) |
Return the first key and value of the map for which the predicate evaluates to true when they are given
as arguments.
|
int |
detectIndex(Predicate<? super V> predicate) |
Returns the index of the first element of the
OrderedIterable for which the predicate evaluates to true. |
int |
detectLastIndex(Predicate<? super V> predicate) |
Returns the index of the last element of the
ReversibleIterable for which the predicate evaluates to true. |
Optional<Pair<K,V>> |
detectOptional(Predicate2<? super K,? super V> predicate) |
Return the first key and value of the map as an Optional for which the predicate evaluates to true when
they are given as arguments.
|
ImmutableList<V> |
distinct() |
Returns a new
OrderedIterable containing the distinct elements in this iterable. |
ImmutableSortedMap<K,V> |
dropWhile(Predicate<? super V> predicate) |
Returns the final elements that do not satisfy the Predicate.
|
<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. |
void |
forEach(int startIndex,
int endIndex,
Procedure<? super V> procedure) |
Iterates over the section of the iterable covered by the specified inclusive indexes.
|
void |
forEachWithIndex(int fromIndex,
int toIndex,
ObjectIntProcedure<? super V> objectIntProcedure) |
Iterates over the section of the iterable covered by the specified inclusive indexes.
|
<R> ImmutableListMultimap<R,V> |
groupBy(Function<? super V,? extends R> 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.
|
<R> ImmutableListMultimap<R,V> |
groupByEach(Function<? super V,? extends Iterable<R>> 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.
|
SortedMap<K,V> |
headMap(K toKey) |
|
int |
indexOf(Object object) |
Returns the index of the first occurrence of the specified item
in this iterable, or -1 if this iterable does not contain the item.
|
Iterator<V> |
iterator() |
|
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.
|
PartitionImmutableList<V> |
partitionWhile(Predicate<? super V> predicate) |
Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
|
<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.
|
V |
put(K key,
V value) |
|
void |
putAll(Map<? extends K,? extends V> map) |
|
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 . |
V |
remove(Object key) |
|
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 . |
SortedMap<K,V> |
subMap(K fromKey,
K toKey) |
|
<V1> ImmutableObjectDoubleMap<V1> |
sumByDouble(Function<? super V,? extends V1> groupBy,
DoubleFunction<? super V> function) |
Groups and sums the values using the two specified functions.
|
<V1> ImmutableObjectDoubleMap<V1> |
sumByFloat(Function<? super V,? extends V1> groupBy,
FloatFunction<? super V> function) |
Groups and sums the values using the two specified functions.
|
<V1> ImmutableObjectLongMap<V1> |
sumByInt(Function<? super V,? extends V1> groupBy,
IntFunction<? super V> function) |
Groups and sums the values using the two specified functions.
|
<V1> ImmutableObjectLongMap<V1> |
sumByLong(Function<? super V,? extends V1> groupBy,
LongFunction<? super V> function) |
Groups and sums the values using the two specified functions.
|
SortedMap<K,V> |
tailMap(K fromKey) |
|
ImmutableSortedMap<K,V> |
takeWhile(Predicate<? super V> predicate) |
Returns the initial elements that satisfy the Predicate.
|
ImmutableSortedMap<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.
|
ImmutableSortedMap<K,V> |
toReversed() |
Returns a new ReversibleIterable in reverse order.
|
MutableSortedMap<K,V> |
toSortedMap() |
|
MutableStack<V> |
toStack() |
Converts the OrderedIterable to a mutable MutableStack implementation.
|
<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. |
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asLazy, chunk, contains, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, getOnly, ifPresentApply, noneSatisfy, noneSatisfyWith, toArray, toArray
appendString, appendString, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, max, max, maxBy, min, min, minBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex
flipUniqueValues
collectWithIndex, flatCollectWith
forEach, forEachWith
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entry, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putIfAbsent, remove, replace, replace, replaceAll, size
containsKey, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
collectWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, max, min, zip, zipWithIndex
reverseForEach, reverseForEachWithIndex
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectWith, forEach, getAny, getOnly, groupBy, 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, 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
comparator, entrySet, firstKey, keySet, lastKey, values
comparator, drop, take
public SortedMap<K,V> castToMap()
castToMap
in interface ImmutableMapIterable<K,V>
castToMap
in interface ImmutableSortedMap<K,V>
public SortedMap<K,V> castToSortedMap()
castToSortedMap
in interface ImmutableSortedMap<K,V>
public MutableSortedMap<K,V> toSortedMap()
toSortedMap
in interface ImmutableSortedMap<K,V>
public ImmutableSortedMap<K,V> toImmutable()
SortedMapIterable
toImmutable
in interface MapIterable<K,V>
toImmutable
in interface SortedMapIterable<K,V>
public ImmutableSortedMap<K,V> newWithKeyValue(K key, V value)
newWithKeyValue
in interface ImmutableMapIterable<K,V>
newWithKeyValue
in interface ImmutableSortedMap<K,V>
public ImmutableSortedMap<K,V> newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
newWithAllKeyValues
in interface ImmutableMapIterable<K,V>
newWithAllKeyValues
in interface ImmutableSortedMap<K,V>
public ImmutableSortedMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
newWithAllKeyValueArguments
in interface ImmutableMapIterable<K,V>
newWithAllKeyValueArguments
in interface ImmutableSortedMap<K,V>
public ImmutableSortedMap<K,V> newWithoutKey(K key)
newWithoutKey
in interface ImmutableMapIterable<K,V>
newWithoutKey
in interface ImmutableSortedMap<K,V>
public ImmutableSortedMap<K,V> newWithoutAllKeys(Iterable<? extends K> keys)
newWithoutAllKeys
in interface ImmutableMapIterable<K,V>
newWithoutAllKeys
in interface ImmutableSortedMap<K,V>
public ImmutableSortedSetMultimap<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 ImmutableMapIterable<K,V>
flip
in interface ImmutableSortedMap<K,V>
flip
in interface MapIterable<K,V>
flip
in interface SortedMapIterable<K,V>
public ImmutableSortedMap<K,V> tap(Procedure<? super V> procedure)
MapIterable
this
.
return peopleByCity.tap(person -> LOGGER.info(person.getName()));
tap
in interface ImmutableMapIterable<K,V>
tap
in interface ImmutableSortedMap<K,V>
tap
in interface MapIterable<K,V>
tap
in interface OrderedIterable<K>
tap
in interface ReversibleIterable<K>
tap
in interface RichIterable<K>
tap
in interface SortedMapIterable<K,V>
RichIterable.forEach(Procedure)
public ImmutableList<V> select(Predicate<? super V> predicate)
RichIterable
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"); } });
select
in interface ImmutableMapIterable<K,V>
select
in interface ImmutableSortedMap<K,V>
select
in interface OrderedIterable<K>
select
in interface ReversibleIterable<K>
select
in interface RichIterable<K>
select
in interface SortedMapIterable<K,V>
public <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
.
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));
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));
selectWith
in interface ImmutableMapIterable<K,V>
selectWith
in interface ImmutableSortedMap<K,V>
selectWith
in interface OrderedIterable<K>
selectWith
in interface ReversibleIterable<K>
selectWith
in interface RichIterable<K>
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)
public ImmutableSortedMap<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 ImmutableMapIterable<K,V>
select
in interface ImmutableSortedMap<K,V>
select
in interface MapIterable<K,V>
select
in interface SortedMapIterable<K,V>
public ImmutableList<V> reject(Predicate<? super V> predicate)
RichIterable
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"); } });
reject
in interface ImmutableMapIterable<K,V>
reject
in interface ImmutableSortedMap<K,V>
reject
in interface OrderedIterable<K>
reject
in interface ReversibleIterable<K>
reject
in interface RichIterable<K>
reject
in interface SortedMapIterable<K,V>
predicate
- a Predicate
to use as the reject criteriaPredicate.accept(Object)
method to evaluate to falsepublic <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
.
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));
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));
rejectWith
in interface ImmutableMapIterable<K,V>
rejectWith
in interface ImmutableSortedMap<K,V>
rejectWith
in interface OrderedIterable<K>
rejectWith
in interface ReversibleIterable<K>
rejectWith
in interface RichIterable<K>
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)
public ImmutableSortedMap<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 ImmutableMapIterable<K,V>
reject
in interface ImmutableSortedMap<K,V>
reject
in interface MapIterable<K,V>
reject
in interface SortedMapIterable<K,V>
public PartitionImmutableList<V> partition(Predicate<? super V> predicate)
RichIterable
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"); } });
partition
in interface ImmutableMapIterable<K,V>
partition
in interface ImmutableSortedMap<K,V>
partition
in interface OrderedIterable<K>
partition
in interface ReversibleIterable<K>
partition
in interface RichIterable<K>
partition
in interface SortedMapIterable<K,V>
public <P> PartitionImmutableList<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)
RichIterable
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");
partitionWith
in interface ImmutableSortedMap<K,V>
partitionWith
in interface OrderedIterable<K>
partitionWith
in interface ReversibleIterable<K>
partitionWith
in interface RichIterable<K>
partitionWith
in interface SortedMapIterable<K,V>
public <S> ImmutableList<S> selectInstancesOf(Class<S> clazz)
RichIterable
clazz
.
RichIterable<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
selectInstancesOf
in interface ImmutableMapIterable<K,V>
selectInstancesOf
in interface ImmutableSortedMap<K,V>
selectInstancesOf
in interface OrderedIterable<K>
selectInstancesOf
in interface ReversibleIterable<K>
selectInstancesOf
in interface RichIterable<K>
selectInstancesOf
in interface SortedMapIterable<K,V>
public <R> ImmutableList<R> collect(Function<? super V,? extends R> function)
RichIterable
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(); } });
collect
in interface ImmutableSortedMap<K,V>
collect
in interface OrderedIterable<K>
collect
in interface ReversibleIterable<K>
collect
in interface RichIterable<K>
collect
in interface SortedMapIterable<K,V>
public ImmutableBooleanList collectBoolean(BooleanFunction<? super V> booleanFunction)
RichIterable
boolean
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(); } });
collectBoolean
in interface ImmutableSortedMap<K,V>
collectBoolean
in interface OrderedIterable<K>
collectBoolean
in interface ReversibleIterable<K>
collectBoolean
in interface RichIterable<K>
collectBoolean
in interface SortedMapIterable<K,V>
public ImmutableByteList collectByte(ByteFunction<? super V> byteFunction)
RichIterable
byte
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(); } });
collectByte
in interface ImmutableSortedMap<K,V>
collectByte
in interface OrderedIterable<K>
collectByte
in interface ReversibleIterable<K>
collectByte
in interface RichIterable<K>
collectByte
in interface SortedMapIterable<K,V>
public ImmutableCharList collectChar(CharFunction<? super V> charFunction)
RichIterable
char
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(); } });
collectChar
in interface ImmutableSortedMap<K,V>
collectChar
in interface OrderedIterable<K>
collectChar
in interface ReversibleIterable<K>
collectChar
in interface RichIterable<K>
collectChar
in interface SortedMapIterable<K,V>
public ImmutableDoubleList collectDouble(DoubleFunction<? super V> doubleFunction)
RichIterable
double
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(); } });
collectDouble
in interface ImmutableSortedMap<K,V>
collectDouble
in interface OrderedIterable<K>
collectDouble
in interface ReversibleIterable<K>
collectDouble
in interface RichIterable<K>
collectDouble
in interface SortedMapIterable<K,V>
public ImmutableFloatList collectFloat(FloatFunction<? super V> floatFunction)
RichIterable
float
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(); } });
collectFloat
in interface ImmutableSortedMap<K,V>
collectFloat
in interface OrderedIterable<K>
collectFloat
in interface ReversibleIterable<K>
collectFloat
in interface RichIterable<K>
collectFloat
in interface SortedMapIterable<K,V>
public ImmutableIntList collectInt(IntFunction<? super V> intFunction)
RichIterable
int
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(); } });
collectInt
in interface ImmutableSortedMap<K,V>
collectInt
in interface OrderedIterable<K>
collectInt
in interface ReversibleIterable<K>
collectInt
in interface RichIterable<K>
collectInt
in interface SortedMapIterable<K,V>
public ImmutableLongList collectLong(LongFunction<? super V> longFunction)
RichIterable
long
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(); } });
collectLong
in interface ImmutableSortedMap<K,V>
collectLong
in interface OrderedIterable<K>
collectLong
in interface ReversibleIterable<K>
collectLong
in interface RichIterable<K>
collectLong
in interface SortedMapIterable<K,V>
public ImmutableShortList collectShort(ShortFunction<? super V> shortFunction)
RichIterable
short
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(); } });
collectShort
in interface ImmutableSortedMap<K,V>
collectShort
in interface OrderedIterable<K>
collectShort
in interface ReversibleIterable<K>
collectShort
in interface RichIterable<K>
collectShort
in interface SortedMapIterable<K,V>
public <K2,V2> ImmutableMap<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 ImmutableMapIterable<K,V>
collect
in interface ImmutableSortedMap<K,V>
collect
in interface MapIterable<K,V>
collect
in interface SortedMapIterable<K,V>
public <P,VV> ImmutableList<VV> collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)
RichIterable
RichIterable.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));
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));
collectWith
in interface ImmutableSortedMap<K,V>
collectWith
in interface OrderedIterable<K>
collectWith
in interface ReversibleIterable<K>
collectWith
in interface RichIterable<K>
collectWith
in interface SortedMapIterable<K,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)
public <R> ImmutableList<R> collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> function)
RichIterable
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());
collectIf
in interface ImmutableSortedMap<K,V>
collectIf
in interface OrderedIterable<K>
collectIf
in interface ReversibleIterable<K>
collectIf
in interface RichIterable<K>
collectIf
in interface SortedMapIterable<K,V>
public <R> ImmutableSortedMap<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 ImmutableMapIterable<K,V>
collectValues
in interface ImmutableSortedMap<K,V>
collectValues
in interface MapIterable<K,V>
collectValues
in interface SortedMapIterable<K,V>
public Pair<K,V> detect(Predicate2<? super K,? super V> predicate)
MapIterable
Pair<City, Person> detected = peopleByCity.detect((City city, Person person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
detect
in interface MapIterable<K,V>
public Optional<Pair<K,V>> detectOptional(Predicate2<? super K,? super V> predicate)
MapIterable
Optional<Pair<City, Person>> detected = peopleByCity.detectOptional((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
detectOptional
in interface MapIterable<K,V>
public <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 = 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 ImmutableSortedMap<K,V>
flatCollect
in interface OrderedIterable<K>
flatCollect
in interface ReversibleIterable<K>
flatCollect
in interface RichIterable<K>
flatCollect
in interface SortedMapIterable<K,V>
function
- The Function
to applyfunction
public <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 ImmutableMapIterable<K,V>
zip
in interface ImmutableSortedMap<K,V>
zip
in interface OrderedIterable<K>
zip
in interface ReversibleIterable<K>
zip
in interface RichIterable<K>
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.public ImmutableList<Pair<V,Integer>> zipWithIndex()
RichIterable
RichIterable
with its indices.zipWithIndex
in interface ImmutableMapIterable<K,V>
zipWithIndex
in interface ImmutableSortedMap<K,V>
zipWithIndex
in interface OrderedIterable<K>
zipWithIndex
in interface ReversibleIterable<K>
zipWithIndex
in interface RichIterable<K>
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)
public <R> ImmutableListMultimap<R,V> groupBy(Function<? super V,? extends R> function)
RichIterable
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(); } });
groupBy
in interface ImmutableMapIterable<K,V>
groupBy
in interface ImmutableSortedMap<K,V>
groupBy
in interface OrderedIterable<K>
groupBy
in interface ReversibleIterable<K>
groupBy
in interface RichIterable<K>
groupBy
in interface SortedMapIterable<K,V>
public <R> ImmutableListMultimap<R,V> groupByEach(Function<? super V,? extends Iterable<R>> function)
RichIterable
RichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys
for each value.groupByEach
in interface ImmutableMapIterable<K,V>
groupByEach
in interface ImmutableSortedMap<K,V>
groupByEach
in interface OrderedIterable<K>
groupByEach
in interface ReversibleIterable<K>
groupByEach
in interface RichIterable<K>
groupByEach
in interface SortedMapIterable<K,V>
public <V1> ImmutableMap<V1,V> groupByUniqueKey(Function<? super V,? extends V1> function)
RichIterable
groupByUniqueKey
in interface ImmutableMapIterable<K,V>
groupByUniqueKey
in interface ImmutableSortedMap<K,V>
groupByUniqueKey
in interface RichIterable<K>
RichIterable.groupBy(Function)
public <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 ImmutableMapIterable<K,V>
aggregateInPlaceBy
in interface ImmutableSortedMap<K,V>
aggregateInPlaceBy
in interface RichIterable<K>
public <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 ImmutableMapIterable<K,V>
aggregateBy
in interface ImmutableSortedMap<K,V>
aggregateBy
in interface RichIterable<K>
public <V1> ImmutableObjectLongMap<V1> sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)
RichIterable
sumByInt
in interface RichIterable<K>
public <V1> ImmutableObjectDoubleMap<V1> sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)
RichIterable
sumByFloat
in interface RichIterable<K>
public <V1> ImmutableObjectLongMap<V1> sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)
RichIterable
sumByLong
in interface RichIterable<K>
public <V1> ImmutableObjectDoubleMap<V1> sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)
RichIterable
sumByDouble
in interface RichIterable<K>
public LazyIterable<V> asReversed()
ReversibleIterable
asReversed
in interface ReversibleIterable<K>
public ImmutableSortedMap<K,V> toReversed()
ReversibleIterable
toReversed
in interface ReversibleIterable<K>
toReversed
in interface SortedMapIterable<K,V>
public int detectLastIndex(Predicate<? super V> predicate)
ReversibleIterable
ReversibleIterable
for which the predicate
evaluates to true.
Returns -1 if no element evaluates true for the predicate
.detectLastIndex
in interface ReversibleIterable<K>
public ImmutableSortedMap<K,V> takeWhile(Predicate<? super V> predicate)
ReversibleIterable
takeWhile
in interface OrderedIterable<K>
takeWhile
in interface ReversibleIterable<K>
takeWhile
in interface SortedMapIterable<K,V>
public ImmutableSortedMap<K,V> dropWhile(Predicate<? super V> predicate)
ReversibleIterable
dropWhile
in interface OrderedIterable<K>
dropWhile
in interface ReversibleIterable<K>
dropWhile
in interface SortedMapIterable<K,V>
public PartitionImmutableList<V> partitionWhile(Predicate<? super V> predicate)
OrderedIterable
partitionWhile
in interface OrderedIterable<K>
partitionWhile
in interface ReversibleIterable<K>
partitionWhile
in interface SortedMapIterable<K,V>
public ImmutableList<V> distinct()
OrderedIterable
OrderedIterable
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<K>
distinct
in interface ReversibleIterable<K>
distinct
in interface SortedMapIterable<K,V>
OrderedIterable
of distinct elementspublic int indexOf(Object object)
OrderedIterable
indexOf
in interface OrderedIterable<K>
List.indexOf(Object)
public <S> boolean corresponds(OrderedIterable<S> other, Predicate2<? super V,? super S> predicate)
OrderedIterable
predicate
returns true for all corresponding elements e1 of
this OrderedIterable
and e2 of other
.
The predicate
is evaluated for each element at the same position of each OrderedIterable
in a forward iteration order.
This is a short circuit pattern.corresponds
in interface OrderedIterable<K>
public void forEach(int startIndex, int endIndex, Procedure<? super V> procedure)
OrderedIterable
e.g. OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally) people.forEach(0, 1, new Procedure<Person>() { public void value(Person person) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
forEach
in interface OrderedIterable<K>
public void forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super V> objectIntProcedure)
OrderedIterable
e.g. OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally) people.forEachWithIndex(0, 1, new ObjectIntProcedure<Person>() { public void value(Person person, int index) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
forEachWithIndex
in interface OrderedIterable<K>
public MutableStack<V> toStack()
OrderedIterable
toStack
in interface OrderedIterable<K>
public int detectIndex(Predicate<? super V> predicate)
OrderedIterable
OrderedIterable
for which the predicate
evaluates to true.
Returns -1 if no element evaluates true for the predicate
.detectIndex
in interface OrderedIterable<K>
public <V1> ImmutableBag<V1> countBy(Function<? super V,? extends V1> function)
RichIterable
countBy
in interface ImmutableMapIterable<K,V>
countBy
in interface RichIterable<K>
public <V1,P> ImmutableBag<V1> countByWith(Function2<? super V,? super P,? extends V1> function, P parameter)
RichIterable
countByWith
in interface ImmutableMapIterable<K,V>
countByWith
in interface RichIterable<K>
public <V1> ImmutableBag<V1> countByEach(Function<? super V,? extends Iterable<V1>> function)
RichIterable
countByEach
in interface ImmutableMapIterable<K,V>
countByEach
in interface RichIterable<K>
countByEach
in class AbstractRichIterable<V>
Copyright © 2004–2019. All rights reserved.