Class AbstractImmutableMap<K,V>
- java.lang.Object
-
- org.eclipse.collections.impl.AbstractRichIterable<V>
-
- org.eclipse.collections.impl.map.AbstractMapIterable<K,V>
-
- org.eclipse.collections.impl.map.immutable.AbstractImmutableMap<K,V>
-
- All Implemented Interfaces:
java.lang.Iterable<V>,java.util.Map<K,V>,InternalIterable<V>,ImmutableMap<K,V>,ImmutableMapIterable<K,V>,MapIterable<K,V>,UnsortedMapIterable<K,V>,RichIterable<V>
- Direct Known Subclasses:
ImmutableDoubletonMap,ImmutableEmptyMap,ImmutableEmptyMapWithHashingStrategy,ImmutableQuadrupletonMap,ImmutableSingletonMap,ImmutableTripletonMap,ImmutableUnifiedMap,ImmutableUnifiedMapWithHashingStrategy
public abstract class AbstractImmutableMap<K,V> extends AbstractMapIterable<K,V> implements ImmutableMap<K,V>, java.util.Map<K,V>
-
-
Constructor Summary
Constructors Constructor Description AbstractImmutableMap()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods 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.java.util.Map<K,V>castToMap()voidclear()<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.ImmutableBooleanBagcollectBoolean(BooleanFunction<? super V> booleanFunction)Returns a new primitivebooleaniterable with the results of applying the specified function on each element of the source collection.ImmutableByteBagcollectByte(ByteFunction<? super V> byteFunction)Returns a new primitivebyteiterable with the results of applying the specified function on each element of the source collection.ImmutableCharBagcollectChar(CharFunction<? super V> charFunction)Returns a new primitivechariterable with the results of applying the specified function on each element of the source collection.ImmutableDoubleBagcollectDouble(DoubleFunction<? super V> doubleFunction)Returns a new primitivedoubleiterable with the results of applying the specified function on each element of the source collection.ImmutableFloatBagcollectFloat(FloatFunction<? super V> floatFunction)Returns a new primitivefloatiterable 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.ImmutableIntBagcollectInt(IntFunction<? super V> intFunction)Returns a new primitiveintiterable with the results of applying the specified function on each element of the source collection.<R> ImmutableMap<R,V>collectKeysUnique(Function2<? super K,? super V,? extends R> function)For each key and value of the map the function is evaluated.ImmutableLongBagcollectLong(LongFunction<? super V> longFunction)Returns a new primitivelongiterable with the results of applying the specified function on each element of the source collection.ImmutableShortBagcollectShort(ShortFunction<? super V> shortFunction)Returns a new primitiveshortiterable 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 aFunction2and 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 java.lang.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.java.util.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.java.util.Set<java.util.Map.Entry<K,V>>entrySet()<R> ImmutableBag<R>flatCollect(Function<? super V,? extends java.lang.Iterable<R>> function)flatCollectis 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.voidforEach(java.util.function.BiConsumer<? super K,? super V> action)<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 java.lang.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 the results of these evaluations are collected into a new map, where the transformed value is the key.java.util.Iterator<V>iterator()ImmutableMap<K,V>newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)ImmutableMap<K,V>newWithAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)ImmutableMap<K,V>newWithKeyValue(K key, V value)ImmutableMap<K,V>newWithMap(java.util.Map<? extends K,? extends V> map)ImmutableMap<K,V>newWithMapIterable(MapIterable<? extends K,? extends V> mapIterable)ImmutableMap<K,V>newWithoutAllKeys(java.lang.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.Vput(K key, V value)voidputAll(java.util.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.Vremove(java.lang.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(java.lang.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(java.lang.Iterable<S> that)Deprecated.in 6.0.ImmutableSet<Pair<V,java.lang.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, isAbsent, keyAndValueEquals, keyAndValueHashCode, noneSatisfy, noneSatisfyWith, toArray, toArray
-
Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable
appendString, appendString, collect, collectIf, 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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.collections.api.map.ImmutableMap
aggregateBy, aggregateInPlaceBy, flatCollectWith, reduceBy
-
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, 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, injectIntoKeyValue, 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, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, 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, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex
-
-
-
-
Method Detail
-
castToMap
public java.util.Map<K,V> castToMap()
- Specified by:
castToMapin interfaceImmutableMapIterable<K,V>
-
toMap
public MutableMap<K,V> toMap()
- Specified by:
toMapin interfaceImmutableMap<K,V>
-
toImmutable
public ImmutableMap<K,V> toImmutable()
Description copied from interface:UnsortedMapIterableConverts the UnsortedMapIterable to an immutable implementation. Returns this for immutable maps.- Specified by:
toImmutablein interfaceMapIterable<K,V>- Specified by:
toImmutablein interfaceUnsortedMapIterable<K,V>
-
iterator
public java.util.Iterator<V> iterator()
- Specified by:
iteratorin interfacejava.lang.Iterable<K>
-
flip
public ImmutableSetMultimap<V,K> flip()
Description copied from interface:MapIterableGiven 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:
flipin interfaceImmutableMap<K,V>- Specified by:
flipin interfaceImmutableMapIterable<K,V>- Specified by:
flipin interfaceMapIterable<K,V>- Specified by:
flipin interfaceUnsortedMapIterable<K,V>
-
newWithKeyValue
public ImmutableMap<K,V> newWithKeyValue(K key, V value)
- Specified by:
newWithKeyValuein interfaceImmutableMap<K,V>- Specified by:
newWithKeyValuein interfaceImmutableMapIterable<K,V>
-
newWithAllKeyValues
public ImmutableMap<K,V> newWithAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)
- Specified by:
newWithAllKeyValuesin interfaceImmutableMap<K,V>- Specified by:
newWithAllKeyValuesin interfaceImmutableMapIterable<K,V>
-
newWithMap
public ImmutableMap<K,V> newWithMap(java.util.Map<? extends K,? extends V> map)
- Specified by:
newWithMapin interfaceImmutableMap<K,V>- Specified by:
newWithMapin interfaceImmutableMapIterable<K,V>
-
newWithMapIterable
public ImmutableMap<K,V> newWithMapIterable(MapIterable<? extends K,? extends V> mapIterable)
- Specified by:
newWithMapIterablein interfaceImmutableMap<K,V>- Specified by:
newWithMapIterablein interfaceImmutableMapIterable<K,V>
-
newWithAllKeyValueArguments
public ImmutableMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
- Specified by:
newWithAllKeyValueArgumentsin interfaceImmutableMap<K,V>- Specified by:
newWithAllKeyValueArgumentsin interfaceImmutableMapIterable<K,V>
-
newWithoutKey
public ImmutableMap<K,V> newWithoutKey(K key)
- Specified by:
newWithoutKeyin interfaceImmutableMap<K,V>- Specified by:
newWithoutKeyin interfaceImmutableMapIterable<K,V>
-
newWithoutAllKeys
public ImmutableMap<K,V> newWithoutAllKeys(java.lang.Iterable<? extends K> keys)
- Specified by:
newWithoutAllKeysin interfaceImmutableMap<K,V>- Specified by:
newWithoutAllKeysin interfaceImmutableMapIterable<K,V>
-
flipUniqueValues
public ImmutableMap<V,K> flipUniqueValues()
Description copied from interface:MapIterableReturn 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:
flipUniqueValuesin interfaceImmutableMap<K,V>- Specified by:
flipUniqueValuesin interfaceImmutableMapIterable<K,V>- Specified by:
flipUniqueValuesin interfaceMapIterable<K,V>- Specified by:
flipUniqueValuesin interfaceUnsortedMapIterable<K,V>
-
collect
public <K2,V2> ImmutableMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)
Description copied from interface:MapIterableFor 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:
collectin interfaceImmutableMap<K,V>- Specified by:
collectin interfaceImmutableMapIterable<K,V>- Specified by:
collectin interfaceMapIterable<K,V>- Specified by:
collectin interfaceUnsortedMapIterable<K,V>
-
collectValues
public <R> ImmutableMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)
Description copied from interface:MapIterableFor 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:
collectValuesin interfaceImmutableMap<K,V>- Specified by:
collectValuesin interfaceImmutableMapIterable<K,V>- Specified by:
collectValuesin interfaceMapIterable<K,V>- Specified by:
collectValuesin interfaceUnsortedMapIterable<K,V>
-
collectKeysUnique
public <R> ImmutableMap<R,V> collectKeysUnique(Function2<? super K,? super V,? extends R> function)
Description copied from interface:MapIterableFor 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 keys projected from the function rather than the original keys.- Specified by:
collectKeysUniquein interfaceImmutableMap<K,V>- Specified by:
collectKeysUniquein interfaceImmutableMapIterable<K,V>- Specified by:
collectKeysUniquein interfaceMapIterable<K,V>
-
select
public ImmutableMap<K,V> select(Predicate2<? super K,? super V> predicate)
Description copied from interface:MapIterableFor 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:
selectin interfaceImmutableMap<K,V>- Specified by:
selectin interfaceImmutableMapIterable<K,V>- Specified by:
selectin interfaceMapIterable<K,V>- Specified by:
selectin interfaceUnsortedMapIterable<K,V>
-
reject
public ImmutableMap<K,V> reject(Predicate2<? super K,? super V> predicate)
Description copied from interface:MapIterableFor 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:
rejectin interfaceImmutableMap<K,V>- Specified by:
rejectin interfaceImmutableMapIterable<K,V>- Specified by:
rejectin interfaceMapIterable<K,V>- Specified by:
rejectin interfaceUnsortedMapIterable<K,V>
-
detect
public Pair<K,V> detect(Predicate2<? super K,? super V> predicate)
Description copied from interface:MapIterableReturn 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 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:
detectin interfaceMapIterable<K,V>
-
detectOptional
public java.util.Optional<Pair<K,V>> detectOptional(Predicate2<? super K,? super V> predicate)
Description copied from interface:MapIterableReturn 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 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:
detectOptionalin interfaceMapIterable<K,V>
-
collect
public <R> ImmutableBag<R> collect(Function<? super V,? extends R> function)
Description copied from interface:RichIterableReturns 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());- Specified by:
collectin interfaceImmutableMap<K,V>- Specified by:
collectin interfaceRichIterable<K>- Specified by:
collectin interfaceUnsortedMapIterable<K,V>
-
collectWith
public <P,VV> ImmutableBag<VV> collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)
Description copied from interface:RichIterableSame asRichIterable.collect(Function)with aFunction2and 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));- Specified by:
collectWithin interfaceImmutableMap<K,V>- Specified by:
collectWithin interfaceRichIterable<K>- Specified by:
collectWithin interfaceUnsortedMapIterable<K,V>- Parameters:
function- AFunction2to use as the collect transformation functionparameter- A parameter to pass in for evaluation of the second argumentPinfunction- Returns:
- A new
RichIterablethat contains the transformed elements returned byFunction2.value(Object, Object) - See Also:
RichIterable.collect(Function)
-
collectBoolean
public ImmutableBooleanBag collectBoolean(BooleanFunction<? super V> booleanFunction)
Description copied from interface:RichIterableReturns a new primitivebooleaniterable 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());- Specified by:
collectBooleanin interfaceImmutableMap<K,V>- Specified by:
collectBooleanin interfaceRichIterable<K>- Specified by:
collectBooleanin interfaceUnsortedMapIterable<K,V>
-
collectByte
public ImmutableByteBag collectByte(ByteFunction<? super V> byteFunction)
Description copied from interface:RichIterableReturns a new primitivebyteiterable 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());- Specified by:
collectBytein interfaceImmutableMap<K,V>- Specified by:
collectBytein interfaceRichIterable<K>- Specified by:
collectBytein interfaceUnsortedMapIterable<K,V>
-
collectChar
public ImmutableCharBag collectChar(CharFunction<? super V> charFunction)
Description copied from interface:RichIterableReturns a new primitivechariterable 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());- Specified by:
collectCharin interfaceImmutableMap<K,V>- Specified by:
collectCharin interfaceRichIterable<K>- Specified by:
collectCharin interfaceUnsortedMapIterable<K,V>
-
collectDouble
public ImmutableDoubleBag collectDouble(DoubleFunction<? super V> doubleFunction)
Description copied from interface:RichIterableReturns a new primitivedoubleiterable 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());- Specified by:
collectDoublein interfaceImmutableMap<K,V>- Specified by:
collectDoublein interfaceRichIterable<K>- Specified by:
collectDoublein interfaceUnsortedMapIterable<K,V>
-
collectFloat
public ImmutableFloatBag collectFloat(FloatFunction<? super V> floatFunction)
Description copied from interface:RichIterableReturns a new primitivefloatiterable 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());- Specified by:
collectFloatin interfaceImmutableMap<K,V>- Specified by:
collectFloatin interfaceRichIterable<K>- Specified by:
collectFloatin interfaceUnsortedMapIterable<K,V>
-
collectInt
public ImmutableIntBag collectInt(IntFunction<? super V> intFunction)
Description copied from interface:RichIterableReturns a new primitiveintiterable 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());- Specified by:
collectIntin interfaceImmutableMap<K,V>- Specified by:
collectIntin interfaceRichIterable<K>- Specified by:
collectIntin interfaceUnsortedMapIterable<K,V>
-
collectLong
public ImmutableLongBag collectLong(LongFunction<? super V> longFunction)
Description copied from interface:RichIterableReturns a new primitivelongiterable 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());- Specified by:
collectLongin interfaceImmutableMap<K,V>- Specified by:
collectLongin interfaceRichIterable<K>- Specified by:
collectLongin interfaceUnsortedMapIterable<K,V>
-
collectShort
public ImmutableShortBag collectShort(ShortFunction<? super V> shortFunction)
Description copied from interface:RichIterableReturns a new primitiveshortiterable 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());- Specified by:
collectShortin interfaceImmutableMap<K,V>- Specified by:
collectShortin interfaceRichIterable<K>- Specified by:
collectShortin interfaceUnsortedMapIterable<K,V>
-
collectIf
public <R> ImmutableBag<R> collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> function)
Description copied from interface:RichIterableReturns 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 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:
collectIfin interfaceImmutableMap<K,V>- Specified by:
collectIfin interfaceRichIterable<K>- Specified by:
collectIfin interfaceUnsortedMapIterable<K,V>
-
flatCollect
public <R> ImmutableBag<R> flatCollect(Function<? super V,? extends java.lang.Iterable<R>> function)
Description copied from interface:RichIterableflatCollectis a special case ofRichIterable.collect(Function). Withcollect, when theFunctionreturns a collection, the result is a collection of collections.flatCollectoutputs a single "flattened" collection instead. This method is commonly called flatMap.Consider the following example where we have a
Personclass, and eachPersonhas a list ofAddressobjects. Take the followingFunction:Function<Person, List<Address>> addressFunction = Person::getAddresses; RichIterable<Person> people = ...;
Usingcollectreturns a collection of collections of addresses.RichIterable<List<Address>> addresses = people.collect(addressFunction);
UsingflatCollectreturns a single flattened list of addresses.RichIterable<Address> addresses = people.flatCollect(addressFunction);
- Specified by:
flatCollectin interfaceImmutableMap<K,V>- Specified by:
flatCollectin interfaceRichIterable<K>- Specified by:
flatCollectin interfaceUnsortedMapIterable<K,V>- Parameters:
function- TheFunctionto apply- Returns:
- a new flattened collection produced by applying the given
function
-
select
public ImmutableBag<V> select(Predicate<? super V> predicate)
Description copied from interface:RichIterableReturns 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"));- Specified by:
selectin interfaceImmutableMap<K,V>- Specified by:
selectin interfaceImmutableMapIterable<K,V>- Specified by:
selectin interfaceRichIterable<K>- Specified by:
selectin interfaceUnsortedMapIterable<K,V>
-
selectWith
public <P> ImmutableBag<V> selectWith(Predicate2<? super V,? super P> predicate, P parameter)
Description copied from interface:RichIterableSimilar toRichIterable.select(Predicate), except with an evaluation parameter for the second generic argument inPredicate2.E.g. return a
Collectionof 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));- Specified by:
selectWithin interfaceImmutableMap<K,V>- Specified by:
selectWithin interfaceImmutableMapIterable<K,V>- Specified by:
selectWithin interfaceRichIterable<K>- Specified by:
selectWithin interfaceUnsortedMapIterable<K,V>- Parameters:
predicate- aPredicate2to use as the select criteriaparameter- a parameter to pass in for evaluation of the second argumentPinpredicate- See Also:
RichIterable.select(Predicate)
-
tap
public ImmutableMap<K,V> tap(Procedure<? super V> procedure)
Description copied from interface:MapIterableExecutes the Procedure for each value of the map and returnsthis.return peopleByCity.tap(person -> LOGGER.info(person.getName()));
- Specified by:
tapin interfaceImmutableMap<K,V>- Specified by:
tapin interfaceImmutableMapIterable<K,V>- Specified by:
tapin interfaceMapIterable<K,V>- Specified by:
tapin interfaceRichIterable<K>- Specified by:
tapin interfaceUnsortedMapIterable<K,V>- See Also:
RichIterable.forEach(Procedure)
-
reject
public ImmutableBag<V> reject(Predicate<? super V> predicate)
Description copied from interface:RichIterableReturns 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"));- Specified by:
rejectin interfaceImmutableMap<K,V>- Specified by:
rejectin interfaceImmutableMapIterable<K,V>- Specified by:
rejectin interfaceRichIterable<K>- Specified by:
rejectin interfaceUnsortedMapIterable<K,V>- Parameters:
predicate- aPredicateto use as the reject criteria- Returns:
- a RichIterable that contains elements that cause
Predicate.accept(Object)method to evaluate to false
-
rejectWith
public <P> ImmutableBag<V> rejectWith(Predicate2<? super V,? super P> predicate, P parameter)
Description copied from interface:RichIterableSimilar toRichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument inPredicate2.E.g. return a
Collectionof 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));- Specified by:
rejectWithin interfaceImmutableMap<K,V>- Specified by:
rejectWithin interfaceImmutableMapIterable<K,V>- Specified by:
rejectWithin interfaceRichIterable<K>- Specified by:
rejectWithin interfaceUnsortedMapIterable<K,V>- Parameters:
predicate- aPredicate2to use as the select criteriaparameter- a parameter to pass in for evaluation of the second argumentPinpredicate- See Also:
RichIterable.select(Predicate)
-
partition
public PartitionImmutableBag<V> partition(Predicate<? super V> predicate)
Description copied from interface:RichIterableFilters 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"));- Specified by:
partitionin interfaceImmutableMap<K,V>- Specified by:
partitionin interfaceImmutableMapIterable<K,V>- Specified by:
partitionin interfaceRichIterable<K>- Specified by:
partitionin interfaceUnsortedMapIterable<K,V>
-
partitionWith
public <P> PartitionImmutableBag<V> partitionWith(Predicate2<? super V,? super P> predicate, P parameter)
Description copied from interface:RichIterableFilters 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");- Specified by:
partitionWithin interfaceImmutableMap<K,V>- Specified by:
partitionWithin interfaceRichIterable<K>- Specified by:
partitionWithin interfaceUnsortedMapIterable<K,V>
-
selectInstancesOf
public <S> ImmutableBag<S> selectInstancesOf(java.lang.Class<S> clazz)
Description copied from interface:RichIterableReturns 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:
selectInstancesOfin interfaceImmutableMap<K,V>- Specified by:
selectInstancesOfin interfaceImmutableMapIterable<K,V>- Specified by:
selectInstancesOfin interfaceRichIterable<K>- Specified by:
selectInstancesOfin interfaceUnsortedMapIterable<K,V>
-
zip
@Deprecated public <S> ImmutableBag<Pair<V,S>> zip(java.lang.Iterable<S> that)
Deprecated.in 6.0. UseOrderedIterable.zip(Iterable)instead.Description copied from interface:RichIterableReturns aRichIterableformed from thisRichIterableand anotherRichIterableby combining corresponding elements in pairs. If one of the twoRichIterables is longer than the other, its remaining elements are ignored.- Specified by:
zipin interfaceImmutableMap<K,V>- Specified by:
zipin interfaceImmutableMapIterable<K,V>- Specified by:
zipin interfaceRichIterable<K>- Specified by:
zipin interfaceUnsortedMapIterable<K,V>- Type Parameters:
S- the type of the second half of the returned pairs- Parameters:
that- TheRichIterableproviding the second half of each result pair- Returns:
- A new
RichIterablecontaining pairs consisting of corresponding elements of thisRichIterableand that. The length of the returnedRichIterableis the minimum of the lengths of thisRichIterableand that.
-
zipWithIndex
@Deprecated public ImmutableSet<Pair<V,java.lang.Integer>> zipWithIndex()
Deprecated.in 6.0. UseOrderedIterable.zipWithIndex()instead.Description copied from interface:RichIterableZips thisRichIterablewith its indices.- Specified by:
zipWithIndexin interfaceImmutableMap<K,V>- Specified by:
zipWithIndexin interfaceImmutableMapIterable<K,V>- Specified by:
zipWithIndexin interfaceRichIterable<K>- Specified by:
zipWithIndexin interfaceUnsortedMapIterable<K,V>- Returns:
- A new
RichIterablecontaining pairs consisting of all elements of thisRichIterablepaired with their index. Indices start at 0. - See Also:
RichIterable.zip(Iterable)
-
groupBy
public <VV> ImmutableBagMultimap<VV,V> groupBy(Function<? super V,? extends VV> function)
Description copied from interface:RichIterableFor 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);- Specified by:
groupByin interfaceImmutableMap<K,V>- Specified by:
groupByin interfaceImmutableMapIterable<K,V>- Specified by:
groupByin interfaceRichIterable<K>- Specified by:
groupByin interfaceUnsortedMapIterable<K,V>
-
groupByEach
public <VV> ImmutableBagMultimap<VV,V> groupByEach(Function<? super V,? extends java.lang.Iterable<VV>> function)
Description copied from interface:RichIterableSimilar toRichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.- Specified by:
groupByEachin interfaceImmutableMap<K,V>- Specified by:
groupByEachin interfaceImmutableMapIterable<K,V>- Specified by:
groupByEachin interfaceRichIterable<K>- Specified by:
groupByEachin interfaceUnsortedMapIterable<K,V>
-
groupByUniqueKey
public <V1> ImmutableMap<V1,V> groupByUniqueKey(Function<? super V,? extends V1> function)
Description copied from interface:RichIterableFor each element of the iterable, the function is evaluated, and the 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:
groupByUniqueKeyin interfaceImmutableMap<K,V>- Specified by:
groupByUniqueKeyin interfaceImmutableMapIterable<K,V>- Specified by:
groupByUniqueKeyin interfaceRichIterable<K>- Specified by:
groupByUniqueKeyin 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:MapIterableApplies 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:
aggregateByin interfaceImmutableMap<K,V>- Specified by:
aggregateByin interfaceImmutableMapIterable<K,V>- Specified by:
aggregateByin interfaceMapIterable<K,V>
-
sumByInt
public <V1> ImmutableObjectLongMap<V1> sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)
Description copied from interface:RichIterableGroups and sums the values using the two specified functions.- Specified by:
sumByIntin interfaceRichIterable<K>
-
sumByFloat
public <V1> ImmutableObjectDoubleMap<V1> sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)
Description copied from interface:RichIterableGroups and sums the values using the two specified functions.- Specified by:
sumByFloatin interfaceRichIterable<K>
-
sumByLong
public <V1> ImmutableObjectLongMap<V1> sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)
Description copied from interface:RichIterableGroups and sums the values using the two specified functions.- Specified by:
sumByLongin interfaceRichIterable<K>
-
sumByDouble
public <V1> ImmutableObjectDoubleMap<V1> sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)
Description copied from interface:RichIterableGroups and sums the values using the two specified functions.- Specified by:
sumByDoublein interfaceRichIterable<K>
-
countBy
public <V1> ImmutableBag<V1> countBy(Function<? super V,? extends V1> function)
Description copied from interface:RichIterableThis method will count the number of occurrences of each value calculated by applying the function to each element of the collection.- Specified by:
countByin interfaceImmutableMapIterable<K,V>- Specified by:
countByin 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:RichIterableThis 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:
countByWithin interfaceImmutableMapIterable<K,V>- Specified by:
countByWithin interfaceRichIterable<K>- Since:
- 9.0
-
countByEach
public <V1> ImmutableBag<V1> countByEach(Function<? super V,? extends java.lang.Iterable<V1>> function)
Description copied from interface:RichIterableThis method will count the number of occurrences of each value calculated by applying the function to each element of the collection.- Specified by:
countByEachin interfaceImmutableMapIterable<K,V>- Specified by:
countByEachin interfaceRichIterable<K>- Overrides:
countByEachin classAbstractRichIterable<V>- Since:
- 10.0.0
-
-