Iterable<K>, Map<K,V>, InternalIterable<K>, ImmutableMap<K,V>, ImmutableMapIterable<K,V>, MapIterable<K,V>, UnsortedMapIterable<K,V>, RichIterable<K>ImmutableUnifiedMap, ImmutableUnifiedMapWithHashingStrategypublic abstract class AbstractImmutableMap<K,V> extends AbstractMapIterable<K,V> implements ImmutableMap<K,V>, Map<K,V>
| Constructor | Description |
|---|---|
AbstractImmutableMap() |
| 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.
|
Map<K,V> |
castToMap() |
|
void |
clear() |
|
<R> ImmutableBag<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.
|
ImmutableBooleanBag |
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. |
ImmutableByteBag |
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. |
ImmutableCharBag |
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. |
ImmutableDoubleBag |
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. |
ImmutableFloatBag |
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> ImmutableBag<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.
|
ImmutableIntBag |
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. |
ImmutableLongBag |
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. |
ImmutableShortBag |
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> ImmutableMap<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> ImmutableBag<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. |
<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.
|
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.
|
Set<Map.Entry<K,V>> |
entrySet() |
|
<R> ImmutableBag<R> |
flatCollect(Function<? super V,? extends Iterable<R>> function) |
flatCollect is a special case of RichIterable.collect(Function). |
ImmutableSetMultimap<V,K> |
flip() |
Given a map from Domain
-> Range return a multimap from Range -> Domain. |
ImmutableMap<V,K> |
flipUniqueValues() |
Return the MapIterable that is obtained by flipping the direction of this map and making the associations
from value to key.
|
<VV> ImmutableBagMultimap<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> ImmutableBagMultimap<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. |
<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.
|
Iterator<V> |
iterator() |
|
ImmutableMap<K,V> |
newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs) |
|
ImmutableMap<K,V> |
newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues) |
|
ImmutableMap<K,V> |
newWithKeyValue(K key,
V value) |
|
ImmutableMap<K,V> |
newWithoutAllKeys(Iterable<? extends K> keys) |
|
ImmutableMap<K,V> |
newWithoutKey(K key) |
|
PartitionImmutableBag<V> |
partition(Predicate<? super V> predicate) |
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
|
<P> PartitionImmutableBag<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) |
|
ImmutableBag<V> |
reject(Predicate<? super V> predicate) |
Returns all elements of the source collection that return false when evaluating of the predicate.
|
ImmutableMap<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> ImmutableBag<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) |
|
ImmutableBag<V> |
select(Predicate<? super V> predicate) |
Returns all elements of the source collection that return true when evaluating the predicate.
|
ImmutableMap<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> ImmutableBag<S> |
selectInstancesOf(Class<S> clazz) |
Returns all elements of the source collection that are instances of the Class
clazz. |
<P> ImmutableBag<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. |
<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.
|
ImmutableMap<K,V> |
tap(Procedure<? super V> procedure) |
Executes the Procedure for each value of the map and returns
this. |
ImmutableMap<K,V> |
toImmutable() |
Converts the UnsortedMapIterable to an immutable implementation.
|
MutableMap<K,V> |
toMap() |
|
<S> ImmutableBag<Pair<V,S>> |
zip(Iterable<S> that) |
Deprecated.
in 6.0. Use
OrderedIterable.zip(Iterable) instead. |
ImmutableSet<Pair<V,Integer>> |
zipWithIndex() |
Deprecated.
in 6.0. Use
OrderedIterable.zipWithIndex() instead. |
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, toArrayappendString, 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, zipWithIndexflatCollectWithforEach, forEachWith, forEachWithIndexcompute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entry, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, of, of, of, of, of, of, of, of, of, of, of, ofEntries, putIfAbsent, remove, replace, replace, replaceAll, size, valuescontainsKey, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesViewequals, getClass, hashCode, notify, notifyAll, wait, wait, waitallSatisfy, 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, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, 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, zip, zipWithIndexpublic Map<K,V> castToMap()
castToMap in interface ImmutableMapIterable<K,V>public MutableMap<K,V> toMap()
toMap in interface ImmutableMap<K,V>public ImmutableMap<K,V> toImmutable()
UnsortedMapIterabletoImmutable in interface MapIterable<K,V>toImmutable in interface UnsortedMapIterable<K,V>public ImmutableSetMultimap<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 ImmutableMap<K,V>flip in interface ImmutableMapIterable<K,V>flip in interface MapIterable<K,V>flip in interface UnsortedMapIterable<K,V>public ImmutableMap<K,V> newWithKeyValue(K key, V value)
newWithKeyValue in interface ImmutableMap<K,V>newWithKeyValue in interface ImmutableMapIterable<K,V>public ImmutableMap<K,V> newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
newWithAllKeyValues in interface ImmutableMap<K,V>newWithAllKeyValues in interface ImmutableMapIterable<K,V>public ImmutableMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
newWithAllKeyValueArguments in interface ImmutableMap<K,V>newWithAllKeyValueArguments in interface ImmutableMapIterable<K,V>public ImmutableMap<K,V> newWithoutKey(K key)
newWithoutKey in interface ImmutableMap<K,V>newWithoutKey in interface ImmutableMapIterable<K,V>public ImmutableMap<K,V> newWithoutAllKeys(Iterable<? extends K> keys)
newWithoutAllKeys in interface ImmutableMap<K,V>newWithoutAllKeys in interface ImmutableMapIterable<K,V>public ImmutableMap<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 ImmutableMap<K,V>flipUniqueValues in interface ImmutableMapIterable<K,V>flipUniqueValues in interface MapIterable<K,V>flipUniqueValues in interface UnsortedMapIterable<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 ImmutableMap<K,V>collect in interface ImmutableMapIterable<K,V>collect in interface MapIterable<K,V>collect in interface UnsortedMapIterable<K,V>public <R> ImmutableMap<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 ImmutableMap<K,V>collectValues in interface ImmutableMapIterable<K,V>collectValues in interface MapIterable<K,V>collectValues in interface UnsortedMapIterable<K,V>public ImmutableMap<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 ImmutableMap<K,V>select in interface ImmutableMapIterable<K,V>select in interface MapIterable<K,V>select in interface UnsortedMapIterable<K,V>public ImmutableMap<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 ImmutableMap<K,V>reject in interface ImmutableMapIterable<K,V>reject in interface MapIterable<K,V>reject in interface UnsortedMapIterable<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> ImmutableBag<R> collect(Function<? super V,? extends R> 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 ImmutableMap<K,V>collect in interface RichIterable<K>collect in interface UnsortedMapIterable<K,V>public <P,VV> ImmutableBag<VV> collectWith(Function2<? super V,? super P,? extends VV> 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 ImmutableMap<K,V>collectWith in interface RichIterable<K>collectWith in interface UnsortedMapIterable<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 functionRichIterable that contains the transformed elements returned by Function2.value(Object, Object)RichIterable.collect(Function)public ImmutableBooleanBag 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 ImmutableMap<K,V>collectBoolean in interface RichIterable<K>collectBoolean in interface UnsortedMapIterable<K,V>public ImmutableByteBag 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 ImmutableMap<K,V>collectByte in interface RichIterable<K>collectByte in interface UnsortedMapIterable<K,V>public ImmutableCharBag 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 ImmutableMap<K,V>collectChar in interface RichIterable<K>collectChar in interface UnsortedMapIterable<K,V>public ImmutableDoubleBag 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 ImmutableMap<K,V>collectDouble in interface RichIterable<K>collectDouble in interface UnsortedMapIterable<K,V>public ImmutableFloatBag 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 ImmutableMap<K,V>collectFloat in interface RichIterable<K>collectFloat in interface UnsortedMapIterable<K,V>public ImmutableIntBag 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 ImmutableMap<K,V>collectInt in interface RichIterable<K>collectInt in interface UnsortedMapIterable<K,V>public ImmutableLongBag 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 ImmutableMap<K,V>collectLong in interface RichIterable<K>collectLong in interface UnsortedMapIterable<K,V>public ImmutableShortBag 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 ImmutableMap<K,V>collectShort in interface RichIterable<K>collectShort in interface UnsortedMapIterable<K,V>public <R> ImmutableBag<R> collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> 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 ImmutableMap<K,V>collectIf in interface RichIterable<K>collectIf in interface UnsortedMapIterable<K,V>public <R> ImmutableBag<R> flatCollect(Function<? super V,? extends Iterable<R>> 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 ImmutableMap<K,V>flatCollect in interface RichIterable<K>flatCollect in interface UnsortedMapIterable<K,V>function - The Function to applyfunctionpublic ImmutableBag<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 ImmutableMap<K,V>select in interface ImmutableMapIterable<K,V>select in interface RichIterable<K>select in interface UnsortedMapIterable<K,V>public <P> ImmutableBag<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 ImmutableMap<K,V>selectWith in interface ImmutableMapIterable<K,V>selectWith in interface RichIterable<K>selectWith in interface UnsortedMapIterable<K,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)public ImmutableMap<K,V> tap(Procedure<? super V> procedure)
MapIterablethis.
return peopleByCity.tap(person -> LOGGER.info(person.getName()));
tap in interface ImmutableMap<K,V>tap in interface ImmutableMapIterable<K,V>tap in interface MapIterable<K,V>tap in interface RichIterable<K>tap in interface UnsortedMapIterable<K,V>RichIterable.forEach(Procedure)public ImmutableBag<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 ImmutableMap<K,V>reject in interface ImmutableMapIterable<K,V>reject in interface RichIterable<K>reject in interface UnsortedMapIterable<K,V>predicate - a Predicate to use as the reject criteriaPredicate.accept(Object) method to evaluate to falsepublic <P> ImmutableBag<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 ImmutableMap<K,V>rejectWith in interface ImmutableMapIterable<K,V>rejectWith in interface RichIterable<K>rejectWith in interface UnsortedMapIterable<K,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)public PartitionImmutableBag<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 ImmutableMap<K,V>partition in interface ImmutableMapIterable<K,V>partition in interface RichIterable<K>partition in interface UnsortedMapIterable<K,V>public <P> PartitionImmutableBag<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 ImmutableMap<K,V>partitionWith in interface RichIterable<K>partitionWith in interface UnsortedMapIterable<K,V>public <S> ImmutableBag<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 ImmutableMap<K,V>selectInstancesOf in interface ImmutableMapIterable<K,V>selectInstancesOf in interface RichIterable<K>selectInstancesOf in interface UnsortedMapIterable<K,V>@Deprecated public <S> ImmutableBag<Pair<V,S>> zip(Iterable<S> that)
OrderedIterable.zip(Iterable) instead.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 ImmutableMap<K,V>zip in interface ImmutableMapIterable<K,V>zip in interface RichIterable<K>zip in interface UnsortedMapIterable<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.@Deprecated public ImmutableSet<Pair<V,Integer>> zipWithIndex()
OrderedIterable.zipWithIndex() instead.RichIterableRichIterable with its indices.zipWithIndex in interface ImmutableMap<K,V>zipWithIndex in interface ImmutableMapIterable<K,V>zipWithIndex in interface RichIterable<K>zipWithIndex in interface UnsortedMapIterable<K,V>RichIterable containing pairs consisting of all elements of this RichIterable
paired with their index. Indices start at 0.RichIterable.zip(Iterable)public <VV> ImmutableBagMultimap<VV,V> groupBy(Function<? super V,? extends VV> 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 ImmutableMap<K,V>groupBy in interface ImmutableMapIterable<K,V>groupBy in interface RichIterable<K>groupBy in interface UnsortedMapIterable<K,V>public <VV> ImmutableBagMultimap<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 ImmutableMap<K,V>groupByEach in interface ImmutableMapIterable<K,V>groupByEach in interface RichIterable<K>groupByEach in interface UnsortedMapIterable<K,V>public <V1> ImmutableMap<V1,V> groupByUniqueKey(Function<? super V,? extends V1> function)
RichIterablegroupByUniqueKey in interface ImmutableMap<K,V>groupByUniqueKey in interface ImmutableMapIterable<K,V>groupByUniqueKey in interface RichIterable<K>groupByUniqueKey in interface UnsortedMapIterable<K,V>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)
RichIterableaggregateInPlaceBy in interface ImmutableMap<K,V>aggregateInPlaceBy in interface ImmutableMapIterable<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)
RichIterableaggregateBy in interface ImmutableMap<K,V>aggregateBy in interface ImmutableMapIterable<K,V>aggregateBy in interface RichIterable<K>public <V1> ImmutableObjectLongMap<V1> sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)
RichIterablesumByInt in interface RichIterable<K>public <V1> ImmutableObjectDoubleMap<V1> sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)
RichIterablesumByFloat in interface RichIterable<K>public <V1> ImmutableObjectLongMap<V1> sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)
RichIterablesumByLong in interface RichIterable<K>public <V1> ImmutableObjectDoubleMap<V1> sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)
RichIterablesumByDouble in interface RichIterable<K>public <V1> ImmutableBag<V1> countBy(Function<? super V,? extends V1> function)
RichIterablecountBy 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)
RichIterablecountByWith in interface ImmutableMapIterable<K,V>countByWith in interface RichIterable<K>public <V1> ImmutableBag<V1> countByEach(Function<? super V,? extends Iterable<V1>> function)
RichIterablecountByEach in interface ImmutableMapIterable<K,V>countByEach in interface RichIterable<K>countByEach in class AbstractRichIterable<V>Copyright © 2004–2019. All rights reserved.