Class AbstractImmutableMap<K,V>
- All Implemented Interfaces:
Iterable<V>
,Map<K,V>
,InternalIterable<V>
,ImmutableMap<K,V>
,ImmutableMapIterable<K,V>
,MapIterable<K,V>
,UnsortedMapIterable<K,V>
,RichIterable<V>
- Direct Known Subclasses:
ImmutableUnifiedMap
,ImmutableUnifiedMapWithHashingStrategy
public abstract class AbstractImmutableMap<K,V> extends AbstractMapIterable<K,V> implements ImmutableMap<K,V>, Map<K,V>
-
Nested Class Summary
-
Constructor Summary
Constructors Constructor Description AbstractImmutableMap()
-
Method Summary
Modifier and Type Method Description <K1, V1, V2> ImmutableMap<K1,V2>
aggregateBy(Function<? super K,? extends K1> keyFunction, Function<? super V,? extends V1> valueFunction, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V1,? extends V2> nonMutatingAggregator)
Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions.<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 primitiveboolean
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 primitivebyte
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 primitivechar
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 primitivedouble
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 primitivefloat
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 primitiveint
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 primitivelong
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 primitiveshort
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 asRichIterable.collect(Function)
with aFunction2
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 ofRichIterable.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 toRichIterable.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 toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.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 Classclazz
.<P> ImmutableBag<V>
selectWith(Predicate2<? super V,? super P> predicate, P parameter)
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.<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 returnsthis
.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.ImmutableSet<Pair<V,Integer>>
zipWithIndex()
Deprecated.in 6.0.Methods inherited from class org.eclipse.collections.impl.map.AbstractMapIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asLazy, chunk, contains, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, getOnly, getOrDefault, ifPresentApply, noneSatisfy, noneSatisfyWith, toArray, toArray
Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable
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
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.collections.api.map.ImmutableMap
aggregateBy, flatCollectWith
Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, putIfAbsent, remove, replace, replace, replaceAll, size, values
Methods inherited from interface org.eclipse.collections.api.map.MapIterable
containsKey, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getOrDefault, hashCode, ifPresentApply, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView
Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsBy, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getFirst, getLast, getOnly, groupBy, groupByAndCollect, 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, zipWithIndex
-
Constructor Details
-
AbstractImmutableMap
public AbstractImmutableMap()
-
-
Method Details
-
castToMap
- Specified by:
castToMap
in interfaceImmutableMapIterable<K,V>
-
toMap
- Specified by:
toMap
in interfaceImmutableMap<K,V>
-
toImmutable
Description copied from interface:UnsortedMapIterable
Converts the UnsortedMapIterable to an immutable implementation. Returns this for immutable maps.- Specified by:
toImmutable
in interfaceMapIterable<K,V>
- Specified by:
toImmutable
in interfaceUnsortedMapIterable<K,V>
-
iterator
-
putAll
-
clear
public void clear() -
flip
Description copied from interface:MapIterable
Given a map from Domain->
Range return a multimap from Range->
Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.Since the keys in the input are unique, the values in the output are unique, so the return type should be a SetMultimap. However since SetMultimap and SortedSetMultimap don't inherit from one another, SetMultimap here does not allow SortedMapIterable to have a SortedSetMultimap return. Thus we compromise and call this Multimap, even though all implementations will be a SetMultimap or SortedSetMultimap.
- Specified by:
flip
in interfaceImmutableMap<K,V>
- Specified by:
flip
in interfaceImmutableMapIterable<K,V>
- Specified by:
flip
in interfaceMapIterable<K,V>
- Specified by:
flip
in interfaceUnsortedMapIterable<K,V>
-
entrySet
-
newWithKeyValue
- Specified by:
newWithKeyValue
in interfaceImmutableMap<K,V>
- Specified by:
newWithKeyValue
in interfaceImmutableMapIterable<K,V>
-
newWithAllKeyValues
public ImmutableMap<K,V> newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)- Specified by:
newWithAllKeyValues
in interfaceImmutableMap<K,V>
- Specified by:
newWithAllKeyValues
in interfaceImmutableMapIterable<K,V>
-
newWithAllKeyValueArguments
public ImmutableMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)- Specified by:
newWithAllKeyValueArguments
in interfaceImmutableMap<K,V>
- Specified by:
newWithAllKeyValueArguments
in interfaceImmutableMapIterable<K,V>
-
newWithoutKey
- Specified by:
newWithoutKey
in interfaceImmutableMap<K,V>
- Specified by:
newWithoutKey
in interfaceImmutableMapIterable<K,V>
-
newWithoutAllKeys
- Specified by:
newWithoutAllKeys
in interfaceImmutableMap<K,V>
- Specified by:
newWithoutAllKeys
in interfaceImmutableMapIterable<K,V>
-
put
-
remove
-
flipUniqueValues
Description copied from interface:MapIterable
Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.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)));
- Specified by:
flipUniqueValues
in interfaceImmutableMap<K,V>
- Specified by:
flipUniqueValues
in interfaceImmutableMapIterable<K,V>
- Specified by:
flipUniqueValues
in interfaceMapIterable<K,V>
- Specified by:
flipUniqueValues
in interfaceUnsortedMapIterable<K,V>
-
collect
public <K2, V2> ImmutableMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)Description copied from interface:MapIterable
For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.MapIterable<String, String> collected = peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
- Specified by:
collect
in interfaceImmutableMap<K,V>
- Specified by:
collect
in interfaceImmutableMapIterable<K,V>
- Specified by:
collect
in interfaceMapIterable<K,V>
- Specified by:
collect
in interfaceUnsortedMapIterable<K,V>
-
collectValues
Description copied from interface:MapIterable
For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.MapIterable<City, String> collected = peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
- Specified by:
collectValues
in interfaceImmutableMap<K,V>
- Specified by:
collectValues
in interfaceImmutableMapIterable<K,V>
- Specified by:
collectValues
in interfaceMapIterable<K,V>
- Specified by:
collectValues
in interfaceUnsortedMapIterable<K,V>
-
select
Description copied from interface:MapIterable
For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.MapIterable<City, Person> selected = peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
select
in interfaceImmutableMap<K,V>
- Specified by:
select
in interfaceImmutableMapIterable<K,V>
- Specified by:
select
in interfaceMapIterable<K,V>
- Specified by:
select
in interfaceUnsortedMapIterable<K,V>
-
reject
Description copied from interface:MapIterable
For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.MapIterable<City, Person> rejected = peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
reject
in interfaceImmutableMap<K,V>
- Specified by:
reject
in interfaceImmutableMapIterable<K,V>
- Specified by:
reject
in interfaceMapIterable<K,V>
- Specified by:
reject
in interfaceUnsortedMapIterable<K,V>
-
detect
Description copied from interface:MapIterable
Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all of the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate. The result is null if predicate does not evaluate to true for any key/value combination.Pair<City, Person> detected = peopleByCity.detect((City city, Person person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
detect
in interfaceMapIterable<K,V>
-
detectOptional
Description copied from interface:MapIterable
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. The predicate will only be evaluated until such pair is found or until all of the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate.Optional<Pair<City, Person>> detected = peopleByCity.detectOptional((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
detectOptional
in interfaceMapIterable<K,V>
-
collect
Description copied from interface:RichIterable
Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
RichIterable<String> names = people.collect(person -> person.getFirstName() + " " + person.getLastName());
Example using an anonymous inner class:
RichIterable<String> names = people.collect(new Function<Person, String>() { public String valueOf(Person person) { return person.getFirstName() + " " + person.getLastName(); } });
- Specified by:
collect
in interfaceImmutableMap<K,V>
- Specified by:
collect
in interfaceRichIterable<K>
- Specified by:
collect
in interfaceUnsortedMapIterable<K,V>
-
collectWith
public <P, VV> ImmutableBag<VV> collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)Description copied from interface:RichIterable
Same asRichIterable.collect(Function)
with aFunction2
and specified parameter which is passed to the block.Example using a Java 8 lambda expression:
RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
Example using an anonymous inner class:
Function2<Integer, Integer, Integer> addParameterFunction = new Function2<Integer, Integer, Integer>() { public Integer value(Integer each, Integer parameter) { return each + parameter; } }; RichIterable<Integer> integers = Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
- Specified by:
collectWith
in interfaceImmutableMap<K,V>
- Specified by:
collectWith
in interfaceRichIterable<K>
- Specified by:
collectWith
in interfaceUnsortedMapIterable<K,V>
- Parameters:
function
- AFunction2
to use as the collect transformation functionparameter
- A parameter to pass in for evaluation of the second argumentP
infunction
- Returns:
- A new
RichIterable
that contains the transformed elements returned byFunction2.value(Object, Object)
- See Also:
RichIterable.collect(Function)
-
collectBoolean
Description copied from interface:RichIterable
Returns a new primitiveboolean
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
BooleanIterable licenses = people.collectBoolean(person -> person.hasDrivingLicense());
Example using an anonymous inner class:
BooleanIterable licenses = people.collectBoolean(new BooleanFunction<Person>() { public boolean booleanValueOf(Person person) { return person.hasDrivingLicense(); } });
- Specified by:
collectBoolean
in interfaceImmutableMap<K,V>
- Specified by:
collectBoolean
in interfaceRichIterable<K>
- Specified by:
collectBoolean
in interfaceUnsortedMapIterable<K,V>
-
collectByte
Description copied from interface:RichIterable
Returns a new primitivebyte
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
ByteIterable bytes = people.collectByte(person -> person.getCode());
Example using an anonymous inner class:
ByteIterable bytes = people.collectByte(new ByteFunction<Person>() { public byte byteValueOf(Person person) { return person.getCode(); } });
- Specified by:
collectByte
in interfaceImmutableMap<K,V>
- Specified by:
collectByte
in interfaceRichIterable<K>
- Specified by:
collectByte
in interfaceUnsortedMapIterable<K,V>
-
collectChar
Description copied from interface:RichIterable
Returns a new primitivechar
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
CharIterable chars = people.collectChar(person -> person.getMiddleInitial());
Example using an anonymous inner class:
CharIterable chars = people.collectChar(new CharFunction<Person>() { public char charValueOf(Person person) { return person.getMiddleInitial(); } });
- Specified by:
collectChar
in interfaceImmutableMap<K,V>
- Specified by:
collectChar
in interfaceRichIterable<K>
- Specified by:
collectChar
in interfaceUnsortedMapIterable<K,V>
-
collectDouble
Description copied from interface:RichIterable
Returns a new primitivedouble
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
DoubleIterable doubles = people.collectDouble(person -> person.getMilesFromNorthPole());
Example using an anonymous inner class:
DoubleIterable doubles = people.collectDouble(new DoubleFunction<Person>() { public double doubleValueOf(Person person) { return person.getMilesFromNorthPole(); } });
- Specified by:
collectDouble
in interfaceImmutableMap<K,V>
- Specified by:
collectDouble
in interfaceRichIterable<K>
- Specified by:
collectDouble
in interfaceUnsortedMapIterable<K,V>
-
collectFloat
Description copied from interface:RichIterable
Returns a new primitivefloat
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
FloatIterable floats = people.collectFloat(person -> person.getHeightInInches());
Example using an anonymous inner class:
FloatIterable floats = people.collectFloat(new FloatFunction<Person>() { public float floatValueOf(Person person) { return person.getHeightInInches(); } });
- Specified by:
collectFloat
in interfaceImmutableMap<K,V>
- Specified by:
collectFloat
in interfaceRichIterable<K>
- Specified by:
collectFloat
in interfaceUnsortedMapIterable<K,V>
-
collectInt
Description copied from interface:RichIterable
Returns a new primitiveint
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
IntIterable ints = people.collectInt(person -> person.getAge());
Example using an anonymous inner class:
IntIterable ints = people.collectInt(new IntFunction<Person>() { public int intValueOf(Person person) { return person.getAge(); } });
- Specified by:
collectInt
in interfaceImmutableMap<K,V>
- Specified by:
collectInt
in interfaceRichIterable<K>
- Specified by:
collectInt
in interfaceUnsortedMapIterable<K,V>
-
collectLong
Description copied from interface:RichIterable
Returns a new primitivelong
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
LongIterable longs = people.collectLong(person -> person.getGuid());
Example using an anonymous inner class:
LongIterable longs = people.collectLong(new LongFunction<Person>() { public long longValueOf(Person person) { return person.getGuid(); } });
- Specified by:
collectLong
in interfaceImmutableMap<K,V>
- Specified by:
collectLong
in interfaceRichIterable<K>
- Specified by:
collectLong
in interfaceUnsortedMapIterable<K,V>
-
collectShort
Description copied from interface:RichIterable
Returns a new primitiveshort
iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.Example using a Java 8 lambda expression:
ShortIterable shorts = people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
Example using an anonymous inner class:
ShortIterable shorts = people.collectShort(new ShortFunction<Person>() { public short shortValueOf(Person person) { return person.getNumberOfJunkMailItemsReceivedPerMonth(); } });
- Specified by:
collectShort
in interfaceImmutableMap<K,V>
- Specified by:
collectShort
in interfaceRichIterable<K>
- Specified by:
collectShort
in interfaceUnsortedMapIterable<K,V>
-
collectIf
public <R> ImmutableBag<R> collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> function)Description copied from interface:RichIterable
Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).Example using a Java 8 lambda and method reference:
RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
Example using Predicates factory:
RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
- Specified by:
collectIf
in interfaceImmutableMap<K,V>
- Specified by:
collectIf
in interfaceRichIterable<K>
- Specified by:
collectIf
in interfaceUnsortedMapIterable<K,V>
-
flatCollect
Description copied from interface:RichIterable
flatCollect
is a special case ofRichIterable.collect(Function)
. Withcollect
, when theFunction
returns a collection, the result is a collection of collections.flatCollect
outputs a single "flattened" collection instead. This method is commonly called flatMap.Consider the following example where we have a
Person
class, and eachPerson
has a list ofAddress
objects. Take the followingFunction
:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
Usingcollect
returns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction);
UsingflatCollect
returns a single flattened list of addresses.RichIterable<Address> addresses = people.flatCollect(addressFunction);
- Specified by:
flatCollect
in interfaceImmutableMap<K,V>
- Specified by:
flatCollect
in interfaceRichIterable<K>
- Specified by:
flatCollect
in interfaceUnsortedMapIterable<K,V>
- Parameters:
function
- TheFunction
to apply- Returns:
- a new flattened collection produced by applying the given
function
-
select
Description copied from interface:RichIterable
Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.Example using a Java 8 lambda expression:
RichIterable<Person> selected = people.select(person -> person.getAddress().getCity().equals("London"));
Example using an anonymous inner class:
RichIterable<Person> selected = people.select(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getCity().equals("London"); } });
- Specified by:
select
in interfaceImmutableMap<K,V>
- Specified by:
select
in interfaceImmutableMapIterable<K,V>
- Specified by:
select
in interfaceRichIterable<K>
- Specified by:
select
in interfaceUnsortedMapIterable<K,V>
-
selectWith
Description copied from interface:RichIterable
Similar toRichIterable.select(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample using a Java 8 lambda expression:
RichIterable<Person> selected = people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));
Example using an anonymous inner class:
RichIterable<Person> selected = people.selectWith(new Predicate2<Person, Integer>() { public boolean accept(Person person, Integer age) { return person.getAge()>= age; } }, Integer.valueOf(18));
- Specified by:
selectWith
in interfaceImmutableMap<K,V>
- Specified by:
selectWith
in interfaceImmutableMapIterable<K,V>
- Specified by:
selectWith
in interfaceRichIterable<K>
- Specified by:
selectWith
in interfaceUnsortedMapIterable<K,V>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
tap
Description copied from interface:MapIterable
Executes the Procedure for each value of the map and returnsthis
.return peopleByCity.tap(person -> LOGGER.info(person.getName()));
- Specified by:
tap
in interfaceImmutableMap<K,V>
- Specified by:
tap
in interfaceImmutableMapIterable<K,V>
- Specified by:
tap
in interfaceMapIterable<K,V>
- Specified by:
tap
in interfaceRichIterable<K>
- Specified by:
tap
in interfaceUnsortedMapIterable<K,V>
- See Also:
RichIterable.forEach(Procedure)
-
reject
Description copied from interface:RichIterable
Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).Example using a Java 8 lambda expression:
RichIterable<Person> rejected = people.reject(person -> person.person.getLastName().equals("Smith"));
Example using an anonymous inner class:
RichIterable<Person> rejected = people.reject(new Predicate<Person>() { public boolean accept(Person person) { return person.person.getLastName().equals("Smith"); } });
- Specified by:
reject
in interfaceImmutableMap<K,V>
- Specified by:
reject
in interfaceImmutableMapIterable<K,V>
- Specified by:
reject
in interfaceRichIterable<K>
- Specified by:
reject
in interfaceUnsortedMapIterable<K,V>
- Parameters:
predicate
- aPredicate
to use as the reject criteria- Returns:
- a RichIterable that contains elements that cause
Predicate.accept(Object)
method to evaluate to false
-
rejectWith
Description copied from interface:RichIterable
Similar toRichIterable.reject(Predicate)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample using a Java 8 lambda expression:
RichIterable<Person> rejected = people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
Example using an anonymous inner class:
MutableList<Person> rejected = people.rejectWith(new Predicate2<Person, Integer>() { public boolean accept(Person person, Integer age) { return person.getAge() < age; } }, Integer.valueOf(18));
- Specified by:
rejectWith
in interfaceImmutableMap<K,V>
- Specified by:
rejectWith
in interfaceImmutableMapIterable<K,V>
- Specified by:
rejectWith
in interfaceRichIterable<K>
- Specified by:
rejectWith
in interfaceUnsortedMapIterable<K,V>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
- See Also:
RichIterable.select(Predicate)
-
partition
Description copied from interface:RichIterable
Filters a collection into a PartitionedIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(person -> person.getAddress().getState().getName().equals("New York"));
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partition(new Predicate<Person>() { public boolean accept(Person person) { return person.getAddress().getState().getName().equals("New York"); } });
- Specified by:
partition
in interfaceImmutableMap<K,V>
- Specified by:
partition
in interfaceImmutableMapIterable<K,V>
- Specified by:
partition
in interfaceRichIterable<K>
- Specified by:
partition
in interfaceUnsortedMapIterable<K,V>
-
partitionWith
public <P> PartitionImmutableBag<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)Description copied from interface:RichIterable
Filters a collection into a PartitionIterable based on the evaluation of the predicate.Example using a Java 8 lambda expression:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
Example using an anonymous inner class:
PartitionIterable<Person> newYorkersAndNonNewYorkers = people.partitionWith(new Predicate2<Person, String>() { public boolean accept(Person person, String state) { return person.getAddress().getState().getName().equals(state); } }, "New York");
- Specified by:
partitionWith
in interfaceImmutableMap<K,V>
- Specified by:
partitionWith
in interfaceRichIterable<K>
- Specified by:
partitionWith
in interfaceUnsortedMapIterable<K,V>
-
selectInstancesOf
Description copied from interface:RichIterable
Returns all elements of the source collection that are instances of the Classclazz
.RichIterable<Integer> integers = List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
- Specified by:
selectInstancesOf
in interfaceImmutableMap<K,V>
- Specified by:
selectInstancesOf
in interfaceImmutableMapIterable<K,V>
- Specified by:
selectInstancesOf
in interfaceRichIterable<K>
- Specified by:
selectInstancesOf
in interfaceUnsortedMapIterable<K,V>
-
zip
Deprecated.in 6.0. UseOrderedIterable.zip(Iterable)
instead.Description copied from interface:RichIterable
Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs. If one of the twoRichIterable
s is longer than the other, its remaining elements are ignored.- Specified by:
zip
in interfaceImmutableMap<K,V>
- Specified by:
zip
in interfaceImmutableMapIterable<K,V>
- Specified by:
zip
in interfaceRichIterable<K>
- Specified by:
zip
in interfaceUnsortedMapIterable<K,V>
- Type Parameters:
S
- the type of the second half of the returned pairs- Parameters:
that
- TheRichIterable
providing the second half of each result pair- Returns:
- A new
RichIterable
containing pairs consisting of corresponding elements of thisRichIterable
and that. The length of the returnedRichIterable
is the minimum of the lengths of thisRichIterable
and that.
-
zipWithIndex
Deprecated.in 6.0. UseOrderedIterable.zipWithIndex()
instead.Description copied from interface:RichIterable
Zips thisRichIterable
with its indices.- Specified by:
zipWithIndex
in interfaceImmutableMap<K,V>
- Specified by:
zipWithIndex
in interfaceImmutableMapIterable<K,V>
- Specified by:
zipWithIndex
in interfaceRichIterable<K>
- Specified by:
zipWithIndex
in interfaceUnsortedMapIterable<K,V>
- Returns:
- A new
RichIterable
containing pairs consisting of all elements of thisRichIterable
paired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
groupBy
Description copied from interface:RichIterable
For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.Example using a Java 8 method reference:
Multimap<String, Person> peopleByLastName = people.groupBy(Person::getLastName);
Example using an anonymous inner class:
Multimap<String, Person> peopleByLastName = people.groupBy(new Function<Person, String>() { public String valueOf(Person person) { return person.getLastName(); } });
- Specified by:
groupBy
in interfaceImmutableMap<K,V>
- Specified by:
groupBy
in interfaceImmutableMapIterable<K,V>
- Specified by:
groupBy
in interfaceRichIterable<K>
- Specified by:
groupBy
in interfaceUnsortedMapIterable<K,V>
-
groupByEach
public <VV> ImmutableBagMultimap<VV,V> groupByEach(Function<? super V,? extends Iterable<VV>> function)Description copied from interface:RichIterable
Similar toRichIterable.groupBy(Function)
, except the result of evaluating function will return a collection of keys for each value.- Specified by:
groupByEach
in interfaceImmutableMap<K,V>
- Specified by:
groupByEach
in interfaceImmutableMapIterable<K,V>
- Specified by:
groupByEach
in interfaceRichIterable<K>
- Specified by:
groupByEach
in interfaceUnsortedMapIterable<K,V>
-
groupByUniqueKey
Description copied from interface:RichIterable
For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.- Specified by:
groupByUniqueKey
in interfaceImmutableMap<K,V>
- Specified by:
groupByUniqueKey
in interfaceImmutableMapIterable<K,V>
- Specified by:
groupByUniqueKey
in interfaceRichIterable<K>
- Specified by:
groupByUniqueKey
in interfaceUnsortedMapIterable<K,V>
- See Also:
RichIterable.groupBy(Function)
-
aggregateBy
public <K1, V1, V2> ImmutableMap<K1,V2> aggregateBy(Function<? super K,? extends K1> keyFunction, Function<? super V,? extends V1> valueFunction, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V1,? extends V2> nonMutatingAggregator)Description copied from interface:MapIterable
Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with.MapIterable<String, Interval> map = Maps.mutable.with("oneToFive", Interval.fromTo(1, 5), "sixToNine", Interval.fromTo(6, 9)); MapIterable<String, Long> result = map.aggregateBy( eachKey -> { return eachKey.equals("oneToFive") ? "lessThanSix" : "greaterOrEqualsToSix"; }, each -> each.sumOfInt(Integer::intValue), () -> 0L, (argument1, argument2) -> argument1 + argument2); MapIterable<String, Long> expected = Maps.mutable.with("lessThanSix", Interval.fromTo(1, 5).sumOfInt(Integer::intValue), "greaterOrEqualsToSix", Interval.fromTo(6, 9).sumOfInt(Integer::intValue)); Assert.assertEquals(expected, result);
- Specified by:
aggregateBy
in interfaceImmutableMap<K,V>
- Specified by:
aggregateBy
in interfaceImmutableMapIterable<K,V>
- Specified by:
aggregateBy
in interfaceMapIterable<K,V>
-
aggregateInPlaceBy
public <K2, V2> ImmutableMap<K2,V2> aggregateInPlaceBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Procedure2<? super V2,? super V> mutatingAggregator)Description copied from interface:RichIterable
Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).- Specified by:
aggregateInPlaceBy
in interfaceImmutableMap<K,V>
- Specified by:
aggregateInPlaceBy
in interfaceImmutableMapIterable<K,V>
- Specified by:
aggregateInPlaceBy
in interfaceRichIterable<K>
-
sumByInt
public <V1> ImmutableObjectLongMap<V1> sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByInt
in interfaceRichIterable<K>
-
sumByFloat
public <V1> ImmutableObjectDoubleMap<V1> sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByFloat
in interfaceRichIterable<K>
-
sumByLong
public <V1> ImmutableObjectLongMap<V1> sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByLong
in interfaceRichIterable<K>
-
sumByDouble
public <V1> ImmutableObjectDoubleMap<V1> sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)Description copied from interface:RichIterable
Groups and sums the values using the two specified functions.- Specified by:
sumByDouble
in interfaceRichIterable<K>
-
countBy
Description copied from interface:RichIterable
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.- Specified by:
countBy
in interfaceImmutableMapIterable<K,V>
- Specified by:
countBy
in interfaceRichIterable<K>
- Since:
- 9.0
-
countByWith
public <V1, P> ImmutableBag<V1> countByWith(Function2<? super V,? super P,? extends V1> function, P parameter)Description copied from interface:RichIterable
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.- Specified by:
countByWith
in interfaceImmutableMapIterable<K,V>
- Specified by:
countByWith
in interfaceRichIterable<K>
- Since:
- 9.0
-
countByEach
Description copied from interface:RichIterable
This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.- Specified by:
countByEach
in interfaceImmutableMapIterable<K,V>
- Specified by:
countByEach
in interfaceRichIterable<K>
- Overrides:
countByEach
in classAbstractRichIterable<V>
- Since:
- 10.0.0
-