ImmutableMapIterable<K,V>, InternalIterable<K>, java.lang.Iterable<K>, MapIterable<K,V>, OrderedIterable<K>, OrderedMap<K,V>, ReversibleIterable<K>, RichIterable<K>public interface ImmutableOrderedMap<K,V> extends OrderedMap<K,V>, ImmutableMapIterable<K,V>
| Modifier and Type | Method | Description |
|---|---|---|
<KK,VV> ImmutableOrderedMap<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.
|
<KK,VV> ImmutableOrderedMap<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.
|
<VV> ImmutableList<VV> |
collect(Function<? super V,? extends VV> function) |
Returns a new collection with the results of applying the specified function on each element of the source
collection.
|
<K2,V2> ImmutableOrderedMap<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. |
<V1> ImmutableList<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.
|
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> ImmutableOrderedMap<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> ImmutableList<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. |
ImmutableList<V> |
distinct() |
Returns a new
OrderedIterable containing the distinct elements in this iterable. |
ImmutableOrderedMap<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. |
ImmutableOrderedMap<K,V> |
dropWhile(Predicate<? super V> predicate) |
Returns the final elements that do not satisfy the Predicate.
|
<V1> ImmutableList<V1> |
flatCollect(Function<? super V,? extends java.lang.Iterable<V1>> function) |
flatCollect is a special case of RichIterable.collect(Function). |
ImmutableListMultimap<V,K> |
flip() |
Given a map from Domain -> Range return a multimap from Range -> Domain.
|
ImmutableOrderedMap<V,K> |
flipUniqueValues() |
Return the MapIterable that is obtained by flipping the direction of this map and making the associations
from value to key.
|
<V1> ImmutableListMultimap<V1,V> |
groupBy(Function<? super V,? extends V1> 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.
|
<V1> ImmutableListMultimap<V1,V> |
groupByEach(Function<? super V,? extends java.lang.Iterable<V1>> function) |
Similar to
RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys
for each value. |
<V1> ImmutableOrderedMap<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.
|
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.
|
ImmutableList<V> |
reject(Predicate<? super V> predicate) |
Returns all elements of the source collection that return false when evaluating of the predicate.
|
ImmutableOrderedMap<K,V> |
reject(Predicate2<? super K,? super V> predicate) |
For each key and value of the map the predicate is evaluated, if the result of the evaluation is false,
that key and value are returned in a new map.
|
<P> ImmutableList<V> |
rejectWith(Predicate2<? super V,? super P> predicate,
P parameter) |
Similar to
RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2. |
ImmutableList<V> |
select(Predicate<? super V> predicate) |
Returns all elements of the source collection that return true when evaluating the predicate.
|
ImmutableOrderedMap<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(java.lang.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. |
ImmutableOrderedMap<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. |
ImmutableOrderedMap<K,V> |
takeWhile(Predicate<? super V> predicate) |
Returns the initial elements that satisfy the Predicate.
|
ImmutableOrderedMap<K,V> |
tap(Procedure<? super V> procedure) |
Executes the Procedure for each value of the map and returns
this. |
ImmutableOrderedMap<K,V> |
toReversed() |
Returns a new ReversibleIterable in reverse order.
|
<S> ImmutableList<Pair<V,S>> |
zip(java.lang.Iterable<S> that) |
Returns a
RichIterable formed from this RichIterable and another RichIterable by
combining corresponding elements in pairs. |
ImmutableList<Pair<V,java.lang.Integer>> |
zipWithIndex() |
Zips this
RichIterable with its indices. |
castToMap, countBy, countByWith, newWithAllKeyValueArguments, newWithAllKeyValues, newWithKeyValue, newWithoutAllKeys, newWithoutKeyforEach, forEach, forEachWithcontainsKey, containsValue, detect, detectOptional, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesViewcollectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, indexOf, max, min, toStack, zip, zipWithIndextoImmutableasReversed, collectWithIndex, detectLastIndex, reverseForEach, reverseForEachWithIndexallSatisfy, 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, countBy, countByWith, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, 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, sumByDouble, sumByFloat, sumByInt, sumByLong, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetByImmutableOrderedMap<K,V> tap(Procedure<? super V> procedure)
MapIterablethis.
return peopleByCity.tap(person -> LOGGER.info(person.getName()));
tap in interface ImmutableMapIterable<K,V>tap in interface MapIterable<K,V>tap in interface OrderedIterable<K>tap in interface OrderedMap<K,V>tap in interface ReversibleIterable<K>tap in interface RichIterable<K>InternalIterable.forEach(Procedure)ImmutableOrderedMap<V,K> flipUniqueValues()
MapIterable
MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
MapIterable<String, Integer> result = map.flipUniqueValues();
Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
flipUniqueValues in interface ImmutableMapIterable<K,V>flipUniqueValues in interface MapIterable<K,V>flipUniqueValues in interface OrderedMap<K,V>ImmutableListMultimap<V,K> flip()
MapIterableSince 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 MapIterable<K,V>flip in interface OrderedMap<K,V>ImmutableOrderedMap<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 MapIterable<K,V>select in interface OrderedMap<K,V>ImmutableOrderedMap<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 MapIterable<K,V>reject in interface OrderedMap<K,V><K2,V2> ImmutableOrderedMap<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 MapIterable<K,V>collect in interface OrderedMap<K,V><R> ImmutableOrderedMap<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 MapIterable<K,V>collectValues in interface OrderedMap<K,V>ImmutableOrderedMap<K,V> toReversed()
ReversibleIterabletoReversed in interface OrderedMap<K,V>toReversed in interface ReversibleIterable<K>ImmutableOrderedMap<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 OrderedMap<K,V>take in interface ReversibleIterable<K>count - the number of items to take.ImmutableOrderedMap<K,V> takeWhile(Predicate<? super V> predicate)
ReversibleIterabletakeWhile in interface OrderedIterable<K>takeWhile in interface OrderedMap<K,V>takeWhile in interface ReversibleIterable<K>ImmutableOrderedMap<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 OrderedMap<K,V>drop in interface ReversibleIterable<K>count - the number of items to drop.ImmutableOrderedMap<K,V> dropWhile(Predicate<? super V> predicate)
ReversibleIterabledropWhile in interface OrderedIterable<K>dropWhile in interface OrderedMap<K,V>dropWhile in interface ReversibleIterable<K>PartitionImmutableList<V> partitionWhile(Predicate<? super V> predicate)
OrderedIterablepartitionWhile in interface OrderedIterable<K>partitionWhile in interface OrderedMap<K,V>partitionWhile in interface ReversibleIterable<K>ImmutableList<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<K>distinct in interface OrderedMap<K,V>distinct in interface ReversibleIterable<K>OrderedIterable of distinct elementsImmutableList<V> select(Predicate<? super V> predicate)
RichIterableExample 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 OrderedIterable<K>select in interface OrderedMap<K,V>select in interface ReversibleIterable<K>select in interface RichIterable<K><P> ImmutableList<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));
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 OrderedIterable<K>selectWith in interface OrderedMap<K,V>selectWith in interface ReversibleIterable<K>selectWith in interface RichIterable<K>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)ImmutableList<V> reject(Predicate<? super V> predicate)
RichIterableExample 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 OrderedIterable<K>reject in interface OrderedMap<K,V>reject in interface ReversibleIterable<K>reject in interface RichIterable<K>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to false<P> ImmutableList<V> rejectWith(Predicate2<? super V,? super P> predicate, P parameter)
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));
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 OrderedIterable<K>rejectWith in interface OrderedMap<K,V>rejectWith in interface ReversibleIterable<K>rejectWith in interface RichIterable<K>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)PartitionImmutableList<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"));
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 OrderedIterable<K>partition in interface OrderedMap<K,V>partition in interface ReversibleIterable<K>partition in interface RichIterable<K><P> PartitionImmutableList<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");
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 OrderedIterable<K>partitionWith in interface OrderedMap<K,V>partitionWith in interface ReversibleIterable<K>partitionWith in interface RichIterable<K>ImmutableBooleanList 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());
Example using an anonymous inner class:
BooleanIterable licenses =
people.collectBoolean(new BooleanFunction<Person>()
{
public boolean booleanValueOf(Person person)
{
return person.hasDrivingLicense();
}
});
collectBoolean in interface OrderedIterable<K>collectBoolean in interface OrderedMap<K,V>collectBoolean in interface ReversibleIterable<K>collectBoolean in interface RichIterable<K>ImmutableByteList 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());
Example using an anonymous inner class:
ByteIterable bytes =
people.collectByte(new ByteFunction<Person>()
{
public byte byteValueOf(Person person)
{
return person.getCode();
}
});
collectByte in interface OrderedIterable<K>collectByte in interface OrderedMap<K,V>collectByte in interface ReversibleIterable<K>collectByte in interface RichIterable<K>ImmutableCharList 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());
Example using an anonymous inner class:
CharIterable chars =
people.collectChar(new CharFunction<Person>()
{
public char charValueOf(Person person)
{
return person.getMiddleInitial();
}
});
collectChar in interface OrderedIterable<K>collectChar in interface OrderedMap<K,V>collectChar in interface ReversibleIterable<K>collectChar in interface RichIterable<K>ImmutableDoubleList 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());
Example using an anonymous inner class:
DoubleIterable doubles =
people.collectDouble(new DoubleFunction<Person>()
{
public double doubleValueOf(Person person)
{
return person.getMilesFromNorthPole();
}
});
collectDouble in interface OrderedIterable<K>collectDouble in interface OrderedMap<K,V>collectDouble in interface ReversibleIterable<K>collectDouble in interface RichIterable<K>ImmutableFloatList 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());
Example using an anonymous inner class:
FloatIterable floats =
people.collectFloat(new FloatFunction<Person>()
{
public float floatValueOf(Person person)
{
return person.getHeightInInches();
}
});
collectFloat in interface OrderedIterable<K>collectFloat in interface OrderedMap<K,V>collectFloat in interface ReversibleIterable<K>collectFloat in interface RichIterable<K>ImmutableIntList 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());
Example using an anonymous inner class:
IntIterable ints =
people.collectInt(new IntFunction<Person>()
{
public int intValueOf(Person person)
{
return person.getAge();
}
});
collectInt in interface OrderedIterable<K>collectInt in interface OrderedMap<K,V>collectInt in interface ReversibleIterable<K>collectInt in interface RichIterable<K>ImmutableLongList 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());
Example using an anonymous inner class:
LongIterable longs =
people.collectLong(new LongFunction<Person>()
{
public long longValueOf(Person person)
{
return person.getGuid();
}
});
collectLong in interface OrderedIterable<K>collectLong in interface OrderedMap<K,V>collectLong in interface ReversibleIterable<K>collectLong in interface RichIterable<K>ImmutableShortList 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());
Example using an anonymous inner class:
ShortIterable shorts =
people.collectShort(new ShortFunction<Person>()
{
public short shortValueOf(Person person)
{
return person.getNumberOfJunkMailItemsReceivedPerMonth();
}
});
collectShort in interface OrderedIterable<K>collectShort in interface OrderedMap<K,V>collectShort in interface ReversibleIterable<K>collectShort in interface RichIterable<K><S> ImmutableList<Pair<V,S>> zip(java.lang.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 ImmutableMapIterable<K,V>zip in interface OrderedIterable<K>zip in interface OrderedMap<K,V>zip in interface ReversibleIterable<K>zip in interface RichIterable<K>S - the type of the second half of the returned pairsthat - The RichIterable providing the second half of each result pairRichIterable containing pairs consisting of corresponding elements of this
RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of
this RichIterable and that.ImmutableList<Pair<V,java.lang.Integer>> zipWithIndex()
RichIterableRichIterable with its indices.zipWithIndex in interface ImmutableMapIterable<K,V>zipWithIndex in interface OrderedIterable<K>zipWithIndex in interface OrderedMap<K,V>zipWithIndex in interface ReversibleIterable<K>zipWithIndex in interface RichIterable<K>RichIterable containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)<VV> ImmutableList<VV> collect(Function<? super V,? extends VV> function)
RichIterableExample 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 OrderedIterable<K>collect in interface OrderedMap<K,V>collect in interface ReversibleIterable<K>collect in interface RichIterable<K><P,V1> ImmutableList<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));
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 OrderedIterable<K>collectWith in interface OrderedMap<K,V>collectWith in interface ReversibleIterable<K>collectWith in interface RichIterable<K>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> ImmutableList<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<K>collectIf in interface OrderedMap<K,V>collectIf in interface ReversibleIterable<K>collectIf in interface RichIterable<K><S> ImmutableList<S> selectInstancesOf(java.lang.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 ImmutableMapIterable<K,V>selectInstancesOf in interface OrderedIterable<K>selectInstancesOf in interface OrderedMap<K,V>selectInstancesOf in interface ReversibleIterable<K>selectInstancesOf in interface RichIterable<K><V1> ImmutableList<V1> flatCollect(Function<? super V,? extends java.lang.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<K>flatCollect in interface OrderedMap<K,V>flatCollect in interface ReversibleIterable<K>flatCollect in interface RichIterable<K>function - The Function to applyfunction<V1> ImmutableListMultimap<V1,V> groupBy(Function<? super V,? extends V1> function)
RichIterableExample 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 OrderedIterable<K>groupBy in interface OrderedMap<K,V>groupBy in interface ReversibleIterable<K>groupBy in interface RichIterable<K><V1> ImmutableListMultimap<V1,V> groupByEach(Function<? super V,? extends java.lang.Iterable<V1>> function)
RichIterableRichIterable.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 OrderedIterable<K>groupByEach in interface OrderedMap<K,V>groupByEach in interface ReversibleIterable<K>groupByEach in interface RichIterable<K><V1> ImmutableOrderedMap<V1,V> groupByUniqueKey(Function<? super V,? extends V1> function)
RichIterablegroupByUniqueKey in interface ImmutableMapIterable<K,V>groupByUniqueKey in interface OrderedMap<K,V>groupByUniqueKey in interface RichIterable<K>RichIterable.groupBy(Function)<KK,VV> ImmutableOrderedMap<KK,VV> aggregateInPlaceBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Procedure2<? super VV,? super V> mutatingAggregator)
RichIterableaggregateInPlaceBy in interface ImmutableMapIterable<K,V>aggregateInPlaceBy in interface RichIterable<K><KK,VV> ImmutableOrderedMap<KK,VV> aggregateBy(Function<? super V,? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Function2<? super VV,? super V,? extends VV> nonMutatingAggregator)
RichIterableaggregateBy in interface ImmutableMapIterable<K,V>aggregateBy in interface RichIterable<K>Copyright © 2004–2018. All rights reserved.