Class AbstractMutableSortedMap<K,V>
- All Implemented Interfaces:
Cloneable
,Iterable<V>
,Map<K,
,V> SortedMap<K,
,V> InternalIterable<V>
,MapIterable<K,
,V> MutableMapIterable<K,
,V> MutableSortedMap<K,
,V> SortedMapIterable<K,
,V> OrderedIterable<V>
,ReversibleIterable<V>
,RichIterable<V>
- Direct Known Subclasses:
SortedMapAdapter
,TreeSortedMap
-
Nested Class Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns a reversed view of this ReversibleIterable.Returns a synchronized wrapper backed by this map.Returns an unmodifiable view of this map.abstract MutableSortedMap<K,
V> clone()
<R> MutableList<R>
Returns a new collection with the results of applying the specified function on each element of the source collection.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.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.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.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.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> MutableList<R>
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.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.<E> MutableSortedMap<K,
V> collectKeysAndValues
(Iterable<E> iterable, Function<? super E, ? extends K> keyFunction, Function<? super E, ? extends V> valueFunction) Adds all the entries derived fromiterable
tothis
.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.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> MutableSortedMap<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> MutableList<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.<S> boolean
corresponds
(OrderedIterable<S> other, Predicate2<? super V, ? super S> predicate) Returns true if both OrderedIterables have the same length andpredicate
returns true for all corresponding elements e1 of thisOrderedIterable
and e2 ofother
.int
detectIndex
(Predicate<? super V> predicate) Returns the index of the first element of theOrderedIterable
for which thepredicate
evaluates to true.int
detectLastIndex
(Predicate<? super V> predicate) Returns the index of the last element of theReversibleIterable
for which thepredicate
evaluates to true.<R> MutableList<R>
flatCollect
(Function<? super V, ? extends Iterable<R>> function) flatCollect
is a special case ofRichIterable.collect(Function)
.flip()
Given a map from Domain->
Range return a multimap from Range->
Domain.void
Iterates over the section of the iterable covered by the specified inclusive indexes.void
forEachWithIndex
(int fromIndex, int toIndex, ObjectIntProcedure<? super V> objectIntProcedure) Iterates over the section of the iterable covered by the specified inclusive indexes.<VV> MutableListMultimap<VV,
V> 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> MutableListMultimap<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.<VV> MutableMap<VV,
V> groupByUniqueKey
(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 map, where the transformed value is the key.int
Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.Filters a collection into a PartitionedIterable based on the evaluation of the predicate.<P> PartitionMutableList<V>
partitionWith
(Predicate2<? super V, ? super P> predicate, P parameter) Filters a collection into a PartitionIterable based on the evaluation of the predicate.Returns all elements of the source collection that return false when evaluating of the predicate.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> MutableList<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
.Returns all elements of the source collection that return true when evaluating the predicate.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> MutableList<S>
selectInstancesOf
(Class<S> clazz) Returns all elements of the source collection that are instances of the Classclazz
.<P> MutableList<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
.Executes the Procedure for each value of the map and returnsthis
.Returns an immutable copy of this map.toStack()
Converts the OrderedIterable to a mutable MutableStack implementation.withAllKeyValueArguments
(Pair<? extends K, ? extends V>... keyValues) Convenience var-args version of withAllKeyValueswithAllKeyValues
(Iterable<? extends Pair<? extends K, ? extends V>> keyValues) This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.withKeyValue
(K key, V value) This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.withoutAllKeys
(Iterable<? extends K> keys) This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.withoutKey
(K key) This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.<S> MutableList<Pair<V,
S>> Returns aRichIterable
formed from thisRichIterable
and anotherRichIterable
by combining corresponding elements in pairs.Zips thisRichIterable
with its indices.Methods inherited from class org.eclipse.collections.impl.map.mutable.AbstractMutableMapIterable
aggregateBy, collect, countBy, countByEach, countByWith, detect, detectOptional, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, iterator, keysView, keyValuesView, sumByDouble, sumByFloat, sumByInt, sumByLong, updateValue, updateValueWith, valuesView
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, 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
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEachWith
Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size
Methods inherited from interface org.eclipse.collections.api.map.MapIterable
containsKey, containsValue, detect, detectOptional, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, injectIntoKeyValue, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView
Methods inherited from interface org.eclipse.collections.api.map.MutableMapIterable
add, aggregateBy, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWithKey, getOrDefault, putAllMapIterable, putPair, removeAllKeys, removeIf, removeKey, sumByDouble, sumByFloat, sumByInt, sumByLong, updateValue, updateValueWith
Methods inherited from interface org.eclipse.collections.api.map.sorted.MutableSortedMap
collect, collectWithIndex, distinct, drop, dropWhile, entrySet, flatCollectWith, getIfAbsentPutWith, headMap, keySet, newEmpty, partitionWhile, subMap, tailMap, take, takeWhile, toReversed, values, with, withMap, withMapIterable
Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
collectWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, max, min, rejectWithIndex, selectWithIndex, zip, zipWithIndex
Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable
reverseForEach, reverseForEachWithIndex
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, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, 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
Methods inherited from interface java.util.SortedMap
comparator, firstKey, lastKey
Methods inherited from interface org.eclipse.collections.api.map.sorted.SortedMapIterable
comparator
-
Constructor Details
-
AbstractMutableSortedMap
public AbstractMutableSortedMap()
-
-
Method Details
-
clone
- Specified by:
clone
in interfaceMutableSortedMap<K,
V>
-
withKeyValue
Description copied from interface:MutableMapIterable
This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus the additional key and value. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:map = map.withKeyValue("new key", "new value");
In the case of FixedSizeMap, a new instance will be returned by withKeyValue, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.- Specified by:
withKeyValue
in interfaceMutableMapIterable<K,
V> - Specified by:
withKeyValue
in interfaceMutableSortedMap<K,
V> - See Also:
-
withAllKeyValues
public MutableSortedMap<K,V> withAllKeyValues(Iterable<? extends Pair<? extends K, ? extends V>> keyValues) Description copied from interface:MutableMapIterable
This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus all the additional keys and values. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:map = map.withAllKeyValues(FastList.newListWith(PairImpl.of("new key", "new value")));
In the case of FixedSizeMap, a new instance will be returned by withAllKeyValues, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.- Specified by:
withAllKeyValues
in interfaceMutableMapIterable<K,
V> - Specified by:
withAllKeyValues
in interfaceMutableSortedMap<K,
V> - See Also:
-
withAllKeyValueArguments
Description copied from interface:MutableMapIterable
Convenience var-args version of withAllKeyValues- Specified by:
withAllKeyValueArguments
in interfaceMutableMapIterable<K,
V> - Specified by:
withAllKeyValueArguments
in interfaceMutableSortedMap<K,
V> - See Also:
-
withoutKey
Description copied from interface:MutableMapIterable
This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus the key and value to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:map = map.withoutKey("key");
In the case of FixedSizeMap, a new instance will be returned by withoutKey, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.- Specified by:
withoutKey
in interfaceMutableMapIterable<K,
V> - Specified by:
withoutKey
in interfaceMutableSortedMap<K,
V> - See Also:
-
withoutAllKeys
Description copied from interface:MutableMapIterable
This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus all the keys and values to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:map = map.withoutAllKeys(FastList.newListWith("key1", "key2"));
In the case of FixedSizeMap, a new instance will be returned by withoutAllKeys, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.- Specified by:
withoutAllKeys
in interfaceMutableMapIterable<K,
V> - Specified by:
withoutAllKeys
in interfaceMutableSortedMap<K,
V> - See Also:
-
asUnmodifiable
Description copied from interface:MutableMapIterable
Returns an unmodifiable view of this map. This is the equivalent of usingCollections.unmodifiableMap(this)
only with a return type that supports the full iteration protocols available onMutableMapIterable
. Methods which would mutate the underlying map will throw UnsupportedOperationExceptions.- Specified by:
asUnmodifiable
in interfaceMutableMapIterable<K,
V> - Specified by:
asUnmodifiable
in interfaceMutableSortedMap<K,
V> - Returns:
- an unmodifiable view of this map.
- See Also:
-
toImmutable
Description copied from interface:MutableMapIterable
Returns an immutable copy of this map. If the map is immutable, it returns itself.- Specified by:
toImmutable
in interfaceMapIterable<K,
V> - Specified by:
toImmutable
in interfaceMutableMapIterable<K,
V> - Specified by:
toImmutable
in interfaceSortedMapIterable<K,
V>
-
asSynchronized
Description copied from interface:MutableMapIterable
Returns a synchronized wrapper backed by this map. This is the equivalent of callingCollections.synchronizedMap(this)
only with the more feature rich return type ofMutableMapIterable
.The preferred way of iterating over a synchronized map is to use the forEachKey(), forEachValue() and forEachKeyValue() methods which are properly synchronized internally.
MutableMap synchedMap = map.asSynchronized(); synchedMap.forEachKey(key -> ... ); synchedMap.forEachValue(value -> ... ); synchedMap.forEachKeyValue((key, value) -> ... );
If you want to iterate imperatively over the keySet(), values(), or entrySet(), you will need to protect the iteration by wrapping the code in a synchronized block on the map.
- Specified by:
asSynchronized
in interfaceMutableMapIterable<K,
V> - Specified by:
asSynchronized
in interfaceMutableSortedMap<K,
V> - See Also:
-
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 interfaceMapIterable<K,
V> - Specified by:
flip
in interfaceMutableMapIterable<K,
V> - Specified by:
flip
in interfaceMutableSortedMap<K,
V> - Specified by:
flip
in interfaceSortedMapIterable<K,
V>
-
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 interfaceMutableSortedMap<K,
V> - Specified by:
collectBoolean
in interfaceOrderedIterable<K>
- Specified by:
collectBoolean
in interfaceReversibleIterable<K>
- Specified by:
collectBoolean
in interfaceRichIterable<K>
- Specified by:
collectBoolean
in interfaceSortedMapIterable<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 interfaceMutableSortedMap<K,
V> - Specified by:
collectByte
in interfaceOrderedIterable<K>
- Specified by:
collectByte
in interfaceReversibleIterable<K>
- Specified by:
collectByte
in interfaceRichIterable<K>
- Specified by:
collectByte
in interfaceSortedMapIterable<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 interfaceMutableSortedMap<K,
V> - Specified by:
collectChar
in interfaceOrderedIterable<K>
- Specified by:
collectChar
in interfaceReversibleIterable<K>
- Specified by:
collectChar
in interfaceRichIterable<K>
- Specified by:
collectChar
in interfaceSortedMapIterable<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 interfaceMutableSortedMap<K,
V> - Specified by:
collectDouble
in interfaceOrderedIterable<K>
- Specified by:
collectDouble
in interfaceReversibleIterable<K>
- Specified by:
collectDouble
in interfaceRichIterable<K>
- Specified by:
collectDouble
in interfaceSortedMapIterable<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 interfaceMutableSortedMap<K,
V> - Specified by:
collectFloat
in interfaceOrderedIterable<K>
- Specified by:
collectFloat
in interfaceReversibleIterable<K>
- Specified by:
collectFloat
in interfaceRichIterable<K>
- Specified by:
collectFloat
in interfaceSortedMapIterable<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 interfaceMutableSortedMap<K,
V> - Specified by:
collectInt
in interfaceOrderedIterable<K>
- Specified by:
collectInt
in interfaceReversibleIterable<K>
- Specified by:
collectInt
in interfaceRichIterable<K>
- Specified by:
collectInt
in interfaceSortedMapIterable<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 interfaceMutableSortedMap<K,
V> - Specified by:
collectLong
in interfaceOrderedIterable<K>
- Specified by:
collectLong
in interfaceReversibleIterable<K>
- Specified by:
collectLong
in interfaceRichIterable<K>
- Specified by:
collectLong
in interfaceSortedMapIterable<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 interfaceMutableSortedMap<K,
V> - Specified by:
collectShort
in interfaceOrderedIterable<K>
- Specified by:
collectShort
in interfaceReversibleIterable<K>
- Specified by:
collectShort
in interfaceRichIterable<K>
- Specified by:
collectShort
in interfaceSortedMapIterable<K,
V>
-
collectKeysAndValues
public <E> MutableSortedMap<K,V> collectKeysAndValues(Iterable<E> iterable, Function<? super E, ? extends K> keyFunction, Function<? super E, ? extends V> valueFunction) Description copied from interface:MutableSortedMap
Adds all the entries derived fromiterable
tothis
. The key and value for each entry is determined by applying thekeyFunction
andvalueFunction
to each item incollection
. Any entry inmap
that has the same key as an entry inthis
will have it's value replaced by that inmap
.- Specified by:
collectKeysAndValues
in interfaceMutableSortedMap<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 interfaceMapIterable<K,
V> - Specified by:
collectValues
in interfaceMutableMapIterable<K,
V> - Specified by:
collectValues
in interfaceMutableSortedMap<K,
V> - Specified by:
collectValues
in interfaceSortedMapIterable<K,
V>
-
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 interfaceMapIterable<K,
V> - Specified by:
tap
in interfaceMutableMapIterable<K,
V> - Specified by:
tap
in interfaceMutableSortedMap<K,
V> - Specified by:
tap
in interfaceOrderedIterable<K>
- Specified by:
tap
in interfaceReversibleIterable<K>
- Specified by:
tap
in interfaceRichIterable<K>
- Specified by:
tap
in interfaceSortedMapIterable<K,
V> - See Also:
-
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 interfaceMapIterable<K,
V> - Specified by:
select
in interfaceMutableMapIterable<K,
V> - Specified by:
select
in interfaceMutableSortedMap<K,
V> - Specified by:
select
in interfaceSortedMapIterable<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 interfaceMapIterable<K,
V> - Specified by:
reject
in interfaceMutableMapIterable<K,
V> - Specified by:
reject
in interfaceMutableSortedMap<K,
V> - Specified by:
reject
in interfaceSortedMapIterable<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 interfaceMutableSortedMap<K,
V> - Specified by:
collect
in interfaceOrderedIterable<K>
- Specified by:
collect
in interfaceReversibleIterable<K>
- Specified by:
collect
in interfaceRichIterable<K>
- Specified by:
collect
in interfaceSortedMapIterable<K,
V>
-
collectWith
public <P,VV> MutableList<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 interfaceMutableSortedMap<K,
V> - Specified by:
collectWith
in interfaceOrderedIterable<K>
- Specified by:
collectWith
in interfaceReversibleIterable<K>
- Specified by:
collectWith
in interfaceRichIterable<K>
- Specified by:
collectWith
in interfaceSortedMapIterable<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:
-
collectIf
public <R> MutableList<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 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 interfaceMutableSortedMap<K,
V> - Specified by:
collectIf
in interfaceOrderedIterable<K>
- Specified by:
collectIf
in interfaceReversibleIterable<K>
- Specified by:
collectIf
in interfaceRichIterable<K>
- Specified by:
collectIf
in interfaceSortedMapIterable<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 interfaceMutableSortedMap<K,
V> - Specified by:
flatCollect
in interfaceOrderedIterable<K>
- Specified by:
flatCollect
in interfaceReversibleIterable<K>
- Specified by:
flatCollect
in interfaceRichIterable<K>
- Specified by:
flatCollect
in interfaceSortedMapIterable<K,
V> - Parameters:
function
- TheFunction
to apply- Returns:
- a new flattened collection produced by applying the given
function
-
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 interfaceMutableMapIterable<K,
V> - Specified by:
reject
in interfaceMutableSortedMap<K,
V> - Specified by:
reject
in interfaceOrderedIterable<K>
- Specified by:
reject
in interfaceReversibleIterable<K>
- Specified by:
reject
in interfaceRichIterable<K>
- Specified by:
reject
in interfaceSortedMapIterable<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
-
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 interfaceMutableMapIterable<K,
V> - Specified by:
selectWith
in interfaceMutableSortedMap<K,
V> - Specified by:
selectWith
in interfaceOrderedIterable<K>
- Specified by:
selectWith
in interfaceReversibleIterable<K>
- Specified by:
selectWith
in interfaceRichIterable<K>
- Specified by:
selectWith
in interfaceSortedMapIterable<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:
-
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 interfaceMutableMapIterable<K,
V> - Specified by:
rejectWith
in interfaceMutableSortedMap<K,
V> - Specified by:
rejectWith
in interfaceOrderedIterable<K>
- Specified by:
rejectWith
in interfaceReversibleIterable<K>
- Specified by:
rejectWith
in interfaceRichIterable<K>
- Specified by:
rejectWith
in interfaceSortedMapIterable<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:
-
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 interfaceMutableMapIterable<K,
V> - Specified by:
select
in interfaceMutableSortedMap<K,
V> - Specified by:
select
in interfaceOrderedIterable<K>
- Specified by:
select
in interfaceReversibleIterable<K>
- Specified by:
select
in interfaceRichIterable<K>
- Specified by:
select
in interfaceSortedMapIterable<K,
V>
-
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 interfaceMutableMapIterable<K,
V> - Specified by:
partition
in interfaceMutableSortedMap<K,
V> - Specified by:
partition
in interfaceOrderedIterable<K>
- Specified by:
partition
in interfaceReversibleIterable<K>
- Specified by:
partition
in interfaceRichIterable<K>
- Specified by:
partition
in interfaceSortedMapIterable<K,
V>
-
partitionWith
public <P> PartitionMutableList<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 interfaceMutableSortedMap<K,
V> - Specified by:
partitionWith
in interfaceOrderedIterable<K>
- Specified by:
partitionWith
in interfaceReversibleIterable<K>
- Specified by:
partitionWith
in interfaceRichIterable<K>
- Specified by:
partitionWith
in interfaceSortedMapIterable<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 interfaceMutableMapIterable<K,
V> - Specified by:
selectInstancesOf
in interfaceMutableSortedMap<K,
V> - Specified by:
selectInstancesOf
in interfaceOrderedIterable<K>
- Specified by:
selectInstancesOf
in interfaceReversibleIterable<K>
- Specified by:
selectInstancesOf
in interfaceRichIterable<K>
- Specified by:
selectInstancesOf
in interfaceSortedMapIterable<K,
V>
-
zip
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 interfaceMutableMapIterable<K,
V> - Specified by:
zip
in interfaceMutableSortedMap<K,
V> - Specified by:
zip
in interfaceOrderedIterable<K>
- Specified by:
zip
in interfaceReversibleIterable<K>
- Specified by:
zip
in interfaceRichIterable<K>
- Specified by:
zip
in interfaceSortedMapIterable<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
Description copied from interface:RichIterable
Zips thisRichIterable
with its indices.- Specified by:
zipWithIndex
in interfaceMutableMapIterable<K,
V> - Specified by:
zipWithIndex
in interfaceMutableSortedMap<K,
V> - Specified by:
zipWithIndex
in interfaceOrderedIterable<K>
- Specified by:
zipWithIndex
in interfaceReversibleIterable<K>
- Specified by:
zipWithIndex
in interfaceRichIterable<K>
- Specified by:
zipWithIndex
in interfaceSortedMapIterable<K,
V> - Returns:
- A new
RichIterable
containing pairs consisting of all elements of thisRichIterable
paired with their index. Indices start at 0. - See Also:
-
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 interfaceMutableMapIterable<K,
V> - Specified by:
groupBy
in interfaceMutableSortedMap<K,
V> - Specified by:
groupBy
in interfaceOrderedIterable<K>
- Specified by:
groupBy
in interfaceReversibleIterable<K>
- Specified by:
groupBy
in interfaceRichIterable<K>
- Specified by:
groupBy
in interfaceSortedMapIterable<K,
V>
-
groupByEach
public <VV> MutableListMultimap<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 interfaceMutableMapIterable<K,
V> - Specified by:
groupByEach
in interfaceMutableSortedMap<K,
V> - Specified by:
groupByEach
in interfaceOrderedIterable<K>
- Specified by:
groupByEach
in interfaceReversibleIterable<K>
- Specified by:
groupByEach
in interfaceRichIterable<K>
- Specified by:
groupByEach
in interfaceSortedMapIterable<K,
V>
-
groupByUniqueKey
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 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 interfaceMutableMapIterable<K,
V> - Specified by:
groupByUniqueKey
in interfaceMutableSortedMap<K,
V> - Specified by:
groupByUniqueKey
in interfaceRichIterable<K>
- Overrides:
groupByUniqueKey
in classAbstractMutableMapIterable<K,
V> - See Also:
-
asReversed
Description copied from interface:ReversibleIterable
Returns a reversed view of this ReversibleIterable.- Specified by:
asReversed
in interfaceReversibleIterable<K>
-
detectLastIndex
Description copied from interface:ReversibleIterable
Returns the index of the last element of theReversibleIterable
for which thepredicate
evaluates to true. Returns -1 if no element evaluates true for thepredicate
.- Specified by:
detectLastIndex
in interfaceReversibleIterable<K>
-
indexOf
Description copied from interface:OrderedIterable
Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.- Specified by:
indexOf
in interfaceOrderedIterable<K>
- See Also:
-
corresponds
Description copied from interface:OrderedIterable
Returns true if both OrderedIterables have the same length andpredicate
returns true for all corresponding elements e1 of thisOrderedIterable
and e2 ofother
. Thepredicate
is evaluated for each element at the same position of eachOrderedIterable
in a forward iteration order. This is a short circuit pattern.- Specified by:
corresponds
in interfaceOrderedIterable<K>
-
forEach
Description copied from interface:OrderedIterable
Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.e.g. OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally) people.forEach(0, 1, new Procedure<Person>() { public void value(Person person) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
- Specified by:
forEach
in interfaceOrderedIterable<K>
-
forEachWithIndex
public void forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super V> objectIntProcedure) Description copied from interface:OrderedIterable
Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.e.g. OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally) people.forEachWithIndex(0, 1, new ObjectIntProcedure<Person>() { public void value(Person person, int index) { LOGGER.info(person.getName()); } });
This code would output ted and mary's names.
- Specified by:
forEachWithIndex
in interfaceOrderedIterable<K>
-
toStack
Description copied from interface:OrderedIterable
Converts the OrderedIterable to a mutable MutableStack implementation.- Specified by:
toStack
in interfaceOrderedIterable<K>
-
detectIndex
Description copied from interface:OrderedIterable
Returns the index of the first element of theOrderedIterable
for which thepredicate
evaluates to true. Returns -1 if no element evaluates true for thepredicate
.- Specified by:
detectIndex
in interfaceOrderedIterable<K>
-