Package org.eclipse.collections.impl.map.sorted.mutable

Class SynchronizedSortedMap<K,V>

java.lang.Object

org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable<V>

org.eclipse.collections.impl.map.AbstractSynchronizedMapIterable<K,V>

org.eclipse.collections.impl.map.sorted.mutable.SynchronizedSortedMap<K,V>

All Implemented Interfaces:

Serializable, 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>

public class SynchronizedSortedMap<K,V>
extends AbstractSynchronizedMapIterable<K,V>
implements MutableSortedMap<K,V>, Serializable

A synchronized view of a SortedMap.

See Also:

• SynchronizedSortedMap(MutableSortedMap)
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
SynchronizedSortedMap(MutableSortedMap<K,V> newMap)
SynchronizedSortedMap(MutableSortedMap<K,V> newMap, Object lock)

Method Summary

Modifier and Type	Method	Description
LazyIterable<V>	asReversed()	Returns a reversed view of this ReversibleIterable.
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.
MutableBooleanList	collectBoolean(BooleanFunction<? super V> booleanFunction)	Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
MutableByteList	collectByte(ByteFunction<? super V> byteFunction)	Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
MutableCharList	collectChar(CharFunction<? super V> charFunction)	Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
MutableDoubleList	collectDouble(DoubleFunction<? super V> doubleFunction)	Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
MutableFloatList	collectFloat(FloatFunction<? super V> floatFunction)	Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<R> 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.
MutableIntList	collectInt(IntFunction<? super V> intFunction)	Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
<E> MutableSortedMap<K,V>	collectKeysAndValues(Iterable<E> iterable, Function<? super E,? extends K> keyFunction, Function<? super E,? extends V> function)	Adds all the entries derived from iterable to this.
MutableLongList	collectLong(LongFunction<? super V> longFunction)	Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
MutableShortList	collectShort(ShortFunction<? super V> shortFunction)	Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<R> 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 as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
<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.
<V1, R extends Collection<V1>> R	collectWithIndex(ObjectIntToObjectFunction<? super V,? extends V1> function, R target)	Adds elements to the target Collection using results obtained by applying the specified function to each element and its corresponding index.
Comparator<? super K>	comparator()
<S> boolean	corresponds(OrderedIterable<S> other, Predicate2<? super V,? super S> predicate)	Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other.
int	detectIndex(Predicate<? super V> predicate)	Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true.
int	detectLastIndex(Predicate<? super V> predicate)	Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true.
MutableList<V>	distinct()	Returns a new OrderedIterable containing the distinct elements in this iterable.
MutableSortedMap<K,V>	drop(int count)	Returns an iterable after skipping the first count elements or an empty iterable if the count is 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()
K	firstKey()
<R> MutableList<R>	flatCollect(Function<? super V,? extends Iterable<R>> function)	flatCollect is a special case of RichIterable.collect(Function).
MutableSortedSetMultimap<V,K>	flip()	Given a map from Domain -> Range return a multimap from Range -> Domain.
MutableMapIterable<V,K>	flipUniqueValues()	Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEach(int startIndex, int endIndex, Procedure<? super V> procedure)	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.
Optional<V>	getFirstOptional()	Returns the first element of an iterable as an Optional.
Optional<V>	getLastOptional()	Returns the last element of an iterable as an Optional.
<KK> MutableListMultimap<KK,V>	groupBy(Function<? super V,? extends KK> 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.
<KK> MutableListMultimap<KK,V>	groupByEach(Function<? super V,? extends Iterable<KK>> function)	Similar to RichIterable.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 he results of these evaluations are collected into a new map, where the transformed value is the key.
MutableSortedMap<K,V>	headMap(K toKey)
int	indexOf(Object object)	Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
MutableSet<K>	keySet()	The underlying set for the keys is sorted in ascending order according to their natural ordering or a custom comparator.
RichIterable<K>	keysView()	Returns an unmodifiable lazy iterable wrapped around the keySet for the map.
K	lastKey()
MutableSortedMap<K,V>	newEmpty()	Creates a new instance of the same type with the same internal Comparator.
static <K, V, M extends SortedMap<K, V>> SynchronizedSortedMap<K,V>	of(M map)	This method will take a MutableSortedMap and wrap it directly in a SynchronizedSortedMap.
static <K, V, M extends SortedMap<K, V>> SynchronizedSortedMap<K,V>	of(M map, Object lock)
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.
void	putAllMapIterable(MapIterable<? extends K,? extends V> mapIterable)
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 to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
<R extends Collection<V>> R	rejectWithIndex(ObjectIntPredicate<? super V> predicate, R target)	Adds all elements to the target Collection that return false when evaluating the specified predicate which is supplied each element and its relative index.
void	reverseForEach(Procedure<? super V> procedure)	Evaluates the procedure for each element of the list iterating in reverse order.
void	reverseForEachWithIndex(ObjectIntProcedure<? super V> procedure)	Evaluates the procedure for each element and it's index in reverse order.
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 Class clazz.
<P> MutableList<V>	selectWith(Predicate2<? super V,? super P> predicate, P parameter)	Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
<R extends Collection<V>> R	selectWithIndex(ObjectIntPredicate<? super V> predicate, R target)	Adds all elements to the target Collection that return true when evaluating the specified predicate which is supplied each element and its relative index.
MutableSortedMap<K,V>	subMap(K fromKey, K toKey)
MutableSortedMap<K,V>	tailMap(K fromKey)
MutableSortedMap<K,V>	take(int count)	Returns the first count elements of the iterable or all the elements in the iterable if count is 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 element in the iterable and returns this.
ImmutableSortedMap<K,V>	toImmutable()	Returns an immutable copy of this map.
MutableSortedMap<K,V>	toReversed()	Returns a new ReversibleIterable in reverse order.
MutableStack<V>	toStack()	Converts the OrderedIterable to a mutable MutableStack implementation.
MutableCollection<V>	values()
RichIterable<V>	valuesView()	Returns an unmodifiable lazy iterable wrapped around the values for the map.
MutableSortedMap<K,V>	with(Pair<K,V>... pairs)	Deprecated. in 6.0 Use withAllKeyValueArguments(Pair[]) instead.
MutableSortedMap<K,V>	withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)	Convenience var-args version of withAllKeyValues
MutableSortedMap<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.
MutableSortedMap<K,V>	withMap(Map<? extends K,? extends V> map)	Similar to Map.putAll(Map), but returns this instead of void
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 a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
MutableList<Pair<V,Integer>>	zipWithIndex()	Zips this RichIterable with its indices.

