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

Class UnmodifiableTreeMap<K,V>

java.lang.Object

org.eclipse.collections.impl.UnmodifiableMap<K,V>

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

org.eclipse.collections.impl.map.sorted.mutable.UnmodifiableTreeMap<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 UnmodifiableTreeMap<K,V>
extends UnmodifiableSortedMap<K,V>
implements MutableSortedMap<K,V>

An unmodifiable view of a map.

See Also:

• MutableSortedMap.asUnmodifiable()
• Serialized Form

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method	Description
V	add(Pair<? extends K,? extends V> keyValuePair)	This method allows mutable map the ability to add an element in the form of Pair<? extends K, ? extends V>.
boolean	allSatisfy(Predicate<? super V> predicate)	Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
<P> boolean	allSatisfyWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns true if the predicate evaluates to true for every element of the collection, or returns false.
boolean	anySatisfy(Predicate<? super V> predicate)	Returns true if the predicate evaluates to true for any element of the iterable.
<P> boolean	anySatisfyWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns true if the predicate evaluates to true for any element of the collection, or return false.
void	appendString(Appendable appendable)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyIterable<V>	asLazy()	Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
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.
RichIterable<RichIterable<V>>	chunk(int size)	Partitions elements in fixed size chunks.
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.
<R, C extends Collection<R>> C	collect(Function<? super V,? extends R> function, C target)	Same as RichIterable.collect(Function), except that the results are gathered into the specified target 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.
<R extends MutableBooleanCollection> R	collectBoolean(BooleanFunction<? super V> booleanFunction, R target)	Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target 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.
<R extends MutableByteCollection> R	collectByte(ByteFunction<? super V> byteFunction, R target)	Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target 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.
<R extends MutableCharCollection> R	collectChar(CharFunction<? super V> charFunction, R target)	Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target 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.
<R extends MutableDoubleCollection> R	collectDouble(DoubleFunction<? super V> doubleFunction, R target)	Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target 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 extends MutableFloatCollection> R	collectFloat(FloatFunction<? super V> floatFunction, R target)	Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target 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.
<R, C extends Collection<R>> C	collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> function, C target)	Same as the collectIf method with two parameters but uses the specified target collection for the results.
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.
<R extends MutableIntCollection> R	collectInt(IntFunction<? super V> intFunction, R target)	Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target 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 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.
<R extends MutableLongCollection> R	collectLong(LongFunction<? super V> longFunction, R target)	Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target 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 extends MutableShortCollection> R	collectShort(ShortFunction<? super V> shortFunction, R target)	Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target 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, R, C extends Collection<R>> C	collectWith(Function2<? super V,? super P,? extends R> function, P parameter, C targetCollection)	Same as collectWith but with a targetCollection parameter to gather the results.
<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.
boolean	contains(Object object)	Returns true if the iterable has an element which responds true to element.equals(object).
boolean	containsAll(Collection<?> source)	Returns true if all elements in source are contained in this collection.
boolean	containsAllArguments(Object... elements)	Returns true if all elements in the specified var arg array are contained in this collection.
boolean	containsAllIterable(Iterable<?> source)	Returns true if all elements in source are contained in this collection.
<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	count(Predicate<? super V> predicate)	Return the total number of elements that answer true to the specified predicate.
<P> int	countWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns the total number of elements that evaluate to true for the specified predicate.
V	detect(Predicate<? super V> predicate)	Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true.
Pair<K,V>	detect(Predicate2<? super K,? super V> predicate)	Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments.
V	detectIfNone(Predicate<? super V> predicate, Function0<? extends V> function)	Returns the first element of the iterable for which the predicate evaluates to true.
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.
Optional<V>	detectOptional(Predicate<? super V> predicate)	Returns the first element of the iterable for which the predicate evaluates to true as an Optional.
Optional<Pair<K,V>>	detectOptional(Predicate2<? super K,? super V> predicate)	Return the first key and value of the map as an Optional for which the predicate evaluates to true when they are given as arguments.
<P> V	detectWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
<P> V	detectWithIfNone(Predicate2<? super V,? super P> predicate, P parameter, Function0<? extends V> function)	Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
<P> Optional<V>	detectWithOptional(Predicate2<? super V,? super P> predicate, P parameter)	Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.
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.
void	each(Procedure<? super V> procedure)	The procedure is executed for each element in the iterable.
MutableSet<Map.Entry<K,V>>	entrySet()
boolean	equals(Object obj)	Follows the same general contract as Map.equals(Object).
<R> MutableList<R>	flatCollect(Function<? super V,? extends Iterable<R>> function)	flatCollect is a special case of RichIterable.collect(Function).
<R, C extends Collection<R>> C	flatCollect(Function<? super V,? extends Iterable<R>> function, C target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableBooleanCollection> R	flatCollectBoolean(Function<? super V,? extends BooleanIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableByteCollection> R	flatCollectByte(Function<? super V,? extends ByteIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableCharCollection> R	flatCollectChar(Function<? super V,? extends CharIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableDoubleCollection> R	flatCollectDouble(Function<? super V,? extends DoubleIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableFloatCollection> R	flatCollectFloat(Function<? super V,? extends FloatIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableIntCollection> R	flatCollectInt(Function<? super V,? extends IntIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableLongCollection> R	flatCollectLong(Function<? super V,? extends LongIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableShortCollection> R	flatCollectShort(Function<? super V,? extends ShortIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
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	forEachKey(Procedure<? super K> procedure)	Calls the procedure with each key of the map.
void	forEachKeyValue(Procedure2<? super K,? super V> procedure)	Calls the procedure with each key-value pair of the map.
void	forEachValue(Procedure<? super V> procedure)	Calls the procedure with each value of the map.
<P> void	forEachWith(Procedure2<? super V,? super P> procedure, P parameter)	The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
void	forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super V> objectIntProcedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithIndex(ObjectIntProcedure<? super V> objectIntProcedure)	Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
V	getFirst()	Returns the first element of an iterable.
V	getIfAbsent(K key, Function0<? extends V> function)	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 Function0.
V	getIfAbsentPut(K key, Function0<? extends V> function)	Get and return the value in the Map at the specified key.
V	getIfAbsentPut(K key, V value)	Get and return the value in the Map at the specified key.
<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.
V	getIfAbsentPutWithKey(K key, Function<? super K,? extends V> function)	Get and return the value in the Map at the specified key.
V	getIfAbsentValue(K key, V value)	Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return value.
<P> V	getIfAbsentWith(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 function and parameter.
V	getLast()	Returns the last element of an iterable.
V	getOnly()	Returns the element if the iterable has exactly one element.
<R> MutableListMultimap<R,V>	groupBy(Function<? super V,? extends R> 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.
<R, C extends MutableMultimap<R, V>> C	groupBy(Function<? super V,? extends R> function, C target)	Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
<R> MutableListMultimap<R,V>	groupByEach(Function<? super V,? extends Iterable<R>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<R, C extends MutableMultimap<R, V>> C	groupByEach(Function<? super V,? extends Iterable<R>> function, C target)	Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
<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.
<VV, R extends MutableMapIterable<VV, V>> R	groupByUniqueKey(Function<? super V,? extends VV> function, R target)	Same as RichIterable.groupByUniqueKey(Function), except that the results are gathered into the specified target map.
int	hashCode()	Follows the same general contract as Map.hashCode().
MutableSortedMap<K,V>	headMap(K toKey)
<A> A	ifPresentApply(K key, Function<? super V,? extends A> function)	If there is a value in the Map that corresponds to the specified key return the result of applying the specified Function on the value, otherwise return null.
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.
double	injectInto(double injectedValue, DoubleObjectToDoubleFunction<? super V> function)	Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
float	injectInto(float injectedValue, FloatObjectToFloatFunction<? super V> function)	Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
int	injectInto(int injectedValue, IntObjectToIntFunction<? super V> function)	Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
long	injectInto(long injectedValue, LongObjectToLongFunction<? super V> function)	Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
<IV> IV	injectInto(IV injectedValue, Function2<? super IV,? super V,? extends IV> function)	Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
<R extends Collection<V>> R	into(R target)	Adds all the elements in this iterable to the specific target Collection.
Iterator<V>	iterator()
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.
RichIterable<Pair<K,V>>	keyValuesView()	Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.
String	makeString()	Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
String	makeString(String separator)	Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
String	makeString(String start, String separator, String end)	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
V	max()	Returns the maximum element out of this container based on the natural order.
V	max(Comparator<? super V> comparator)	Returns the maximum element out of this container based on the comparator.
<R extends Comparable<? super R>> V	maxBy(Function<? super V,? extends R> function)	Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
V	min()	Returns the minimum element out of this container based on the natural order.
V	min(Comparator<? super V> comparator)	Returns the minimum element out of this container based on the comparator.
<R extends Comparable<? super R>> V	minBy(Function<? super V,? extends R> function)	Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
MutableSortedMap<K,V>	newEmpty()	Creates a new instance of the same type with the same internal Comparator.
boolean	noneSatisfy(Predicate<? super V> predicate)	Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
<P> boolean	noneSatisfyWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns true if the predicate evaluates to false for every element of the collection, or return false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
static <K, V, M extends SortedMap<K, V>> UnmodifiableTreeMap<K,V>	of(M map)	This method will take a MutableSortedMap and wrap it directly in a UnmodifiableMutableMap.
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)
V	putPair(Pair<? extends K,? extends V> keyValuePair)	This method allows mutable map the ability to add an element in the form of Pair<? extends K, ? extends V>.
MutableList<V>	reject(Predicate<? super V> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
<R extends Collection<V>> R	reject(Predicate<? super V> predicate, R target)	Same as the reject method with one parameter but uses the specified target collection for the results.
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.
<P, R extends Collection<V>> R	rejectWith(Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)	Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
boolean	removeAllKeys(Set<? extends K> keys)	Remove entries from the map at the specified keys.
boolean	removeIf(Predicate2<? super K,? super V> predicate)	Remove an entry from the map if the predicate evaluates to true.
V	removeKey(K key)	Remove an entry from the map at the specified key.
MutableList<V>	select(Predicate<? super V> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
<R extends Collection<V>> R	select(Predicate<? super V> predicate, R target)	Same as the select method with one parameter but uses the specified target collection for the results.
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.
<P, R extends Collection<V>> R	selectWith(Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)	Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
MutableSortedMap<K,V>	subMap(K fromKey, K toKey)
<V1> MutableObjectDoubleMap<V1>	sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> MutableObjectDoubleMap<V1>	sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> MutableObjectLongMap<V1>	sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> MutableObjectLongMap<V1>	sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)	Groups and sums the values using the two specified functions.
double	sumOfDouble(DoubleFunction<? super V> function)	Returns the final double result of evaluating function for each element of the iterable and adding the results together.
double	sumOfFloat(FloatFunction<? super V> function)	Returns the final double result of evaluating function for each element of the iterable and adding the results together.
long	sumOfInt(IntFunction<? super V> function)	Returns the final long result of evaluating function for each element of the iterable and adding the results together.
long	sumOfLong(LongFunction<? super V> function)	Returns the final long result of evaluating function for each element of the iterable and adding the results together.
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 value of the map and returns this.
Object[]	toArray()	Converts this iterable to an array.
<T> T[]	toArray(T[] a)	Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
MutableBag<V>	toBag()	Converts the collection to the default MutableBag implementation.
<NK, NV> MutableBiMap<NK,NV>	toBiMap(Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction)	Converts the collection to a BiMap implementation using the specified key and value functions.
ImmutableSortedMap<K,V>	toImmutable()	Returns an immutable copy of this map.
MutableList<V>	toList()	Converts the collection to a MutableList implementation.
<NK, NV> MutableMap<NK,NV>	toMap(Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction)	Converts the collection to a MutableMap implementation using the specified key and value functions.
<NK, NV, R extends Map<NK, NV>> R	toMap(Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction, R target)	Same as RichIterable.toMap(Function, Function), except that the results are gathered into the specified target map.
MutableSortedMap<K,V>	toReversed()	Returns a new ReversibleIterable in reverse order.
MutableSet<V>	toSet()	Converts the collection to a MutableSet implementation.
MutableSortedBag<V>	toSortedBag()	Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.
MutableSortedBag<V>	toSortedBag(Comparator<? super V> comparator)	Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.
MutableList<V>	toSortedList()	Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
MutableList<V>	toSortedList(Comparator<? super V> comparator)	Converts the collection to a MutableList implementation and sorts it using the specified comparator.
<NK, NV> MutableSortedMap<NK,NV>	toSortedMap(Comparator<? super NK> comparator, Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction)	Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
<NK, NV> MutableSortedMap<NK,NV>	toSortedMap(Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction)	Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
MutableSortedSet<V>	toSortedSet()	Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
MutableSortedSet<V>	toSortedSet(Comparator<? super V> comparator)	Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
MutableStack<V>	toStack()	Converts the OrderedIterable to a mutable MutableStack implementation.
V	updateValue(K key, Function0<? extends V> factory, Function<? super V,? extends V> function)	Looks up the value associated with key, applies the function to it, and replaces the value.
<P> V	updateValueWith(K key, Function0<? extends V> factory, Function2<? super V,? super P,? extends V> function, P parameter)	Same as MutableMapIterable.updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.
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)
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.
<S, R extends Collection<Pair<V, S>>> R	zip(Iterable<S> that, R target)	Same as RichIterable.zip(Iterable) but uses target for output.
MutableList<Pair<V,Integer>>	zipWithIndex()	Zips this RichIterable with its indices.
<R extends Collection<Pair<V, Integer>>> R	zipWithIndex(R target)	Same as RichIterable.zipWithIndex() but uses target for output.

Methods inherited from class org.eclipse.collections.impl.map.sorted.mutable.UnmodifiableSortedMap

comparator, firstKey, lastKey

Methods inherited from class org.eclipse.collections.impl.UnmodifiableMap

clear, containsKey, containsValue, get, isEmpty, put, putAll, remove, size, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

forEach

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, forEach, get, getOrDefault, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

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

containsKey, containsValue, get, injectIntoKeyValue, parallelStream, spliterator, stream, toString

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

aggregateBy, aggregateBy, aggregateInPlaceBy, countBy, countByEach, countByWith, getOrDefault

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

flatCollectWith

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

getFirstOptional, getLastOptional, rejectWithIndex, selectWithIndex

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

reverseForEach, reverseForEachWithIndex

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

aggregateBy, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, countBy, countByEach, countByWith, flatCollectWith, forEach, getAny, groupByAndCollect, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, isEmpty, makeString, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, reduce, reduceInPlace, reduceInPlace, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toSortedBagBy, toSortedListBy, toSortedMapBy, toSortedSetBy

Methods inherited from interface java.util.SortedMap

comparator, firstKey, lastKey

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

comparator

Method Details

of

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

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

putPair

public V putPair(Pair<? extends K,? extends V> keyValuePair)

Description copied from interface: MutableMapIterable

This method allows mutable map the ability to add an element in the form of Pair<? extends K, ? extends V>.

Specified by:

putPair in interface MutableMapIterable<K,V>

See Also:

• Map.put(Object, Object)

add

public V add(Pair<? extends K,? extends V> keyValuePair)

Description copied from interface: MutableMapIterable

This method allows mutable map the ability to add an element in the form of Pair<? extends K, ? extends V>.

Specified by:

add in interface MutableMapIterable<K,V>

Returns:

previous value in the map for the key, or null if no value exists for the key.

See Also:

• Map.put(Object, Object)

removeKey

public V removeKey(K key)

Description copied from interface: MutableMapIterable

Remove an entry from the map at the specified key.

Specified by:

removeKey in interface MutableMapIterable<K,V>

Returns:

The value removed from entry at key, or null if not found.

See Also:

• Map.remove(Object)

removeAllKeys

public boolean removeAllKeys(Set<? extends K> keys)

Description copied from interface: MutableMapIterable

Remove entries from the map at the specified keys.

Specified by:

removeAllKeys in interface MutableMapIterable<K,V>

Returns:

true if this map changed as a result of the call

removeIf

public boolean removeIf(Predicate2<? super K,? super V> predicate)

Description copied from interface: MutableMapIterable

Remove an entry from the map if the predicate evaluates to true.

Specified by:

removeIf in interface MutableMapIterable<K,V>

Returns:

true if any entry is removed.

with

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

Specified by:

with in interface MutableSortedMap<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>

withAllKeyValues

public MutableSortedMap<K,V> withAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)

Description copied from interface: MutableMapIterable

This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus all the additional keys and values. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:

 map = map.withAllKeyValues(FastList.newListWith(PairImpl.of("new key", "new value")));
 

In the case of FixedSizeMap, a new instance will be returned by withAllKeyValues, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.

Specified by:

withAllKeyValues in interface MutableMapIterable<K,V>

Specified by:

withAllKeyValues in interface MutableSortedMap<K,V>

See Also:

• Map.put(Object, Object)

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)

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 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)

updateValue

public V updateValue(K key,
 Function0<? extends V> factory,
 Function<? super V,? extends V> function)

Description copied from interface: MutableMapIterable

Looks up the value associated with key, applies the function to it, and replaces the value. If there is no value associated with key, starts it off with a value supplied by factory.

Specified by:

updateValue in interface MutableMapIterable<K,V>

updateValueWith

public <P> V updateValueWith(K key,
 Function0<? extends V> factory,
 Function2<? super V,? super P,? extends V> function,
 P parameter)

Description copied from interface: MutableMapIterable

Same as MutableMapIterable.updateValue(Object, Function0, Function) with a Function2 and specified parameter which is passed to the function.

Specified by:

updateValueWith in interface MutableMapIterable<K,V>

collectKeysAndValues

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

Description copied from interface: MutableSortedMap

Adds all the entries derived 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>

getIfAbsentPut

public V getIfAbsentPut(K key,
 Function0<? extends V> function)

Description copied from interface: MutableMapIterable

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the result of evaluating the specified Function0, and put that value in the map at the specified key.

Specified by:

getIfAbsentPut in interface MutableMapIterable<K,V>

getIfAbsentPut

public V getIfAbsentPut(K key,
 V value)

Description copied from interface: MutableMapIterable

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map at the key, return the specified value, and put that value in the map at the specified key.

Specified by:

getIfAbsentPut in interface MutableMapIterable<K,V>

getIfAbsentPutWithKey

public V getIfAbsentPutWithKey(K key,
 Function<? super K,? extends V> function)

Description copied from interface: MutableMapIterable

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified key, and put that value in the map at the specified key.

Specified by:

getIfAbsentPutWithKey in interface MutableMapIterable<K,V>

getIfAbsentPutWith

public <P> V getIfAbsentPutWith(K key,
 Function<? super P,? extends V> function,
 P parameter)

Description copied from interface: MutableSortedMap

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:

getIfAbsentPutWith in interface MutableMapIterable<K,V>

Specified by:

getIfAbsentPutWith in interface MutableSortedMap<K,V>

getIfAbsent

public V getIfAbsent(K key,
 Function0<? extends V> function)

Description copied from interface: MapIterable

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 Function0.

Specified by:

getIfAbsent in interface MapIterable<K,V>

getIfAbsentValue

public V getIfAbsentValue(K key,
 V value)

Description copied from interface: MapIterable

Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return value.

Specified by:

getIfAbsentValue in interface MapIterable<K,V>

getIfAbsentWith

public <P> V getIfAbsentWith(K key,
 Function<? super P,? extends V> function,
 P parameter)

Description copied from interface: MapIterable

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 function and parameter.

Specified by:

getIfAbsentWith in interface MapIterable<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>

clone

public MutableSortedMap<K,V> clone()

Specified by:

clone in interface MutableSortedMap<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>

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<K>

hashCode

public int hashCode()

Description copied from interface: MapIterable

Follows the same general contract as Map.hashCode().

Specified by:

hashCode in interface Map<K,V>

Specified by:

hashCode in interface MapIterable<K,V>

Overrides:

hashCode in class UnmodifiableMap<K,V>

equals

public boolean equals(Object obj)

Description copied from interface: MapIterable

Follows the same general contract as Map.equals(Object).

Specified by:

equals in interface Map<K,V>

Specified by:

equals in interface MapIterable<K,V>

Overrides:

equals in class UnmodifiableMap<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>

keyValuesView

public RichIterable<Pair<K,V>> keyValuesView()

Description copied from interface: MapIterable

Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.

Specified by:

keyValuesView in interface MapIterable<K,V>

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>

notEmpty

public boolean notEmpty()

Description copied from interface: RichIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface RichIterable<K>

forEachValue

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

Description copied from interface: MapIterable

Calls the procedure with each value of the map.

     Set<String> result = UnifiedSet.newSet();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three", 4, "Four");
     map.forEachValue(new CollectionAddProcedure<String>(result));
     Verify.assertSetsEqual(UnifiedSet.newSetWith("One", "Two", "Three", "Four"), result);
 

Specified by:

forEachValue in interface MapIterable<K,V>

forEachKey

public void forEachKey(Procedure<? super K> procedure)

Description copied from interface: MapIterable

Calls the procedure with each key of the map.

     final Collection<Integer> result = new ArrayList<Integer>();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     map.forEachKey(new CollectionAddProcedure<Integer>(result));
     Verify.assertContainsAll(result, 1, 2, 3);
 

Specified by:

forEachKey in interface MapIterable<K,V>

forEachKeyValue

public void forEachKeyValue(Procedure2<? super K,? super V> procedure)

Description copied from interface: MapIterable

Calls the procedure with each key-value pair of the map.

     final Collection<String> collection = new ArrayList<String>();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three");
     map.forEachKeyValue((Integer key, String value) -> collection.add(String.valueOf(key) + value));
     Verify.assertContainsAll(collection, "1One", "2Two", "3Three");
 

Specified by:

forEachKeyValue in interface MapIterable<K,V>

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>

ifPresentApply

public <A> A ifPresentApply(K key,
 Function<? super V,? extends A> function)

Description copied from interface: MapIterable

If there is a value in the Map that corresponds to the specified key return the result of applying the specified Function on the value, otherwise return null.

Specified by:

ifPresentApply in interface MapIterable<K,V>

tap

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

Description copied from interface: MapIterable

Executes the Procedure for each value of the map and returns this.

 return peopleByCity.tap(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>

See Also:

• RichIterable.forEach(Procedure)

each

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

Description copied from interface: RichIterable

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

 people.each(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

 people.each(new Procedure<Person>()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).

Specified by:

each in interface RichIterable<K>

See Also:

• InternalIterable.forEach(Procedure)
• Iterable.forEach(java.util.function.Consumer)

forEachWithIndex

public void forEachWithIndex(ObjectIntProcedure<? super V> objectIntProcedure)

Description copied from interface: InternalIterable

Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.

Example using a Java 8 lambda:

 people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));
 

Example using an anonymous inner class:

 people.forEachWithIndex(new ObjectIntProcedure<Person>()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 

Specified by:

forEachWithIndex in interface InternalIterable<K>

Specified by:

forEachWithIndex in interface OrderedIterable<K>

forEachWith

public <P> void forEachWith(Procedure2<? super V,? super P> procedure,
 P parameter)

Description copied from interface: InternalIterable

The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

Example using a Java 8 lambda:

 people.forEachWith((Person person, Person other) ->
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }, fred);
 

Example using an anonymous inner class:

 people.forEachWith(new Procedure2<Person, Person>()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
 

Specified by:

forEachWith in interface InternalIterable<K>

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>

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>

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>

detect

public Pair<K,V> detect(Predicate2<? super K,? super V> predicate)

Description copied from interface: MapIterable

Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate. The result is null if predicate does not evaluate to true for any key/value combination.

 Pair<City, Person> detected =
     peopleByCity.detect((City city, Person person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
 

Specified by:

detect in interface MapIterable<K,V>

detectOptional

public Optional<Pair<K,V>> detectOptional(Predicate2<? super K,? super V> predicate)

Description copied from interface: MapIterable

Return the first key and value of the map as an Optional for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate.

 Optional<Pair<City, Person>> detected =
     peopleByCity.detectOptional((city, person)
          -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
 

Specified by:

detectOptional in interface MapIterable<K,V>

anySatisfy

public boolean anySatisfy(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.

Specified by:

anySatisfy in interface RichIterable<K>

anySatisfyWith

public <P> boolean anySatisfyWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.

Specified by:

anySatisfyWith in interface RichIterable<K>

allSatisfy

public boolean allSatisfy(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

allSatisfy in interface RichIterable<K>

allSatisfyWith

public <P> boolean allSatisfyWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to true for every element of the collection, or returns false.

Specified by:

allSatisfyWith in interface RichIterable<K>

noneSatisfy

public boolean noneSatisfy(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

noneSatisfy in interface RichIterable<K>

noneSatisfyWith

public <P> boolean noneSatisfyWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.

Specified by:

noneSatisfyWith in interface RichIterable<K>

appendString

public void appendString(Appendable appendable)

Description copied from interface: RichIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString().

Specified by:

appendString in interface RichIterable<K>

appendString

public void appendString(Appendable appendable,
 String separator)

Description copied from interface: RichIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String).

Specified by:

appendString in interface RichIterable<K>

appendString

public void appendString(Appendable appendable,
 String start,
 String separator,
 String end)

Description copied from interface: RichIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String, String, String).

Specified by:

appendString in interface RichIterable<K>

toBag

public MutableBag<V> toBag()

Description copied from interface: RichIterable

Converts the collection to the default MutableBag implementation.

Specified by:

toBag in interface RichIterable<K>

toSortedBag

public MutableSortedBag<V> toSortedBag()

Description copied from interface: RichIterable

Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.

Specified by:

toSortedBag in interface RichIterable<K>

toSortedBag

public MutableSortedBag<V> toSortedBag(Comparator<? super V> comparator)

Description copied from interface: RichIterable

Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.

Specified by:

toSortedBag in interface RichIterable<K>

asLazy

public LazyIterable<V> asLazy()

Description copied from interface: RichIterable

Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).

Specified by:

asLazy in interface RichIterable<K>

into

public <R extends Collection<V>> R into(R target)

Description copied from interface: RichIterable

Adds all the elements in this iterable to the specific target Collection.

Specified by:

into in interface RichIterable<K>

toList

public MutableList<V> toList()

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation.

Specified by:

toList in interface RichIterable<K>

toMap

public <NK,
NV> MutableMap<NK,NV> toMap(Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a MutableMap implementation using the specified key and value functions.

Specified by:

toMap in interface RichIterable<K>

toMap

public <NK,
NV,
R extends Map<NK,
NV>> R toMap(Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.toMap(Function, Function), except that the results are gathered into the specified target map.

Specified by:

toMap in interface RichIterable<K>

toSortedMap

public <NK,
NV> MutableSortedMap<NK,NV> toSortedMap(Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.

Specified by:

toSortedMap in interface RichIterable<K>

toSortedMap

public <NK,
NV> MutableSortedMap<NK,NV> toSortedMap(Comparator<? super NK> comparator,
 Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.

Specified by:

toSortedMap in interface RichIterable<K>

toBiMap

public <NK,
NV> MutableBiMap<NK,NV> toBiMap(Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a BiMap implementation using the specified key and value functions.

Specified by:

toBiMap in interface RichIterable<K>

toSet

public MutableSet<V> toSet()

Description copied from interface: RichIterable

Converts the collection to a MutableSet implementation.

Specified by:

toSet in interface RichIterable<K>

toSortedList

public MutableList<V> toSortedList()

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.

Specified by:

toSortedList in interface RichIterable<K>

toSortedList

public MutableList<V> toSortedList(Comparator<? super V> comparator)

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation and sorts it using the specified comparator.

Specified by:

toSortedList in interface RichIterable<K>

toSortedSet

public MutableSortedSet<V> toSortedSet()

Description copied from interface: RichIterable

Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.

Specified by:

toSortedSet in interface RichIterable<K>

toSortedSet

public MutableSortedSet<V> toSortedSet(Comparator<? super V> comparator)

Description copied from interface: RichIterable

Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.

Specified by:

toSortedSet in interface RichIterable<K>

chunk

public RichIterable<RichIterable<V>> chunk(int size)

Description copied from interface: RichIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface RichIterable<K>

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.

collect

public <R,
C extends Collection<R>> C collect(Function<? super V,? extends R> function,
 C target)

Description copied from interface: RichIterable

Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 MutableList<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName(), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     }, Lists.mutable.empty());
 

Specified by:

collect in interface RichIterable<K>

Parameters:

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

target, which contains appended elements as a result of the collect transformation

See Also:

• RichIterable.collect(Function)

collectIf

public <R,
C extends Collection<R>> C collectIf(Predicate<? super V> predicate,
 Function<? super V,? extends R> function,
 C target)

Description copied from interface: RichIterable

Same as the collectIf method with two parameters but uses the specified target collection for the results.

Specified by:

collectIf in interface RichIterable<K>

Parameters:

predicate - a Predicate to use as the select criteria

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the collect criteria and transformation

See Also:

• RichIterable.collectIf(Predicate, Function)

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>

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)

collectWith

public <P,
R,
C extends Collection<R>> C collectWith(Function2<? super V,? super P,? extends R> function,
 P parameter,
 C targetCollection)

Description copied from interface: RichIterable

Same as collectWith but with a targetCollection parameter to gather the results.

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

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

Specified by:

collectWith in interface RichIterable<K>

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

targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

targetCollection, which contains appended elements as a result of the collect transformation

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

contains

public boolean contains(Object object)

Description copied from interface: RichIterable

Returns true if the iterable has an element which responds true to element.equals(object).

Specified by:

contains in interface RichIterable<K>

containsAllArguments

public boolean containsAllArguments(Object... elements)

Description copied from interface: RichIterable

Returns true if all elements in the specified var arg array are contained in this collection.

Specified by:

containsAllArguments in interface RichIterable<K>

containsAllIterable

public boolean containsAllIterable(Iterable<?> source)

Description copied from interface: RichIterable

Returns true if all elements in source are contained in this collection.

Specified by:

containsAllIterable in interface RichIterable<K>

containsAll

public boolean containsAll(Collection<?> source)

Description copied from interface: RichIterable

Returns true if all elements in source are contained in this collection.

Specified by:

containsAll in interface RichIterable<K>

See Also:

• Collection.containsAll(Collection)

count

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

Description copied from interface: RichIterable

Return the total number of elements that answer true to the specified predicate.

Example using a Java 8 lambda expression:

 int count =
     people.count(person -> person.getAddress().getState().getName().equals("New York"));
 

Example using an anonymous inner class:

 int count =
     people.count(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
 

Specified by:

count in interface RichIterable<K>

countWith

public <P> int countWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Returns the total number of elements that evaluate to true for the specified predicate.

e.g.
 return lastNames.countWith(Predicates2.equal(), "Smith");
 

Specified by:

countWith in interface RichIterable<K>

detect

public V detect(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

Example using a Java 8 lambda expression:

 Person person =
     people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
 

Example using an anonymous inner class:

 Person person =
     people.detect(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
         }
     });
 

Specified by:

detect in interface RichIterable<K>

detectWith

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

Description copied from interface: RichIterable

Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

Example using a Java 8 lambda expression:

 Person person =
     people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Example using an anonymous inner class:

 Person person =
     people.detectWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String fullName)
         {
             return person.getFullName().equals(fullName);
         }
     }, "John Smith");
 

Specified by:

detectWith in interface RichIterable<K>

detectOptional

public Optional<V> detectOptional(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find.

Example using a Java 8 lambda expression:

 Person person =
     people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
 

Specified by:

detectOptional in interface RichIterable<K>

detectWithOptional

public <P> Optional<V> detectWithOptional(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.

Example using a Java 8 lambda expression:

 Optional<Person> person =
     people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Specified by:

detectWithOptional in interface RichIterable<K>

detectIfNone

public V detectIfNone(Predicate<? super V> predicate,
 Function0<? extends V> function)

Description copied from interface: RichIterable

Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.

Specified by:

detectIfNone in interface RichIterable<K>

detectWithIfNone

public <P> V detectWithIfNone(Predicate2<? super V,? super P> predicate,
 P parameter,
 Function0<? extends V> function)

Description copied from interface: RichIterable

Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.

Specified by:

detectWithIfNone in interface RichIterable<K>

flatCollect

public <R,
C extends Collection<R>> C flatCollect(Function<? super V,? extends Iterable<R>> function,
 C target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollect in interface RichIterable<K>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

• RichIterable.flatCollect(Function)

getFirst

public V getFirst()

Description copied from interface: RichIterable

Returns the first element of an iterable. 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, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.

Specified by:

getFirst in interface OrderedIterable<K>

Specified by:

getFirst in interface RichIterable<K>

getLast

public V getLast()

Description copied from interface: RichIterable

Returns the last element of an iterable. 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, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.

Specified by:

getLast in interface OrderedIterable<K>

Specified by:

getLast in interface RichIterable<K>

getOnly

public V getOnly()

Description copied from interface: RichIterable

Returns the element if the iterable has exactly one element. Otherwise, throw IllegalStateException.

Specified by:

getOnly in interface RichIterable<K>

Returns:

an element of an iterable.

groupBy

public <R> MutableListMultimap<R,V> groupBy(Function<? super V,? extends R> 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>

groupBy

public <R,
C extends MutableMultimap<R,
V>> C groupBy(Function<? super V,? extends R> function,
 C target)

Description copied from interface: RichIterable

Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.

Example using a Java 8 method reference:

 FastListMultimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName, new FastListMultimap<String, Person>());
 

Example using an anonymous inner class:

 FastListMultimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     }, new FastListMultimap<String, Person>());
 

Specified by:

groupBy in interface RichIterable<K>

groupByEach

public <R> MutableListMultimap<R,V> groupByEach(Function<? super V,? extends Iterable<R>> 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>

groupByEach

public <R,
C extends MutableMultimap<R,
V>> C groupByEach(Function<? super V,? extends Iterable<R>> function,
 C target)

Description copied from interface: RichIterable

Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.

Specified by:

groupByEach in interface RichIterable<K>

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 the results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.

Specified by:

groupByUniqueKey in interface MutableMapIterable<K,V>

Specified by:

groupByUniqueKey in interface MutableSortedMap<K,V>

Specified by:

groupByUniqueKey in interface RichIterable<K>

See Also:

• RichIterable.groupBy(Function)

groupByUniqueKey

public <VV,
R extends MutableMapIterable<VV,
V>> R groupByUniqueKey(Function<? super V,? extends VV> function,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.groupByUniqueKey(Function), except that the results are gathered into the specified target map.

Specified by:

groupByUniqueKey in interface RichIterable<K>

See Also:

• RichIterable.groupByUniqueKey(Function)

injectInto

public <IV> IV injectInto(IV injectedValue,
 Function2<? super IV,? super V,? extends IV> function)

Description copied from interface: RichIterable

Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.

Specified by:

injectInto in interface RichIterable<K>

injectInto

public int injectInto(int injectedValue,
 IntObjectToIntFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface RichIterable<K>

injectInto

public long injectInto(long injectedValue,
 LongObjectToLongFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface RichIterable<K>

injectInto

public double injectInto(double injectedValue,
 DoubleObjectToDoubleFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface RichIterable<K>

injectInto

public float injectInto(float injectedValue,
 FloatObjectToFloatFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

injectInto in interface RichIterable<K>

sumOfInt

public long sumOfInt(IntFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final long result of evaluating function for each element of the iterable and adding the results together.

Specified by:

sumOfInt in interface RichIterable<K>

sumOfFloat

public double sumOfFloat(FloatFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.

Specified by:

sumOfFloat in interface RichIterable<K>

sumOfLong

public long sumOfLong(LongFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final long result of evaluating function for each element of the iterable and adding the results together.

Specified by:

sumOfLong in interface RichIterable<K>

sumOfDouble

public double sumOfDouble(DoubleFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.

Specified by:

sumOfDouble in interface RichIterable<K>

sumByInt

public <V1> MutableObjectLongMap<V1> sumByInt(Function<? super V,? extends V1> groupBy,
 IntFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface MutableMapIterable<K,V>

Specified by:

sumByInt in interface RichIterable<K>

sumByFloat

public <V1> MutableObjectDoubleMap<V1> sumByFloat(Function<? super V,? extends V1> groupBy,
 FloatFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByFloat in interface MutableMapIterable<K,V>

Specified by:

sumByFloat in interface RichIterable<K>

sumByLong

public <V1> MutableObjectLongMap<V1> sumByLong(Function<? super V,? extends V1> groupBy,
 LongFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface MutableMapIterable<K,V>

Specified by:

sumByLong in interface RichIterable<K>

sumByDouble

public <V1> MutableObjectDoubleMap<V1> sumByDouble(Function<? super V,? extends V1> groupBy,
 DoubleFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByDouble in interface MutableMapIterable<K,V>

Specified by:

sumByDouble in interface RichIterable<K>

makeString

public String makeString()

Description copied from interface: RichIterable

Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

makeString in interface RichIterable<K>

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: RichIterable

Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

makeString in interface RichIterable<K>

Returns:

a string representation of this collection.

makeString

public String makeString(String start,
 String separator,
 String end)

Description copied from interface: RichIterable

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Specified by:

makeString in interface RichIterable<K>

Returns:

a string representation of this collection.

max

public V max()

Description copied from interface: RichIterable

Returns the maximum element out of this container based on the natural order.

Specified by:

max in interface OrderedIterable<K>

Specified by:

max in interface RichIterable<K>

max

public V max(Comparator<? super V> comparator)

Description copied from interface: RichIterable

Returns the maximum element out of this container based on the comparator.

Specified by:

max in interface RichIterable<K>

maxBy

public <R extends Comparable<? super R>> V maxBy(Function<? super V,? extends R> function)

Description copied from interface: RichIterable

Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

maxBy in interface RichIterable<K>

min

public V min()

Description copied from interface: RichIterable

Returns the minimum element out of this container based on the natural order.

Specified by:

min in interface OrderedIterable<K>

Specified by:

min in interface RichIterable<K>

min

public V min(Comparator<? super V> comparator)

Description copied from interface: RichIterable

Returns the minimum element out of this container based on the comparator.

Specified by:

min in interface RichIterable<K>

minBy

public <R extends Comparable<? super R>> V minBy(Function<? super V,? extends R> function)

Description copied from interface: RichIterable

Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

minBy in interface RichIterable<K>

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>

select

public <R extends Collection<V>> R select(Predicate<? super V> predicate,
 R target)

Description copied from interface: RichIterable

Same as the select method with one parameter but uses the specified target collection for the results.

Example using a Java 8 lambda expression:

 MutableList<Person> selected =
     people.select(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
 

Specified by:

select in interface RichIterable<K>

Parameters:

predicate - a Predicate to use as the select criteria

target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

target, which contains appended elements as a result of the select criteria

See Also:

• RichIterable.select(Predicate)

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>

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)

selectWith

public <P,
R extends Collection<V>> R selectWith(Predicate2<? super V,? super P> predicate,
 P parameter,
 R targetCollection)

Description copied from interface: RichIterable

Similar to RichIterable.select(Predicate, Collection), 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:

 MutableList<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18), Lists.mutable.empty());
 

Example using an anonymous inner class:

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

Specified by:

selectWith in interface RichIterable<K>

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

targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the select criteria

See Also:

• RichIterable.select(Predicate)
• RichIterable.select(Predicate, Collection)

reject

public <R extends Collection<V>> R reject(Predicate<? super V> predicate,
 R target)

Description copied from interface: RichIterable

Same as the reject method with one parameter but uses the specified target collection for the results.

Example using a Java 8 lambda expression:

 MutableList<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
 

Specified by:

reject in interface RichIterable<K>

Parameters:

predicate - a Predicate to use as the reject criteria

target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

target, which contains appended elements as a result of the reject criteria

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>

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>

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)

rejectWith

public <P,
R extends Collection<V>> R rejectWith(Predicate2<? super V,? super P> predicate,
 P parameter,
 R targetCollection)

Description copied from interface: RichIterable

Similar to RichIterable.reject(Predicate, Collection), 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:

 MutableList<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18), Lists.mutable.empty());
 

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), Lists.mutable.empty());
 

Specified by:

rejectWith in interface RichIterable<K>

Parameters:

predicate - a Predicate2 to use as the reject criteria

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

targetCollection - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

targetCollection, which contains appended elements as a result of the reject criteria

See Also:

• RichIterable.reject(Predicate)
• RichIterable.reject(Predicate, Collection)

toArray

public Object[] toArray()

Description copied from interface: RichIterable

Converts this iterable to an array.

Specified by:

toArray in interface RichIterable<K>

See Also:

• Collection.toArray()

toArray

public <T> T[] toArray(T[] a)

Description copied from interface: RichIterable

Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.

Specified by:

toArray in interface RichIterable<K>

See Also:

• Collection.toArray(Object[])

zip

public <S,
R extends Collection<Pair<V,
S>>> R zip(Iterable<S> that,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.zip(Iterable) but uses target for output.

Specified by:

zip in interface OrderedIterable<K>

Specified by:

zip in interface RichIterable<K>

zipWithIndex

public <R extends Collection<Pair<V,
Integer>>> R zipWithIndex(R target)

Description copied from interface: RichIterable

Same as RichIterable.zipWithIndex() but uses target for output.

Specified by:

zipWithIndex in interface OrderedIterable<K>

Specified by:

zipWithIndex in interface RichIterable<K>

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>

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>

collectBoolean

public <R extends MutableBooleanCollection> R collectBoolean(BooleanFunction<? super V> booleanFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 BooleanArrayList licenses =
     people.collectBoolean(person -> person.hasDrivingLicense(), new BooleanArrayList());
 

Example using an anonymous inner class:

 BooleanArrayList licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     }, new BooleanArrayList());
 

Specified by:

collectBoolean in interface RichIterable<K>

Parameters:

booleanFunction - a BooleanFunction to use as the collect transformation function

target - the MutableBooleanCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

flatCollectBoolean

public <R extends MutableBooleanCollection> R flatCollectBoolean(Function<? super V,? extends BooleanIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectBoolean in interface RichIterable<K>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

• RichIterable.flatCollect(Function)

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>

collectByte

public <R extends MutableByteCollection> R collectByte(ByteFunction<? super V> byteFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 ByteArrayList bytes =
     people.collectByte(person -> person.getCode(), new ByteArrayList());
 

Example using an anonymous inner class:

 ByteArrayList bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     }, new ByteArrayList());
 

Specified by:

collectByte in interface RichIterable<K>

Parameters:

byteFunction - a ByteFunction to use as the collect transformation function

target - the MutableByteCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

flatCollectByte

public <R extends MutableByteCollection> R flatCollectByte(Function<? super V,? extends ByteIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectByte in interface RichIterable<K>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

• RichIterable.flatCollect(Function)

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>

collectChar

public <R extends MutableCharCollection> R collectChar(CharFunction<? super V> charFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 CharArrayList chars =
     people.collectChar(person -> person.getMiddleInitial(), new CharArrayList());
 

Example using an anonymous inner class:

 CharArrayList chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     }, new CharArrayList());
 

Specified by:

collectChar in interface RichIterable<K>

Parameters:

charFunction - a CharFunction to use as the collect transformation function

target - the MutableCharCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

flatCollectChar

public <R extends MutableCharCollection> R flatCollectChar(Function<? super V,? extends CharIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectChar in interface RichIterable<K>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

• RichIterable.flatCollect(Function)

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>

collectDouble

public <R extends MutableDoubleCollection> R collectDouble(DoubleFunction<? super V> doubleFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 DoubleArrayList doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole(), new DoubleArrayList());
 

Example using an anonymous inner class:

 DoubleArrayList doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     }, new DoubleArrayList());
 

Specified by:

collectDouble in interface RichIterable<K>

Parameters:

doubleFunction - a DoubleFunction to use as the collect transformation function

target - the MutableDoubleCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

flatCollectDouble

public <R extends MutableDoubleCollection> R flatCollectDouble(Function<? super V,? extends DoubleIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectDouble in interface RichIterable<K>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

• RichIterable.flatCollect(Function)

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>

collectFloat

public <R extends MutableFloatCollection> R collectFloat(FloatFunction<? super V> floatFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 FloatArrayList floats =
     people.collectFloat(person -> person.getHeightInInches(), new FloatArrayList());
 

Example using an anonymous inner class:

 FloatArrayList floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     }, new FloatArrayList());
 

Specified by:

collectFloat in interface RichIterable<K>

Parameters:

floatFunction - a FloatFunction to use as the collect transformation function

target - the MutableFloatCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

flatCollectFloat

public <R extends MutableFloatCollection> R flatCollectFloat(Function<? super V,? extends FloatIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectFloat in interface RichIterable<K>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

• RichIterable.flatCollect(Function)

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>

collectInt

public <R extends MutableIntCollection> R collectInt(IntFunction<? super V> intFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 IntArrayList ints =
     people.collectInt(person -> person.getAge(), new IntArrayList());
 

Example using an anonymous inner class:

 IntArrayList ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     }, new IntArrayList());
 

Specified by:

collectInt in interface RichIterable<K>

Parameters:

intFunction - a IntFunction to use as the collect transformation function

target - the MutableIntCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

flatCollectInt

public <R extends MutableIntCollection> R flatCollectInt(Function<? super V,? extends IntIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectInt in interface RichIterable<K>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

• RichIterable.flatCollect(Function)

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>

collectLong

public <R extends MutableLongCollection> R collectLong(LongFunction<? super V> longFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 LongArrayList longs =
     people.collectLong(person -> person.getGuid(), new LongArrayList());
 

Example using an anonymous inner class:

 LongArrayList longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     }, new LongArrayList());
 

Specified by:

collectLong in interface RichIterable<K>

Parameters:

longFunction - a LongFunction to use as the collect transformation function

target - the MutableLongCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

flatCollectLong

public <R extends MutableLongCollection> R flatCollectLong(Function<? super V,? extends LongIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectLong in interface RichIterable<K>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

• RichIterable.flatCollect(Function)

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>

collectShort

public <R extends MutableShortCollection> R collectShort(ShortFunction<? super V> shortFunction,
 R target)

Description copied from interface: RichIterable

Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.

Example using a Java 8 lambda expression:

 ShortArrayList shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth, new ShortArrayList());
 

Example using an anonymous inner class:

 ShortArrayList shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth;
         }
     }, new ShortArrayList());
 

Specified by:

collectShort in interface RichIterable<K>

Parameters:

shortFunction - a ShortFunction to use as the collect transformation function

target - the MutableShortCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

flatCollectShort

public <R extends MutableShortCollection> R flatCollectShort(Function<? super V,? extends ShortIterable> function,
 R target)

Description copied from interface: RichIterable

Same as flatCollect, only the results are collected into the target collection.

Specified by:

flatCollectShort in interface RichIterable<K>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

• RichIterable.flatCollect(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 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>

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>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

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>

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>

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>

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>

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.

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>

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)

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>

Overrides:

keySet in class UnmodifiableMap<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>

Overrides:

values in class UnmodifiableMap<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>

Overrides:

headMap in class UnmodifiableSortedMap<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>

Overrides:

tailMap in class UnmodifiableSortedMap<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>

Overrides:

subMap in class UnmodifiableSortedMap<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>

Overrides:

entrySet in class UnmodifiableMap<K,V>

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

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>