Interface MutableSortedMap<K,V>
-
- All Superinterfaces:
Cloneable,InternalIterable<V>,Iterable<V>,Map<K,V>,MapIterable<K,V>,MutableMapIterable<K,V>,OrderedIterable<V>,ReversibleIterable<V>,RichIterable<V>,SortedMap<K,V>,SortedMapIterable<K,V>
public interface MutableSortedMap<K,V> extends MutableMapIterable<K,V>, SortedMapIterable<K,V>, SortedMap<K,V>, Cloneable
A MutableSortedMap is similar to a JCF Map but adds additional useful internal iterator methods. The MutableSortedMap interface additionally implements some methods in the Smalltalk Dictionary protocol.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description MutableSortedMap<K,V>asSynchronized()Returns a synchronized wrapper backed by this map.MutableSortedMap<K,V>asUnmodifiable()Returns an unmodifiable view of this map.MutableSortedMap<K,V>clone()<R> MutableList<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>
MutableMap<K2,V2>collect(Function2<? super K,? super V,Pair<K2,V2>> function)For each key and value of the map the function is evaluated.MutableBooleanListcollectBoolean(BooleanFunction<? super V> booleanFunction)Returns a new primitivebooleaniterable with the results of applying the specified function on each element of the source collection.MutableByteListcollectByte(ByteFunction<? super V> byteFunction)Returns a new primitivebyteiterable with the results of applying the specified function on each element of the source collection.MutableCharListcollectChar(CharFunction<? super V> charFunction)Returns a new primitivechariterable with the results of applying the specified function on each element of the source collection.MutableDoubleListcollectDouble(DoubleFunction<? super V> doubleFunction)Returns a new primitivedoubleiterable with the results of applying the specified function on each element of the source collection.MutableFloatListcollectFloat(FloatFunction<? super V> floatFunction)Returns a new primitivefloatiterable with the results of applying the specified function on each element of the source collection.<R> MutableList<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.MutableIntListcollectInt(IntFunction<? super V> intFunction)Returns a new primitiveintiterable 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 fromiterabletothis.MutableLongListcollectLong(LongFunction<? super V> longFunction)Returns a new primitivelongiterable with the results of applying the specified function on each element of the source collection.MutableShortListcollectShort(ShortFunction<? super V> shortFunction)Returns a new primitiveshortiterable 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 aFunction2and specified parameter which is passed to the block.default <R> MutableList<R>collectWithIndex(ObjectIntToObjectFunction<? super V,? extends R> function)Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.MutableList<V>distinct()Returns a newOrderedIterablecontaining the distinct elements in this iterable.MutableSortedMap<K,V>drop(int count)Returns an iterable after skipping the firstcountelements or an empty iterable if thecountis greater than the length of the iterable.MutableSortedMap<K,V>dropWhile(Predicate<? super V> predicate)Returns the final elements that do not satisfy the Predicate.MutableSet<Map.Entry<K,V>>entrySet()<R> MutableList<R>flatCollect(Function<? super V,? extends Iterable<R>> function)flatCollectis a special case ofRichIterable.collect(Function).default <P,R>
MutableList<R>flatCollectWith(Function2<? super V,? super P,? extends Iterable<R>> function, P parameter)MutableSortedSetMultimap<V,K>flip()Given a map from Domain->Range return a multimap from Range->Domain.<P> VgetIfAbsentPutWith(K key, Function<? super P,? extends V> function, P parameter)Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified one argument Function using the specified parameter, and put that value in the map at the specified key.<VV> MutableListMultimap<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> 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.default <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.MutableSortedMap<K,V>headMap(K toKey)MutableSet<K>keySet()The underlying set for the keys is sorted in ascending order according to their natural ordering or a custom comparator.MutableSortedMap<K,V>newEmpty()Creates a new instance of the same type with the same internal Comparator.PartitionMutableList<V>partition(Predicate<? super V> predicate)Filters a collection into a PartitionedIterable based on the evaluation of the predicate.PartitionMutableList<V>partitionWhile(Predicate<? super V> predicate)Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.<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.MutableList<V>reject(Predicate<? super V> predicate)Returns all elements of the source collection that return false when evaluating of the predicate.MutableSortedMap<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> 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.MutableList<V>select(Predicate<? super V> predicate)Returns all elements of the source collection that return true when evaluating the predicate.MutableSortedMap<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> 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.MutableSortedMap<K,V>subMap(K fromKey, K toKey)MutableSortedMap<K,V>tailMap(K fromKey)MutableSortedMap<K,V>take(int count)Returns the firstcountelements of the iterable or all the elements in the iterable ifcountis greater than the length of the iterable.MutableSortedMap<K,V>takeWhile(Predicate<? super V> predicate)Returns the initial elements that satisfy the Predicate.MutableSortedMap<K,V>tap(Procedure<? super V> procedure)Executes the Procedure for each value of the map and returnsthis.MutableSortedMap<K,V>toReversed()Returns a new ReversibleIterable in reverse order.MutableCollection<V>values()default MutableSortedMap<K,V>with(Pair<K,V>... pairs)Deprecated.in 6.0 UsewithAllKeyValueArguments(Pair[])instead.MutableSortedMap<K,V>withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)Convenience var-args version of withAllKeyValuesMutableSortedMap<K,V>withAllKeyValues(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.MutableSortedMap<K,V>withKeyValue(K key, V value)This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.default MutableSortedMap<K,V>withMap(Map<? extends K,? extends V> map)Similar toMap.putAll(Map), but returns this instead of voiddefault MutableSortedMap<K,V>withMapIterable(MapIterable<? extends K,? extends V> mapIterable)MutableSortedMap<K,V>withoutAllKeys(Iterable<? extends K> keys)This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.MutableSortedMap<K,V>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>>zip(Iterable<S> that)Returns aRichIterableformed from thisRichIterableand anotherRichIterableby combining corresponding elements in pairs.MutableList<Pair<V,Integer>>zipWithIndex()Zips thisRichIterablewith its indices.-
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, forEach, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWithKey, getOrDefault, putAllMapIterable, putPair, removeAllKeys, removeIf, removeKey, sumByDouble, sumByFloat, sumByInt, sumByLong, toImmutable, updateValue, updateValueWith
-
Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
collectWithIndex, corresponds, detectIndex, forEach, forEachWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, indexOf, max, min, rejectWithIndex, selectWithIndex, toStack, zip, zipWithIndex
-
Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable
asReversed, detectLastIndex, 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, toImmutable
-
-
-
-
Method Detail
-
newEmpty
MutableSortedMap<K,V> newEmpty()
Creates a new instance of the same type with the same internal Comparator.- Specified by:
newEmptyin interfaceMutableMapIterable<K,V>
-
collectKeysAndValues
<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 fromiterabletothis. The key and value for each entry is determined by applying thekeyFunctionandvalueFunctionto each item incollection. Any entry inmapthat has the same key as an entry inthiswill have it's value replaced by that inmap.
-
getIfAbsentPutWith
<P> V getIfAbsentPutWith(K key, Function<? super P,? extends V> function, P parameter)
Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified one argument Function using the specified parameter, and put that value in the map at the specified key.- Specified by:
getIfAbsentPutWithin interfaceMutableMapIterable<K,V>
-
asUnmodifiable
MutableSortedMap<K,V> asUnmodifiable()
Description copied from interface:MutableMapIterableReturns 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:
asUnmodifiablein interfaceMutableMapIterable<K,V>- Returns:
- an unmodifiable view of this map.
- See Also:
Collections.unmodifiableMap(Map)
-
asSynchronized
MutableSortedMap<K,V> asSynchronized()
Description copied from interface:MutableMapIterableReturns 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:
asSynchronizedin interfaceMutableMapIterable<K,V>- See Also:
Collections.synchronizedMap(Map)
-
flip
MutableSortedSetMultimap<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 interfaceMapIterable<K,V>- Specified by:
flipin interfaceMutableMapIterable<K,V>- Specified by:
flipin interfaceSortedMapIterable<K,V>
-
select
MutableSortedMap<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 interfaceMapIterable<K,V>- Specified by:
selectin interfaceMutableMapIterable<K,V>- Specified by:
selectin interfaceSortedMapIterable<K,V>
-
reject
MutableSortedMap<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 interfaceMapIterable<K,V>- Specified by:
rejectin interfaceMutableMapIterable<K,V>- Specified by:
rejectin interfaceSortedMapIterable<K,V>
-
collect
<K2,V2> MutableMap<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 interfaceMapIterable<K,V>- Specified by:
collectin interfaceMutableMapIterable<K,V>- Specified by:
collectin interfaceSortedMapIterable<K,V>
-
collectValues
<R> MutableSortedMap<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 interfaceMapIterable<K,V>- Specified by:
collectValuesin interfaceMutableMapIterable<K,V>- Specified by:
collectValuesin interfaceSortedMapIterable<K,V>
-
collect
<R> MutableList<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 interfaceOrderedIterable<K>- Specified by:
collectin interfaceReversibleIterable<K>- Specified by:
collectin interfaceRichIterable<K>- Specified by:
collectin interfaceSortedMapIterable<K,V>
-
collectWithIndex
default <R> MutableList<R> collectWithIndex(ObjectIntToObjectFunction<? super V,? extends R> function)
Description copied from interface:OrderedIterableReturns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.- Specified by:
collectWithIndexin interfaceOrderedIterable<K>- Specified by:
collectWithIndexin interfaceReversibleIterable<K>- Specified by:
collectWithIndexin interfaceSortedMapIterable<K,V>- Since:
- 9.1.
-
collectBoolean
MutableBooleanList 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 interfaceOrderedIterable<K>- Specified by:
collectBooleanin interfaceReversibleIterable<K>- Specified by:
collectBooleanin interfaceRichIterable<K>- Specified by:
collectBooleanin interfaceSortedMapIterable<K,V>
-
collectByte
MutableByteList 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 interfaceOrderedIterable<K>- Specified by:
collectBytein interfaceReversibleIterable<K>- Specified by:
collectBytein interfaceRichIterable<K>- Specified by:
collectBytein interfaceSortedMapIterable<K,V>
-
collectChar
MutableCharList 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 interfaceOrderedIterable<K>- Specified by:
collectCharin interfaceReversibleIterable<K>- Specified by:
collectCharin interfaceRichIterable<K>- Specified by:
collectCharin interfaceSortedMapIterable<K,V>
-
collectDouble
MutableDoubleList 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 interfaceOrderedIterable<K>- Specified by:
collectDoublein interfaceReversibleIterable<K>- Specified by:
collectDoublein interfaceRichIterable<K>- Specified by:
collectDoublein interfaceSortedMapIterable<K,V>
-
collectFloat
MutableFloatList 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 interfaceOrderedIterable<K>- Specified by:
collectFloatin interfaceReversibleIterable<K>- Specified by:
collectFloatin interfaceRichIterable<K>- Specified by:
collectFloatin interfaceSortedMapIterable<K,V>
-
collectInt
MutableIntList 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 interfaceOrderedIterable<K>- Specified by:
collectIntin interfaceReversibleIterable<K>- Specified by:
collectIntin interfaceRichIterable<K>- Specified by:
collectIntin interfaceSortedMapIterable<K,V>
-
collectLong
MutableLongList 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 interfaceOrderedIterable<K>- Specified by:
collectLongin interfaceReversibleIterable<K>- Specified by:
collectLongin interfaceRichIterable<K>- Specified by:
collectLongin interfaceSortedMapIterable<K,V>
-
collectShort
MutableShortList 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 interfaceOrderedIterable<K>- Specified by:
collectShortin interfaceReversibleIterable<K>- Specified by:
collectShortin interfaceRichIterable<K>- Specified by:
collectShortin interfaceSortedMapIterable<K,V>
-
collectWith
<P,VV> MutableList<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 interfaceOrderedIterable<K>- Specified by:
collectWithin interfaceReversibleIterable<K>- Specified by:
collectWithin interfaceRichIterable<K>- Specified by:
collectWithin interfaceSortedMapIterable<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)
-
collectIf
<R> MutableList<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 interfaceOrderedIterable<K>- Specified by:
collectIfin interfaceReversibleIterable<K>- Specified by:
collectIfin interfaceRichIterable<K>- Specified by:
collectIfin interfaceSortedMapIterable<K,V>
-
flatCollect
<R> MutableList<R> flatCollect(Function<? super V,? extends 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 interfaceOrderedIterable<K>- Specified by:
flatCollectin interfaceReversibleIterable<K>- Specified by:
flatCollectin interfaceRichIterable<K>- Specified by:
flatCollectin interfaceSortedMapIterable<K,V>- Parameters:
function- TheFunctionto apply- Returns:
- a new flattened collection produced by applying the given
function
-
flatCollectWith
default <P,R> MutableList<R> flatCollectWith(Function2<? super V,? super P,? extends Iterable<R>> function, P parameter)
- Specified by:
flatCollectWithin interfaceOrderedIterable<K>- Specified by:
flatCollectWithin interfaceReversibleIterable<K>- Specified by:
flatCollectWithin interfaceRichIterable<K>- Specified by:
flatCollectWithin interfaceSortedMapIterable<K,V>- Since:
- 9.2
-
tap
MutableSortedMap<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 interfaceMapIterable<K,V>- Specified by:
tapin interfaceMutableMapIterable<K,V>- Specified by:
tapin interfaceOrderedIterable<K>- Specified by:
tapin interfaceReversibleIterable<K>- Specified by:
tapin interfaceRichIterable<K>- Specified by:
tapin interfaceSortedMapIterable<K,V>- See Also:
RichIterable.forEach(Procedure)
-
select
MutableList<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 interfaceMutableMapIterable<K,V>- Specified by:
selectin interfaceOrderedIterable<K>- Specified by:
selectin interfaceReversibleIterable<K>- Specified by:
selectin interfaceRichIterable<K>- Specified by:
selectin interfaceSortedMapIterable<K,V>
-
selectWith
<P> MutableList<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 interfaceMutableMapIterable<K,V>- Specified by:
selectWithin interfaceOrderedIterable<K>- Specified by:
selectWithin interfaceReversibleIterable<K>- Specified by:
selectWithin interfaceRichIterable<K>- Specified by:
selectWithin interfaceSortedMapIterable<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)
-
reject
MutableList<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 interfaceMutableMapIterable<K,V>- Specified by:
rejectin interfaceOrderedIterable<K>- Specified by:
rejectin interfaceReversibleIterable<K>- Specified by:
rejectin interfaceRichIterable<K>- Specified by:
rejectin interfaceSortedMapIterable<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
<P> MutableList<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 interfaceMutableMapIterable<K,V>- Specified by:
rejectWithin interfaceOrderedIterable<K>- Specified by:
rejectWithin interfaceReversibleIterable<K>- Specified by:
rejectWithin interfaceRichIterable<K>- Specified by:
rejectWithin interfaceSortedMapIterable<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
PartitionMutableList<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 interfaceMutableMapIterable<K,V>- Specified by:
partitionin interfaceOrderedIterable<K>- Specified by:
partitionin interfaceReversibleIterable<K>- Specified by:
partitionin interfaceRichIterable<K>- Specified by:
partitionin interfaceSortedMapIterable<K,V>
-
partitionWith
<P> PartitionMutableList<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 interfaceOrderedIterable<K>- Specified by:
partitionWithin interfaceReversibleIterable<K>- Specified by:
partitionWithin interfaceRichIterable<K>- Specified by:
partitionWithin interfaceSortedMapIterable<K,V>
-
selectInstancesOf
<S> MutableList<S> selectInstancesOf(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 interfaceMutableMapIterable<K,V>- Specified by:
selectInstancesOfin interfaceOrderedIterable<K>- Specified by:
selectInstancesOfin interfaceReversibleIterable<K>- Specified by:
selectInstancesOfin interfaceRichIterable<K>- Specified by:
selectInstancesOfin interfaceSortedMapIterable<K,V>
-
zip
<S> MutableList<Pair<V,S>> zip(Iterable<S> that)
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 interfaceMutableMapIterable<K,V>- Specified by:
zipin interfaceOrderedIterable<K>- Specified by:
zipin interfaceReversibleIterable<K>- Specified by:
zipin interfaceRichIterable<K>- Specified by:
zipin interfaceSortedMapIterable<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
MutableList<Pair<V,Integer>> zipWithIndex()
Description copied from interface:RichIterableZips thisRichIterablewith its indices.- Specified by:
zipWithIndexin interfaceMutableMapIterable<K,V>- Specified by:
zipWithIndexin interfaceOrderedIterable<K>- Specified by:
zipWithIndexin interfaceReversibleIterable<K>- Specified by:
zipWithIndexin interfaceRichIterable<K>- Specified by:
zipWithIndexin interfaceSortedMapIterable<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)
-
toReversed
MutableSortedMap<K,V> toReversed()
Description copied from interface:ReversibleIterableReturns a new ReversibleIterable in reverse order.- Specified by:
toReversedin interfaceReversibleIterable<K>- Specified by:
toReversedin interfaceSortedMapIterable<K,V>
-
take
MutableSortedMap<K,V> take(int count)
Description copied from interface:ReversibleIterableReturns the firstcountelements of the iterable or all the elements in the iterable ifcountis greater than the length of the iterable.- Specified by:
takein interfaceReversibleIterable<K>- Specified by:
takein interfaceSortedMapIterable<K,V>- Parameters:
count- the number of items to take.
-
takeWhile
MutableSortedMap<K,V> takeWhile(Predicate<? super V> predicate)
Description copied from interface:ReversibleIterableReturns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.- Specified by:
takeWhilein interfaceOrderedIterable<K>- Specified by:
takeWhilein interfaceReversibleIterable<K>- Specified by:
takeWhilein interfaceSortedMapIterable<K,V>
-
drop
MutableSortedMap<K,V> drop(int count)
Description copied from interface:ReversibleIterableReturns an iterable after skipping the firstcountelements or an empty iterable if thecountis greater than the length of the iterable.- Specified by:
dropin interfaceReversibleIterable<K>- Specified by:
dropin interfaceSortedMapIterable<K,V>- Parameters:
count- the number of items to drop.
-
dropWhile
MutableSortedMap<K,V> dropWhile(Predicate<? super V> predicate)
Description copied from interface:ReversibleIterableReturns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.- Specified by:
dropWhilein interfaceOrderedIterable<K>- Specified by:
dropWhilein interfaceReversibleIterable<K>- Specified by:
dropWhilein interfaceSortedMapIterable<K,V>
-
partitionWhile
PartitionMutableList<V> partitionWhile(Predicate<? super V> predicate)
Description copied from interface:OrderedIterableReturns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.- Specified by:
partitionWhilein interfaceOrderedIterable<K>- Specified by:
partitionWhilein interfaceReversibleIterable<K>- Specified by:
partitionWhilein interfaceSortedMapIterable<K,V>
-
distinct
MutableList<V> distinct()
Description copied from interface:OrderedIterableReturns a newOrderedIterablecontaining the distinct elements in this iterable.Conceptually similar to
RichIterable.toSet().RichIterable.toList()but retains the original order. If an element appears multiple times in this iterable, the first one will be copied into the result.- Specified by:
distinctin interfaceOrderedIterable<K>- Specified by:
distinctin interfaceReversibleIterable<K>- Specified by:
distinctin interfaceSortedMapIterable<K,V>- Returns:
OrderedIterableof distinct elements
-
entrySet
MutableSet<Map.Entry<K,V>> entrySet()
-
keySet
MutableSet<K> keySet()
The underlying set for the keys is sorted in ascending order according to their natural ordering or a custom comparator. However, Java 5 TreeMap returns a keySet that does not inherit from SortedSet therefore we have decided to return the keySet simply as a MutableSet to maintain Java 5 compatibility.
-
tailMap
MutableSortedMap<K,V> tailMap(K fromKey)
-
subMap
MutableSortedMap<K,V> subMap(K fromKey, K toKey)
-
values
MutableCollection<V> values()
-
clone
MutableSortedMap<K,V> clone()
-
groupBy
<VV> MutableListMultimap<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 interfaceMutableMapIterable<K,V>- Specified by:
groupByin interfaceOrderedIterable<K>- Specified by:
groupByin interfaceReversibleIterable<K>- Specified by:
groupByin interfaceRichIterable<K>- Specified by:
groupByin interfaceSortedMapIterable<K,V>
-
groupByEach
<VV> MutableListMultimap<VV,V> groupByEach(Function<? super V,? extends 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 interfaceMutableMapIterable<K,V>- Specified by:
groupByEachin interfaceOrderedIterable<K>- Specified by:
groupByEachin interfaceReversibleIterable<K>- Specified by:
groupByEachin interfaceRichIterable<K>- Specified by:
groupByEachin interfaceSortedMapIterable<K,V>
-
groupByUniqueKey
default <VV> MutableMap<VV,V> groupByUniqueKey(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 map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.- Specified by:
groupByUniqueKeyin interfaceMutableMapIterable<K,V>- Specified by:
groupByUniqueKeyin interfaceRichIterable<K>- See Also:
RichIterable.groupBy(Function)
-
withKeyValue
MutableSortedMap<K,V> withKeyValue(K key, V value)
Description copied from interface:MutableMapIterableThis 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:
withKeyValuein interfaceMutableMapIterable<K,V>- See Also:
Map.put(Object, Object)
-
withMap
default MutableSortedMap<K,V> withMap(Map<? extends K,? extends V> map)
Description copied from interface:MutableMapIterableSimilar toMap.putAll(Map), but returns this instead of void- Specified by:
withMapin interfaceMutableMapIterable<K,V>- See Also:
Map.putAll(Map)
-
withMapIterable
default MutableSortedMap<K,V> withMapIterable(MapIterable<? extends K,? extends V> mapIterable)
- Specified by:
withMapIterablein interfaceMutableMapIterable<K,V>
-
withAllKeyValues
MutableSortedMap<K,V> withAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
Description copied from interface:MutableMapIterableThis 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:
withAllKeyValuesin interfaceMutableMapIterable<K,V>- See Also:
Map.put(Object, Object)
-
withAllKeyValueArguments
MutableSortedMap<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
Description copied from interface:MutableMapIterableConvenience var-args version of withAllKeyValues- Specified by:
withAllKeyValueArgumentsin interfaceMutableMapIterable<K,V>- See Also:
MutableMapIterable.withAllKeyValues(Iterable)
-
with
@Deprecated default MutableSortedMap<K,V> with(Pair<K,V>... pairs)
Deprecated.in 6.0 UsewithAllKeyValueArguments(Pair[])instead. Inlineable.
-
withoutKey
MutableSortedMap<K,V> withoutKey(K key)
Description copied from interface:MutableMapIterableThis 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:
withoutKeyin interfaceMutableMapIterable<K,V>- See Also:
Map.remove(Object)
-
withoutAllKeys
MutableSortedMap<K,V> withoutAllKeys(Iterable<? extends K> keys)
Description copied from interface:MutableMapIterableThis 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:
withoutAllKeysin interfaceMutableMapIterable<K,V>- See Also:
Map.remove(Object)
-
-