Methods inherited from class org.eclipse.collections.impl.map.AbstractSynchronizedMapIterable

add, aggregateBy, aggregateBy, aggregateInPlaceBy, clear, containsKey, containsValue, countBy, countByEach, countByWith, detect, detectOptional, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, getIfAbsentValue, getIfAbsentWith, ifPresentApply, keyValuesView, put, putAll, putPair, remove, removeAllKeys, removeIf, removeKey, sumByDouble, sumByFloat, sumByInt, sumByLong, updateValue, updateValueWith

Methods inherited from class org.eclipse.collections.impl.collection.AbstractSynchronizedRichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, equals, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, forEachWith, forEachWithIndex, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, hashCode, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, iterator, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableList, 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, toString, zip, zipWithIndex

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach, forEachWith

Methods inherited from interface java.lang.Iterable

iterator

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, keyValuesView, parallelStream, spliterator, stream, toString

Methods inherited from interface org.eclipse.collections.api.map.MutableMapIterable

add, aggregateBy, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWithKey, getOrDefault, putPair, removeAllKeys, removeIf, removeKey, sumByDouble, sumByFloat, sumByInt, sumByLong, updateValue, updateValueWith

Methods inherited from interface org.eclipse.collections.api.map.sorted.MutableSortedMap

flatCollectWith, getIfAbsentPutWith

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

forEachWithIndex, getFirst, getLast, max, min, zip, zipWithIndex

Methods inherited from interface org.eclipse.collections.api.RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsBy, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, 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

Constructor Details

SynchronizedSortedMap

public SynchronizedSortedMap(MutableSortedMap<K,V> newMap)

SynchronizedSortedMap

public SynchronizedSortedMap(MutableSortedMap<K,V> newMap,
 Object lock)

Method Details

of

public static <K,
V,
M extends SortedMap<K,
V>>
SynchronizedSortedMap<K,V> of(M map)

This method will take a MutableSortedMap and wrap it directly in a SynchronizedSortedMap. It will take any other non-Eclipse-Collections SortedMap and first adapt it will a SortedMapAdapter, and then return a SynchronizedSortedMap that wraps the adapter.

of

public static <K,
V,
M extends SortedMap<K,
V>>
SynchronizedSortedMap<K,V> of(M map,
 Object lock)

comparator

public Comparator<? super K> comparator()

Specified by:

comparator in interface SortedMap<K,V>

Specified by:

comparator in interface SortedMapIterable<K,V>

withKeyValue

public MutableSortedMap<K,V> withKeyValue(K key,
 V value)

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 interface MutableMapIterable<K,V>

Specified by:

withKeyValue in interface MutableSortedMap<K,V>

See Also:

• Map.put(Object, Object)

withMap

public MutableSortedMap<K,V> withMap(Map<? extends K,? extends V> map)

Description copied from interface: MutableMapIterable

Similar to Map.putAll(Map), but returns this instead of void

Specified by:

withMap in interface MutableMapIterable<K,V>

Specified by:

withMap in interface MutableSortedMap<K,V>

See Also:

• Map.putAll(Map)

withMapIterable

public MutableSortedMap<K,V> withMapIterable(MapIterable<? extends K,? extends V> mapIterable)

Specified by:

withMapIterable in interface MutableMapIterable<K,V>

Specified by:

withMapIterable in interface MutableSortedMap<K,V>

putAllMapIterable

public void putAllMapIterable(MapIterable<? extends K,? extends V> mapIterable)

Specified by:

putAllMapIterable in interface MutableMapIterable<K,V>

with

@Deprecated
public MutableSortedMap<K,V> with(Pair<K,V>... pairs)

Deprecated.

in 6.0 Use withAllKeyValueArguments(Pair[]) instead. Inlineable.

Specified by:

with in interface MutableSortedMap<K,V>

withAllKeyValueArguments

public MutableSortedMap<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)

Description copied from interface: MutableMapIterable

Convenience var-args version of withAllKeyValues

Specified by:

withAllKeyValueArguments in interface MutableMapIterable<K,V>

Specified by:

withAllKeyValueArguments in interface MutableSortedMap<K,V>

See Also:

• MutableMapIterable.withAllKeyValues(Iterable)

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 of 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 interface MutableMapIterable<K,V>

Specified by:

withAllKeyValues in interface MutableSortedMap<K,V>

See Also:

• Map.put(Object, Object)

withoutKey

public MutableSortedMap<K,V> withoutKey(K key)

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 interface MutableMapIterable<K,V>

Specified by:

withoutKey in interface MutableSortedMap<K,V>

See Also:

• Map.remove(Object)

withoutAllKeys

public MutableSortedMap<K,V> withoutAllKeys(Iterable<? extends K> keys)

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 of 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 interface MutableMapIterable<K,V>

Specified by:

withoutAllKeys in interface MutableSortedMap<K,V>

See Also:

• Map.remove(Object)

newEmpty

public MutableSortedMap<K,V> newEmpty()

Description copied from interface: MutableSortedMap

Creates a new instance of the same type with the same internal Comparator.

Specified by:

newEmpty in interface MutableMapIterable<K,V>

Specified by:

newEmpty in interface MutableSortedMap<K,V>

clone

public MutableSortedMap<K,V> clone()

Specified by:

clone in interface MutableSortedMap<K,V>

collectKeysAndValues

public <E> MutableSortedMap<K,V> collectKeysAndValues(Iterable<E> iterable,
 Function<? super E,? extends K> keyFunction,
 Function<? super E,? extends V> function)

Description copied from interface: MutableSortedMap

Adds all the entries derived from iterable to this. The key and value for each entry is determined by applying the keyFunction and valueFunction to each item in collection. Any entry in map that has the same key as an entry in this will have it's value replaced by that in map.

Specified by:

collectKeysAndValues in interface MutableSortedMap<K,V>

firstKey

public K firstKey()

Specified by:

firstKey in interface SortedMap<K,V>

lastKey

public K lastKey()

Specified by:

lastKey in interface SortedMap<K,V>

tap

public MutableSortedMap<K,V> tap(Procedure<? super V> procedure)

Description copied from interface: RichIterable

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

 RichIterable<Person> tapped =
     people.tap(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

 RichIterable<Person> tapped =
     people.tap(new Procedure<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
 

Specified by:

tap in interface MapIterable<K,V>

Specified by:

tap in interface MutableMapIterable<K,V>

Specified by:

tap in interface MutableSortedMap<K,V>

Specified by:

tap in interface OrderedIterable<K>

Specified by:

tap in interface ReversibleIterable<K>

Specified by:

tap in interface RichIterable<K>

Specified by:

tap in interface SortedMapIterable<K,V>

Overrides:

tap in class AbstractSynchronizedMapIterable<K,V>

See Also:

• RichIterable.each(Procedure)
• RichIterable.forEach(Procedure)

select

public MutableList<V> select(Predicate<? super V> predicate)

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 interface MutableMapIterable<K,V>

Specified by:

select in interface MutableSortedMap<K,V>

Specified by:

select in interface OrderedIterable<K>

Specified by:

select in interface ReversibleIterable<K>

Specified by:

select in interface RichIterable<K>

Specified by:

select in interface SortedMapIterable<K,V>

Overrides:

select in class AbstractSynchronizedMapIterable<K,V>

selectWith

public <P> MutableList<V> selectWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge()>= age;
         }
     }, Integer.valueOf(18));
 

Specified by:

selectWith in interface MutableMapIterable<K,V>

Specified by:

selectWith in interface MutableSortedMap<K,V>

Specified by:

selectWith in interface OrderedIterable<K>

Specified by:

selectWith in interface ReversibleIterable<K>

Specified by:

selectWith in interface RichIterable<K>

Specified by:

selectWith in interface SortedMapIterable<K,V>

Overrides:

selectWith in class AbstractSynchronizedMapIterable<K,V>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

• RichIterable.select(Predicate)

reject

public MutableList<V> reject(Predicate<? super V> predicate)

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 interface MutableMapIterable<K,V>

Specified by:

reject in interface MutableSortedMap<K,V>

Specified by:

reject in interface OrderedIterable<K>

Specified by:

reject in interface ReversibleIterable<K>

Specified by:

reject in interface RichIterable<K>

Specified by:

reject in interface SortedMapIterable<K,V>

Overrides:

reject in class AbstractSynchronizedMapIterable<K,V>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

rejectWith

public <P> MutableList<V> rejectWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

 RichIterable<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 

Specified by:

rejectWith in interface MutableMapIterable<K,V>

Specified by:

rejectWith in interface MutableSortedMap<K,V>

Specified by:

rejectWith in interface OrderedIterable<K>

Specified by:

rejectWith in interface ReversibleIterable<K>

Specified by:

rejectWith in interface RichIterable<K>

Specified by:

rejectWith in interface SortedMapIterable<K,V>

Overrides:

rejectWith in class AbstractSynchronizedMapIterable<K,V>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

• RichIterable.select(Predicate)

partition

public PartitionMutableList<V> partition(Predicate<? super V> predicate)

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 interface MutableMapIterable<K,V>

Specified by:

partition in interface MutableSortedMap<K,V>

Specified by:

partition in interface OrderedIterable<K>

Specified by:

partition in interface ReversibleIterable<K>

Specified by:

partition in interface RichIterable<K>

Specified by:

partition in interface SortedMapIterable<K,V>

Overrides:

partition in class AbstractSynchronizedMapIterable<K,V>

zipWithIndex

public MutableList<Pair<V,Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface MutableMapIterable<K,V>

Specified by:

zipWithIndex in interface MutableSortedMap<K,V>

Specified by:

zipWithIndex in interface OrderedIterable<K>

Specified by:

zipWithIndex in interface ReversibleIterable<K>

Specified by:

zipWithIndex in interface RichIterable<K>

Specified by:

zipWithIndex in interface SortedMapIterable<K,V>

Overrides:

zipWithIndex in class AbstractSynchronizedMapIterable<K,V>

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

• RichIterable.zip(Iterable)

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 interface MutableSortedMap<K,V>

Specified by:

partitionWith in interface OrderedIterable<K>

Specified by:

partitionWith in interface ReversibleIterable<K>

Specified by:

partitionWith in interface RichIterable<K>

Specified by:

partitionWith in interface SortedMapIterable<K,V>

Overrides:

partitionWith in class AbstractSynchronizedRichIterable<V>

selectInstancesOf

public <S> MutableList<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: RichIterable

Returns all elements of the source collection that are instances of the Class clazz.

 RichIterable<Integer> integers =
     List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);
 

Specified by:

selectInstancesOf in interface MutableMapIterable<K,V>

Specified by:

selectInstancesOf in interface MutableSortedMap<K,V>

Specified by:

selectInstancesOf in interface OrderedIterable<K>

Specified by:

selectInstancesOf in interface ReversibleIterable<K>

Specified by:

selectInstancesOf in interface RichIterable<K>

Specified by:

selectInstancesOf in interface SortedMapIterable<K,V>

Overrides:

selectInstancesOf in class AbstractSynchronizedMapIterable<K,V>

collect

public <R> MutableList<R> collect(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. 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 interface MutableSortedMap<K,V>

Specified by:

collect in interface OrderedIterable<K>

Specified by:

collect in interface ReversibleIterable<K>

Specified by:

collect in interface RichIterable<K>

Specified by:

collect in interface SortedMapIterable<K,V>

Overrides:

collect in class AbstractSynchronizedRichIterable<V>

collectWithIndex

public <R> MutableList<R> collectWithIndex(ObjectIntToObjectFunction<? super V,? extends R> function)

Description copied from interface: OrderedIterable

Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.

Specified by:

collectWithIndex in interface MutableSortedMap<K,V>

Specified by:

collectWithIndex in interface OrderedIterable<K>

Specified by:

collectWithIndex in interface ReversibleIterable<K>

Specified by:

collectWithIndex in interface SortedMapIterable<K,V>

Since:

9.1

collectWithIndex

public <V1,
R extends Collection<V1>> R collectWithIndex(ObjectIntToObjectFunction<? super V,? extends V1> function,
 R target)

Description copied from interface: OrderedIterable

Adds elements to the target Collection using results obtained by applying the specified function to each element and its corresponding index.

Specified by:

collectWithIndex in interface OrderedIterable<K>

Since:

9.1

selectWithIndex

public <R extends Collection<V>> R selectWithIndex(ObjectIntPredicate<? super V> predicate,
 R target)

Description copied from interface: OrderedIterable

Adds all elements to the target Collection that return true when evaluating the specified predicate which is supplied each element and its relative index.

Specified by:

selectWithIndex in interface OrderedIterable<K>

Since:

11.0

rejectWithIndex

public <R extends Collection<V>> R rejectWithIndex(ObjectIntPredicate<? super V> predicate,
 R target)

Description copied from interface: OrderedIterable

Adds all elements to the target Collection that return false when evaluating the specified predicate which is supplied each element and its relative index.

Specified by:

rejectWithIndex in interface OrderedIterable<K>

Since:

11.0

collectBoolean

public MutableBooleanList collectBoolean(BooleanFunction<? super V> booleanFunction)

Description copied from interface: RichIterable

Returns a new primitive boolean 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 interface MutableSortedMap<K,V>

Specified by:

collectBoolean in interface OrderedIterable<K>

Specified by:

collectBoolean in interface ReversibleIterable<K>

Specified by:

collectBoolean in interface RichIterable<K>

Specified by:

collectBoolean in interface SortedMapIterable<K,V>

Overrides:

collectBoolean in class AbstractSynchronizedRichIterable<V>

collectByte

public MutableByteList collectByte(ByteFunction<? super V> byteFunction)

Description copied from interface: RichIterable

Returns a new primitive byte 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 interface MutableSortedMap<K,V>

Specified by:

collectByte in interface OrderedIterable<K>

Specified by:

collectByte in interface ReversibleIterable<K>

Specified by:

collectByte in interface RichIterable<K>

Specified by:

collectByte in interface SortedMapIterable<K,V>

Overrides:

collectByte in class AbstractSynchronizedRichIterable<V>

collectChar

public MutableCharList collectChar(CharFunction<? super V> charFunction)

Description copied from interface: RichIterable

Returns a new primitive char 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 interface MutableSortedMap<K,V>

Specified by:

collectChar in interface OrderedIterable<K>

Specified by:

collectChar in interface ReversibleIterable<K>

Specified by:

collectChar in interface RichIterable<K>

Specified by:

collectChar in interface SortedMapIterable<K,V>

Overrides:

collectChar in class AbstractSynchronizedRichIterable<V>

collectDouble

public MutableDoubleList collectDouble(DoubleFunction<? super V> doubleFunction)

Description copied from interface: RichIterable

Returns a new primitive double 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 interface MutableSortedMap<K,V>

Specified by:

collectDouble in interface OrderedIterable<K>

Specified by:

collectDouble in interface ReversibleIterable<K>

Specified by:

collectDouble in interface RichIterable<K>

Specified by:

collectDouble in interface SortedMapIterable<K,V>

Overrides:

collectDouble in class AbstractSynchronizedRichIterable<V>

collectFloat

public MutableFloatList collectFloat(FloatFunction<? super V> floatFunction)

Description copied from interface: RichIterable

Returns a new primitive float 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 interface MutableSortedMap<K,V>

Specified by:

collectFloat in interface OrderedIterable<K>

Specified by:

collectFloat in interface ReversibleIterable<K>

Specified by:

collectFloat in interface RichIterable<K>

Specified by:

collectFloat in interface SortedMapIterable<K,V>

Overrides:

collectFloat in class AbstractSynchronizedRichIterable<V>

collectInt

public MutableIntList collectInt(IntFunction<? super V> intFunction)

Description copied from interface: RichIterable

Returns a new primitive int 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 interface MutableSortedMap<K,V>

Specified by:

collectInt in interface OrderedIterable<K>

Specified by:

collectInt in interface ReversibleIterable<K>

Specified by:

collectInt in interface RichIterable<K>

Specified by:

collectInt in interface SortedMapIterable<K,V>

Overrides:

collectInt in class AbstractSynchronizedRichIterable<V>

collectLong

public MutableLongList collectLong(LongFunction<? super V> longFunction)

Description copied from interface: RichIterable

Returns a new primitive long 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 interface MutableSortedMap<K,V>

Specified by:

collectLong in interface OrderedIterable<K>

Specified by:

collectLong in interface ReversibleIterable<K>

Specified by:

collectLong in interface RichIterable<K>

Specified by:

collectLong in interface SortedMapIterable<K,V>

Overrides:

collectLong in class AbstractSynchronizedRichIterable<V>

collectShort

public MutableShortList collectShort(ShortFunction<? super V> shortFunction)

Description copied from interface: RichIterable

Returns a new primitive short 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 interface MutableSortedMap<K,V>

Specified by:

collectShort in interface OrderedIterable<K>

Specified by:

collectShort in interface ReversibleIterable<K>

Specified by:

collectShort in interface RichIterable<K>

Specified by:

collectShort in interface SortedMapIterable<K,V>

Overrides:

collectShort in class AbstractSynchronizedRichIterable<V>

collectWith

public <P,
VV> MutableList<VV> collectWith(Function2<? super V,? super P,? extends VV> function,
 P parameter)

Description copied from interface: RichIterable

Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
 

Example using an anonymous inner class:

 Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(Integer each, Integer parameter)
         {
             return each + parameter;
         }
     };
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 

Specified by:

collectWith in interface MutableSortedMap<K,V>

Specified by:

collectWith in interface OrderedIterable<K>

Specified by:

collectWith in interface ReversibleIterable<K>

Specified by:

collectWith in interface RichIterable<K>

Specified by:

collectWith in interface SortedMapIterable<K,V>

Overrides:

collectWith in class AbstractSynchronizedRichIterable<V>

Parameters:

function - A Function2 to use as the collect transformation function

parameter - A parameter to pass in for evaluation of the second argument P in function

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

• RichIterable.collect(Function)

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 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 interface MutableSortedMap<K,V>

Specified by:

collectIf in interface OrderedIterable<K>

Specified by:

collectIf in interface ReversibleIterable<K>

Specified by:

collectIf in interface RichIterable<K>

Specified by:

collectIf in interface SortedMapIterable<K,V>

Overrides:

collectIf in class AbstractSynchronizedRichIterable<V>

flatCollect

public <R> MutableList<R> flatCollect(Function<? super V,? extends Iterable<R>> function)

Description copied from interface: RichIterable

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

 Function<Person, List<Address>> addressFunction = Person::getAddresses;
 RichIterable<Person> people = ...;
 

Using collect returns a collection of collections of addresses.

 RichIterable<List<Address>> addresses = people.collect(addressFunction);
 

Using flatCollect returns a single flattened list of addresses.

 RichIterable<Address> addresses = people.flatCollect(addressFunction);
 

Specified by:

flatCollect in interface MutableSortedMap<K,V>

Specified by:

flatCollect in interface OrderedIterable<K>

Specified by:

flatCollect in interface ReversibleIterable<K>

Specified by:

flatCollect in interface RichIterable<K>

Specified by:

flatCollect in interface SortedMapIterable<K,V>

Overrides:

flatCollect in class AbstractSynchronizedRichIterable<V>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

groupBy

public <KK> MutableListMultimap<KK,V> groupBy(Function<? super V,? extends KK> function)

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 interface MutableMapIterable<K,V>

Specified by:

groupBy in interface MutableSortedMap<K,V>

Specified by:

groupBy in interface OrderedIterable<K>

Specified by:

groupBy in interface ReversibleIterable<K>

Specified by:

groupBy in interface RichIterable<K>

Specified by:

groupBy in interface SortedMapIterable<K,V>

Overrides:

groupBy in class AbstractSynchronizedMapIterable<K,V>

groupByEach

public <KK> MutableListMultimap<KK,V> groupByEach(Function<? super V,? extends Iterable<KK>> function)

Description copied from interface: RichIterable

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface MutableMapIterable<K,V>

Specified by:

groupByEach in interface MutableSortedMap<K,V>

Specified by:

groupByEach in interface OrderedIterable<K>

Specified by:

groupByEach in interface ReversibleIterable<K>

Specified by:

groupByEach in interface RichIterable<K>

Specified by:

groupByEach in interface SortedMapIterable<K,V>

Overrides:

groupByEach in class AbstractSynchronizedMapIterable<K,V>

zip

public <S> MutableList<Pair<V,S>> zip(Iterable<S> that)

Description copied from interface: RichIterable

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface MutableMapIterable<K,V>

Specified by:

zip in interface MutableSortedMap<K,V>

Specified by:

zip in interface OrderedIterable<K>

Specified by:

zip in interface ReversibleIterable<K>

Specified by:

zip in interface RichIterable<K>

Specified by:

zip in interface SortedMapIterable<K,V>

Overrides:

zip in class AbstractSynchronizedMapIterable<K,V>

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

groupByUniqueKey

public <VV> MutableMap<VV,V> groupByUniqueKey(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface MutableMapIterable<K,V>

Specified by:

groupByUniqueKey in interface MutableSortedMap<K,V>

Specified by:

groupByUniqueKey in interface RichIterable<K>

Overrides:

groupByUniqueKey in class AbstractSynchronizedMapIterable<K,V>

See Also:

• RichIterable.groupBy(Function)

flipUniqueValues

public MutableMapIterable<V,K> flipUniqueValues()

Description copied from interface: MapIterable

Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.

     MapIterable<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     MapIterable<String, Integer> result = map.flipUniqueValues();
     Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
 

Specified by:

flipUniqueValues in interface MapIterable<K,V>

Specified by:

flipUniqueValues in interface MutableMapIterable<K,V>

flip

public MutableSortedSetMultimap<V,K> 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 interface MapIterable<K,V>

Specified by:

flip in interface MutableMapIterable<K,V>

Specified by:

flip in interface MutableSortedMap<K,V>

Specified by:

flip in interface SortedMapIterable<K,V>

select

public MutableSortedMap<K,V> select(Predicate2<? super K,? super V> predicate)

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 interface MapIterable<K,V>

Specified by:

select in interface MutableMapIterable<K,V>

Specified by:

select in interface MutableSortedMap<K,V>

Specified by:

select in interface SortedMapIterable<K,V>

reject

public MutableSortedMap<K,V> reject(Predicate2<? super K,? super V> predicate)

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 interface MapIterable<K,V>

Specified by:

reject in interface MutableMapIterable<K,V>

Specified by:

reject in interface MutableSortedMap<K,V>

Specified by:

reject in interface SortedMapIterable<K,V>

collect

public <K2,
V2> MutableMap<K2,V2> collect(Function2<? super K,? super V,Pair<K2,V2>> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

 MapIterable<String, String> collected =
     peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));
 

Specified by:

collect in interface MapIterable<K,V>

Specified by:

collect in interface MutableMapIterable<K,V>

Specified by:

collect in interface MutableSortedMap<K,V>

Specified by:

collect in interface SortedMapIterable<K,V>

collectValues

public <R> MutableSortedMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

 MapIterable<City, String> collected =
     peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());
 

Specified by:

collectValues in interface MapIterable<K,V>

Specified by:

collectValues in interface MutableMapIterable<K,V>

Specified by:

collectValues in interface MutableSortedMap<K,V>

Specified by:

collectValues in interface SortedMapIterable<K,V>

keysView

public RichIterable<K> keysView()

Description copied from interface: MapIterable

Returns an unmodifiable lazy iterable wrapped around the keySet for the map.

Specified by:

keysView in interface MapIterable<K,V>

valuesView

public RichIterable<V> valuesView()

Description copied from interface: MapIterable

Returns an unmodifiable lazy iterable wrapped around the values for the map.

Specified by:

valuesView in interface MapIterable<K,V>

asUnmodifiable

public MutableSortedMap<K,V> asUnmodifiable()

Description copied from interface: MutableMapIterable

Returns an unmodifiable view of this map. This is the equivalent of using Collections.unmodifiableMap(this) only with a return type that supports the full iteration protocols available on MutableMapIterable. Methods which would mutate the underlying map will throw UnsupportedOperationExceptions.

Specified by:

asUnmodifiable in interface MutableMapIterable<K,V>

Specified by:

asUnmodifiable in interface MutableSortedMap<K,V>

Returns:

an unmodifiable view of this map.

See Also:

• Collections.unmodifiableMap(Map)

asSynchronized

public MutableSortedMap<K,V> asSynchronized()

Description copied from interface: MutableMapIterable

Returns a synchronized wrapper backed by this map. This is the equivalent of calling Collections.synchronizedMap(this) only with the more feature rich return type of MutableMapIterable.

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 interface MutableMapIterable<K,V>

Specified by:

asSynchronized in interface MutableSortedMap<K,V>

See Also:

• Collections.synchronizedMap(Map)

toImmutable

public ImmutableSortedMap<K,V> 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 interface MapIterable<K,V>

Specified by:

toImmutable in interface MutableMapIterable<K,V>

Specified by:

toImmutable in interface SortedMapIterable<K,V>

keySet

public MutableSet<K> keySet()

Description copied from interface: MutableSortedMap

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.

Specified by:

keySet in interface Map<K,V>

Specified by:

keySet in interface MutableSortedMap<K,V>

Specified by:

keySet in interface SortedMap<K,V>

values

public MutableCollection<V> values()

Specified by:

values in interface Map<K,V>

Specified by:

values in interface MutableSortedMap<K,V>

Specified by:

values in interface SortedMap<K,V>

entrySet

public MutableSet<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>

Specified by:

entrySet in interface MutableSortedMap<K,V>

Specified by:

entrySet in interface SortedMap<K,V>

headMap

public MutableSortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface MutableSortedMap<K,V>

Specified by:

headMap in interface SortedMap<K,V>

tailMap

public MutableSortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface MutableSortedMap<K,V>

Specified by:

tailMap in interface SortedMap<K,V>

subMap

public MutableSortedMap<K,V> subMap(K fromKey,
 K toKey)

Specified by:

subMap in interface MutableSortedMap<K,V>

Specified by:

subMap in interface SortedMap<K,V>

reverseForEach

public void reverseForEach(Procedure<? super V> procedure)

Description copied from interface: ReversibleIterable

Evaluates the procedure for each element of the list iterating in reverse order.

e.g.
 people.reverseForEach(person -> LOGGER.info(person.getName()));
 

Specified by:

reverseForEach in interface ReversibleIterable<K>

reverseForEachWithIndex

public void reverseForEachWithIndex(ObjectIntProcedure<? super V> procedure)

Description copied from interface: ReversibleIterable

Evaluates the procedure for each element and it's index in reverse order.

e.g.
 people.reverseForEachWithIndex((person, index) ->
         LOGGER.info("Index: " + index + " person: " + person.getName()));
 

Specified by:

reverseForEachWithIndex in interface ReversibleIterable<K>

asReversed

public LazyIterable<V> asReversed()

Description copied from interface: ReversibleIterable

Returns a reversed view of this ReversibleIterable.

Specified by:

asReversed in interface ReversibleIterable<K>

detectLastIndex

public int detectLastIndex(Predicate<? super V> predicate)

Description copied from interface: ReversibleIterable

Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

detectLastIndex in interface ReversibleIterable<K>

indexOf

public int indexOf(Object object)

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 interface OrderedIterable<K>

See Also:

• List.indexOf(Object)

corresponds

public <S> boolean corresponds(OrderedIterable<S> other,
 Predicate2<? super V,? super S> predicate)

Description copied from interface: OrderedIterable

Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.

Specified by:

corresponds in interface OrderedIterable<K>

forEach

public void forEach(int startIndex,
 int endIndex,
 Procedure<? super V> procedure)

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 interface OrderedIterable<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 interface OrderedIterable<K>

toStack

public MutableStack<V> toStack()

Description copied from interface: OrderedIterable

Converts the OrderedIterable to a mutable MutableStack implementation.

Specified by:

toStack in interface OrderedIterable<K>

detectIndex

public int detectIndex(Predicate<? super V> predicate)

Description copied from interface: OrderedIterable

Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

detectIndex in interface OrderedIterable<K>

toReversed

public MutableSortedMap<K,V> toReversed()

Description copied from interface: ReversibleIterable

Returns a new ReversibleIterable in reverse order.

Specified by:

toReversed in interface MutableSortedMap<K,V>

Specified by:

toReversed in interface ReversibleIterable<K>

Specified by:

toReversed in interface SortedMapIterable<K,V>

take

public MutableSortedMap<K,V> take(int count)

Description copied from interface: ReversibleIterable

Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.

Specified by:

take in interface MutableSortedMap<K,V>

Specified by:

take in interface ReversibleIterable<K>

Specified by:

take in interface SortedMapIterable<K,V>

Parameters:

count - the number of items to take.

takeWhile

public MutableSortedMap<K,V> takeWhile(Predicate<? super V> predicate)

Description copied from interface: ReversibleIterable

Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.

Specified by:

takeWhile in interface MutableSortedMap<K,V>

Specified by:

takeWhile in interface OrderedIterable<K>

Specified by:

takeWhile in interface ReversibleIterable<K>

Specified by:

takeWhile in interface SortedMapIterable<K,V>

drop

public MutableSortedMap<K,V> drop(int count)

Description copied from interface: ReversibleIterable

Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.

Specified by:

drop in interface MutableSortedMap<K,V>

Specified by:

drop in interface ReversibleIterable<K>

Specified by:

drop in interface SortedMapIterable<K,V>

Parameters:

count - the number of items to drop.

dropWhile

public MutableSortedMap<K,V> dropWhile(Predicate<? super V> predicate)

Description copied from interface: ReversibleIterable

Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.

Specified by:

dropWhile in interface MutableSortedMap<K,V>

Specified by:

dropWhile in interface OrderedIterable<K>

Specified by:

dropWhile in interface ReversibleIterable<K>

Specified by:

dropWhile in interface SortedMapIterable<K,V>

partitionWhile

public PartitionMutableList<V> partitionWhile(Predicate<? super V> predicate)

Description copied from interface: OrderedIterable

Returns 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:

partitionWhile in interface MutableSortedMap<K,V>

Specified by:

partitionWhile in interface OrderedIterable<K>

Specified by:

partitionWhile in interface ReversibleIterable<K>

Specified by:

partitionWhile in interface SortedMapIterable<K,V>

distinct

public MutableList<V> distinct()

Description copied from interface: OrderedIterable

Returns a new OrderedIterable containing 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:

distinct in interface MutableSortedMap<K,V>

Specified by:

distinct in interface OrderedIterable<K>

Specified by:

distinct in interface ReversibleIterable<K>

Specified by:

distinct in interface SortedMapIterable<K,V>

Returns:

OrderedIterable of distinct elements

getFirstOptional

public Optional<V> getFirstOptional()

Description copied from interface: OrderedIterable

Returns the first element of an iterable as an Optional. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, Optional.empty() is returned.

Specified by:

getFirstOptional in interface OrderedIterable<K>

getLastOptional

public Optional<V> getLastOptional()

Description copied from interface: OrderedIterable

Returns the last element of an iterable as an Optional. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, Optional.empty() is returned.

Specified by:

getLastOptional in interface OrderedIterable<K>