UnmodifiableTreeMap (GS Collections

java.lang.Object
- com.gs.collections.impl.UnmodifiableMap<K,V>
- - com.gs.collections.impl.map.sorted.mutable.UnmodifiableSortedMap<K,V>
 - - com.gs.collections.impl.map.sorted.mutable.UnmodifiableTreeMap<K,V>

All Implemented Interfaces:

InternalIterable<V>, MapIterable<K,V>, MutableSortedMap<K,V>, SortedMapIterable<K,V>, RichIterable<V>, Serializable, Cloneable, Iterable<V>, Map<K,V>, SortedMap<K,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,V>

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<K2,V2> MutableMap<K2,V2>`	`aggregateBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)` Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
`<K2,V2> MutableMap<K2,V2>`	`aggregateInPlaceBy(Function<? super V,? extends K2> groupBy, Function0<? extends V2> zeroValueFactory, Procedure2<? super V2,? super V> mutatingAggregator)` Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
`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).
`MutableSortedMap<K,V>`	`asSynchronized()` Returns a synchronized (thread-safe) map backed by the specified 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 collect with a `Function2` and specified parameter which is passed to the block
`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.
`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.
`<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.
`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.
`MutableSortedSetMultimap<V,K>`	`flip()` Given a map from Domain -> Range return a multimap from Range -> Domain.
`MapIterable<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(Procedure<? super V> procedure)` The procedure is executed for each element in the iterable.
`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(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)` 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, and put that 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.
`<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 he results of these evaluations are collected into a new map, where the transformed value is the key.
`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.
`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.
`<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.
`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.
`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.
`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.
`<P> PartitionMutableList<V>`	`partitionWith(Predicate2<? super V,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`MutableList<V>`	`reject(Predicate<? super V> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`<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`.
`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)`
`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)`
`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.
`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.
`MutableSet<V>`	`toSet()` Converts the collection to a MutableSet implementation.
`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.
`<R extends Comparable<? super R>> MutableList<V>`	`toSortedListBy(Function<? super V,? extends R> function)` Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by `function`.
`<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.
`<R extends Comparable<? super R>> MutableSortedSet<V>`	`toSortedSetBy(Function<? super V,? extends R> function)` Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by `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)`
`<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 com.gs.collections.impl.map.sorted.mutable.UnmodifiableSortedMap
comparator, firstKey, lastKey

Methods inherited from class com.gs.collections.impl.UnmodifiableMap
clear, containsKey, containsValue, get, isEmpty, put, putAll, remove, size, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.gs.collections.api.map.sorted.SortedMapIterable
comparator

Methods inherited from interface com.gs.collections.api.map.MapIterable
containsKey, containsValue, get, toString

Methods inherited from interface com.gs.collections.api.RichIterable
isEmpty, size

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface java.util.SortedMap
comparator, firstKey, lastKey

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

- Method Detail
 - 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-GS-SortedMap and first adapt it will a SortedMapAdapter, and then return a UnmodifiableSortedMap that wraps the adapter.
 - removeKey
```
public V removeKey(K key)
```
 Description copied from interface: MutableSortedMap
 
 Remove an entry from the map at the specified key.
 
 Specified by:
 
 removeKey in interface MutableSortedMap<K,V>
 
 Returns:
 
 The value removed from entry at key, or null if not found.
 
 See Also:
 
 Map.remove(Object)
 - with
```
public MutableSortedMap<K,V> with(Pair<K,V>... pairs)
```
 Specified by:
 
 with in interface MutableSortedMap<K,V>
 - collectKeysAndValues
```
public <E> MutableSortedMap<K,V> collectKeysAndValues(Iterable<E> iterable,
 Function<? super E,? extends K> keyFunction,
 Function<? super E,? extends V> 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: 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 Function0, and put that value in the map at the specified key.
 
 Specified by:
 
 getIfAbsentPut in interface MutableSortedMap<K,V>
 - getIfAbsentPutWithKey
```
public V getIfAbsentPutWithKey(K key,
 Function<? super K,? extends V> function)
```
 Description copied from interface: MutableSortedMap
 
 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 MutableSortedMap<K,V>
 - getIfAbsentPutWith
```
public  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 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  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 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>
 
 Overrides:
 
 clone in class Object
 - asUnmodifiable
```
public MutableSortedMap<K,V> asUnmodifiable()
```
 Description copied from interface: MutableSortedMap
 
 Returns an unmodifiable view of this map. This method allows modules to provide users with "read-only" access to internal maps. Any query operations on the returned map that "read through" to this map and attempt to modify the returned map, whether direct or via its iterator, result in an UnsupportedOperationException.
 The returned map will be Serializable if this map is Serializable.
 
 Specified by:
 
 asUnmodifiable in interface MutableSortedMap<K,V>
 
 Returns:
 
 an unmodifiable view of this map.
 - asSynchronized
```
public MutableSortedMap<K,V> asSynchronized()
```
 Description copied from interface: MutableSortedMap
 Returns a synchronized (thread-safe) map backed by the specified map. In order to guarantee serial access, it is critical that all access to the backing map is accomplished through the returned map.
 
 It is imperative that the user manually synchronize on the returned map when iterating over any of its collection views:
```
 MutableMap map = myMutableMap.asSynchronized();
 ...
 Set set = map.keySet(); // Needn't be in synchronized block
 ...
 synchronized(map)
 { // Synchronizing on map, not set!
 Iterator i = s.iterator(); // Must be in synchronized block
 while (i.hasNext())
 foo(i.next());
 }
 
```
 Failure to follow this advice may result in non-deterministic behavior.
 The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.
```
 MutableMap map = myMutableMap.asSynchronized();
 ...
 Set set = map.keySet(); // Needn't be in synchronized block
 ...
 Iterate.forEach(set, new Procedure()
 {
 public void value(Object each)
 {
 ...
 }
 });
 
```
 The returned map will be serializable if the specified map is serializable.
 Specified by:
 
 asSynchronized in interface MutableSortedMap<K,V>
 - toImmutable
```
public ImmutableSortedMap<K,V> toImmutable()
```
 Description copied from interface: MutableSortedMap
 
 Returns an immutable copy of this map. If the map is immutable, it returns itself.
 The returned map will be Serializable if this map is Serializable.
 
 Specified by:
 
 toImmutable in interface MutableSortedMap<K,V>
 
 Specified by:
 
 toImmutable in interface SortedMapIterable<K,V>
 - iterator
```
public Iterator<V> iterator()
```
 Specified by:
 
 iterator in interface Iterable<V>
 - hashCode
```
public int hashCode()
```
 Description copied from interface: MapIterable
 
 Follows the same general contract as Map.hashCode().
 
 Specified by:
 
 hashCode in interface MapIterable<K,V>
 
 Specified by:
 
 hashCode in interface Map<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 MapIterable<K,V>
 
 Specified by:
 
 equals in interface Map<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 MutableSortedMap<K,V>
 - notEmpty
```
public boolean notEmpty()
```
 Description copied from interface: RichIterable
 
 The English equivalent of !this.isEmpty()
 
 Specified by:
 
 notEmpty in interface RichIterable<V>
 - 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(new Procedure2<Integer, String>()
 {
 public void value(final Integer key, final String value)
 {
 collection.add(String.valueOf(key) + value);
 }
 });
 Verify.assertContainsAll(collection, "1One", "2Two", "3Three");
 
```
 Specified by:
 
 forEachKeyValue in interface MapIterable<K,V>
 - flipUniqueValues
```
public MapIterable<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 map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
 MapIterable result = map.flipUniqueValues();
 Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
 
```
 Specified by:
 
 flipUniqueValues in interface MapIterable<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>
 - forEach
```
public void forEach(Procedure<? super V> procedure)
```
 Description copied from interface: InternalIterable
 The procedure is executed for each element in the iterable.
```
e.g.
 people.forEach(new Procedure()
 {
 public void value(Person person)
 {
 LOGGER.info(person.getName());
 }
 });
 
```
 Specified by:
 
 forEach in interface InternalIterable<V>
 - 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
```
e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
 public void value(Person person, int index)
 {
 LOGGER.info("Index: " + index + " person: " + person.getName());
 }
 });
 
```
 Specified by:
 
 forEachWithIndex in interface InternalIterable<V>
 - forEachWith
```
public  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.
```
e.g.
 people.forEachWith(new Procedure2()
 {
 public void value(Person person, Person other)
 {
 if (person.isRelatedTo(other))
 {
 LOGGER.info(person.getName());
 }
 }
 }, fred);
 
```
 Specified by:
 
 forEachWith in interface InternalIterable<V>
 - collectValues
```
public <R> MutableSortedMap<K,R> collectValues(Function2<? super K,? super V,? extends R> function)
```
 Description copied from interface: MapIterable
 For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.
```
e.g.
 peopleByCity.collectValues(new Function2<City, Person, String>()
 {
 public String value(City city, Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 });
 
```
 Specified by:
 
 collectValues in interface MapIterable<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.
```
e.g.
 peopleByCity.collect(new Function2<City, Person, String>()
 {
 public String value(City city, Person person)
 {
 return Pair.of(city.getCountry(), person.getAddress().getCity());
 }
 });
 
```
 Specified by:
 
 collect in interface MapIterable<K,V>
 
 Specified by:
 
 collect in interface MutableSortedMap<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.
```
e.g.
 peopleByCity.select(new Predicate2<City, Person>()
 {
 public boolean accept(City city, Person person)
 {
 return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
 }
 });
 
```
 Specified by:
 
 select in interface MapIterable<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.
```
e.g.
 peopleByCity.reject(new Predicate2<City, Person>()
 {
 public boolean accept(City city, Person person)
 {
 return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
 }
 });
 
```
 Specified by:
 
 reject in interface MapIterable<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 of 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.
```
e.g.
 peopleByCity.detect(new Predicate2<City, Person>()
 {
 public boolean accept(City city, Person person)
 {
 return city.getName().equals("Anytown") && person.getLastName().equals("Smith");
 }
 });
 
```
 Specified by:
 
 detect 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<V>
 - anySatisfyWith
```
public  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<V>
 - 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<V>
 - allSatisfyWith
```
public  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<V>
 - 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<V>
 - noneSatisfyWith
```
public  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<V>
 - 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<V>
 - 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<V>
 - 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<V>
 - toBag
```
public MutableBag<V> toBag()
```
 Description copied from interface: RichIterable
 
 Converts the collection to the default MutableBag implementation.
 
 Specified by:
 
 toBag in interface RichIterable<V>
 - 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<V>
 - toList
```
public MutableList<V> toList()
```
 Description copied from interface: RichIterable
 
 Converts the collection to a MutableList implementation.
 
 Specified by:
 
 toList in interface RichIterable<V>
 - 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<V>
 - 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<V>
 - 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<V>
 - toSet
```
public MutableSet<V> toSet()
```
 Description copied from interface: RichIterable
 
 Converts the collection to a MutableSet implementation.
 
 Specified by:
 
 toSet in interface RichIterable<V>
 - 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<V>
 - 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<V>
 - toSortedListBy
```
public <R extends Comparable<? super R>> MutableList<V> toSortedListBy(Function<? super V,? extends R> function)
```
 Description copied from interface: RichIterable
 
 Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by function.
 
 Specified by:
 
 toSortedListBy in interface RichIterable<V>
 - 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<V>
 - 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<V>
 - toSortedSetBy
```
public <R extends Comparable<? super R>> MutableSortedSet<V> toSortedSetBy(Function<? super V,? extends R> function)
```
 Description copied from interface: RichIterable
 
 Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.
 
 Specified by:
 
 toSortedSetBy in interface RichIterable<V>
 - 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<V>
 
 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.
```
e.g.
 return people.collect(new Function<Person, String>()
 {
 public String valueOf(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 }, Lists.mutable.of());
 
```
 Specified by:
 
 collect in interface RichIterable<V>
 
 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<V>
 
 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 collect with a Function2 and specified parameter which is passed to the block
```
e.g.
 Function2 addParameterFunction =
 new Function2()
 {
 public Integer value(final Integer each, final Integer parameter)
 {
 return each + parameter;
 }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 
```
 Specified by:
 
 collectWith in interface MutableSortedMap<K,V>
 
 Specified by:
 
 collectWith in interface RichIterable<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.
```
e.g.
 Function2 addParameterFunction =
 new Function2()
 {
 public Integer value(final Integer each, final Integer parameter)
 {
 return each + parameter;
 }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), UnifiedSet.newSet());
 
```
 Specified by:
 
 collectWith in interface RichIterable<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
 
 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
 - 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<V>
 - 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<V>
 - 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<V>
 - 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<V>
 
 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.
```
e.g.
 return people.count(new Predicate<Person>()
 {
 public boolean value(Person person)
 {
 return person.getAddress().getState().getName().equals("New York");
 }
 });
 
```
 Specified by:
 
 count in interface RichIterable<V>
 - countWith
```
public  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(PredicatesLite.equal(), "Smith");
 
```
 Specified by:
 
 countWith in interface RichIterable<V>
 - 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.
```
e.g.
 return people.detect(new Predicate<Person>()
 {
 public boolean value(Person person)
 {
 return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
 }
 });
 
```
 Specified by:
 
 detect in interface RichIterable<V>
 - detectWith
```
public  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.
```
e.g.
 people.detectWith(new Predicate2<Person, String>()
 {
 public boolean value(Person person, String fullName)
 {
 return person.getFullName().equals(fullName);
 }
 }, "John Smith");
 
```
 Specified by:
 
 detectWith in interface RichIterable<V>
 - 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<V>
 - detectWithIfNone
```
public  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<V>
 - 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<V>
 
 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 RichIterable<V>
 - 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 RichIterable<V>
 - 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.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
 public String value(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 });
 
```
 Specified by:
 
 groupBy in interface MutableSortedMap<K,V>
 
 Specified by:
 
 groupBy in interface SortedMapIterable<K,V>
 
 Specified by:
 
 groupBy in interface RichIterable<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.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
 public String value(Person person)
 {
 return person.getFirstName() + " " + person.getLastName();
 }
 }, new FastListMultimap<String, Person>());
 
```
 Specified by:
 
 groupBy in interface RichIterable<V>
 - 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 MutableSortedMap<K,V>
 
 Specified by:
 
 groupByEach in interface SortedMapIterable<K,V>
 
 Specified by:
 
 groupByEach in interface RichIterable<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<V>
 - groupByUniqueKey
```
public <VV> MutableMap<VV,V> groupByUniqueKey(Function<? super V,? extends VV> function)
```
 Description copied from interface: RichIterable
 
 For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key. The generated keys must each be unique, or else an exception is thrown.
 
 Specified by:
 
 groupByUniqueKey in interface MutableSortedMap<K,V>
 
 Specified by:
 
 groupByUniqueKey in interface RichIterable<V>
 
 See Also:
 
 RichIterable.groupBy(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<V>
 - 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<V>
 - 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<V>
 - 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<V>
 - 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<V>
 - 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<V>
 - 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.
 
 Specified by:
 
 sumOfFloat in interface RichIterable<V>
 - 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<V>
 - 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.
 
 Specified by:
 
 sumOfDouble in interface RichIterable<V>
 - 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<V>
 
 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<V>
 
 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. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings as by String.valueOf(Object).
 
 Specified by:
 
 makeString in interface RichIterable<V>
 
 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 RichIterable<V>
 - 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<V>
 - 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<V>
 - 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 RichIterable<V>
 - 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<V>
 - 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<V>
 - 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.
```
e.g.
 return people.select(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.getAddress().getCity().equals("Metuchen");
 }
 });
 
```
 Specified by:
 
 select in interface MutableSortedMap<K,V>
 
 Specified by:
 
 select in interface SortedMapIterable<K,V>
 
 Specified by:
 
 select in interface RichIterable<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.
```
e.g.
 return people.select(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 }, Lists.mutable.of());
 
```
```
e.g.
 return collection.select(Predicates.attributeEqual("lastName", "Smith"), new ArrayList());
 
```
 Specified by:
 
 select in interface RichIterable<V>
 
 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  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.
 
 Specified by:
 
 selectWith in interface MutableSortedMap<K,V>
 
 Specified by:
 
 selectWith in interface SortedMapIterable<K,V>
 
 Specified by:
 
 selectWith in interface RichIterable<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.
 
 Specified by:
 
 selectWith in interface RichIterable<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
 
 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.
```
e.g.
 return people.reject(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 }, Lists.mutable.of());
 
```
 Specified by:
 
 reject in interface RichIterable<V>
 
 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)).
```
e.g.
 return people.reject(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.person.getLastName().equals("Smith");
 }
 });
 
```
```
e.g.
 return people.reject(Predicates.attributeEqual("lastName", "Smith"));
 
```
 Specified by:
 
 reject in interface MutableSortedMap<K,V>
 
 Specified by:
 
 reject in interface SortedMapIterable<K,V>
 
 Specified by:
 
 reject in interface RichIterable<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  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.
 
 Specified by:
 
 rejectWith in interface MutableSortedMap<K,V>
 
 Specified by:
 
 rejectWith in interface SortedMapIterable<K,V>
 
 Specified by:
 
 rejectWith in interface RichIterable<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 a height greater than 100cm
```
 return people.reject(new Predicate2<Person, Integer>()
 {
 public boolean accept(Person p, Integer i)
 {
 return p.getHeightInCm() < i.intValue();
 }
 }, Integer.valueOf(100), FastList.newList());
 
```
 Specified by:
 
 rejectWith in interface RichIterable<V>
 
 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<V>
 
 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<V>
 
 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 RichIterable<V>
 - 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 RichIterable<V>
 - collect
```
public <R> MutableList<R> collect(Function<? super V,? extends R> function)
```
 Description copied from interface: RichIterable
 Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
```
e.g.
 return 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 RichIterable<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.
```
e.g.
 return 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 RichIterable<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.
```
e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
 public boolean booleanValueOf(Person person)
 {
 return person.hasDrivingLicense();
 }
 }, new BooleanArrayList());
 
```
 Specified by:
 
 collectBoolean in interface RichIterable<V>
 
 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
 - 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.
```
e.g.
 return 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 RichIterable<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.
```
e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
 public byte byteValueOf(Person person)
 {
 return person.getCode();
 }
 }, new ByteArrayList());
 
```
 Specified by:
 
 collectByte in interface RichIterable<V>
 
 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
 - 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.
```
e.g.
 return 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 RichIterable<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.
```
e.g.
 return people.collectChar(new CharFunction<Person>()
 {
 public char charValueOf(Person person)
 {
 return person.getMiddleInitial();
 }
 }, new CharArrayList());
 
```
 Specified by:
 
 collectChar in interface RichIterable<V>
 
 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
 - 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.
```
e.g.
 return 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 RichIterable<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.
```
e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
 public double doubleValueOf(Person person)
 {
 return person.getMilesFromNorthPole();
 }
 }, new DoubleArrayList());
 
```
 Specified by:
 
 collectDouble in interface RichIterable<V>
 
 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
 - 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.
```
e.g.
 return 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 RichIterable<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.
```
e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
 public float floatValueOf(Person person)
 {
 return person.getHeightInInches();
 }
 }, new FloatArrayList());
 
```
 Specified by:
 
 collectFloat in interface RichIterable<V>
 
 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
 - 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.
```
e.g.
 return 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 RichIterable<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.
```
e.g.
 return people.collectInt(new IntFunction<Person>()
 {
 public int intValueOf(Person person)
 {
 return person.getAge();
 }
 }, new IntArrayList());
 
```
 Specified by:
 
 collectInt in interface RichIterable<V>
 
 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
 - 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.
```
e.g.
 return 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 RichIterable<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.
```
e.g.
 return people.collectLong(new LongFunction<Person>()
 {
 public long longValueOf(Person person)
 {
 return person.getGuid();
 }
 }, new LongArrayList());
 
```
 Specified by:
 
 collectLong in interface RichIterable<V>
 
 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
 - 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.
```
e.g.
 return 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 RichIterable<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.
```
e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
 public short shortValueOf(Person person)
 {
 return person.getNumberOfJunkMailItemsReceivedPerMonth;
 }
 }, new ShortArrayList());
 
```
 Specified by:
 
 collectShort in interface RichIterable<V>
 
 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
 - collectIf
```
public <R> MutableList<R> collectIf(Predicate<? super V> predicate,
 Function<? super V,? extends R> function)
```
 Description copied from interface: RichIterable
 Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).
```
e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 
```
 Specified by:
 
 collectIf in interface MutableSortedMap<K,V>
 
 Specified by:
 
 collectIf in interface RichIterable<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 = new Function<Person, List<Address>>()
 {
 public List<Address> valueOf(Person person)
 {
 return person.getAddresses();
 }
 };
 MutableList<Person> people = ...;
 
```
 Using collect returns a collection of collections of addresses.
```
 MutableList<List<Address>> addresses = people.collect(addressFunction);
 
```
 Using flatCollect returns a single flattened list of addresses.
```
 MutableList<Address> addresses = people.flatCollect(addressFunction);
 
```
 Specified by:
 
 flatCollect in interface MutableSortedMap<K,V>
 
 Specified by:
 
 flatCollect in interface RichIterable<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.
```
e.g.
 return people.partition(new Predicate<Person>()
 {
 public boolean accept(Person person)
 {
 return person.getAddress().getState().getName().equals("New York");
 }
 });
 
```
 Specified by:
 
 partition in interface MutableSortedMap<K,V>
 
 Specified by:
 
 partition in interface SortedMapIterable<K,V>
 
 Specified by:
 
 partition in interface RichIterable<V>
 - partitionWith
```
public  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.
```
e.g.
 return 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 RichIterable<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.
 
 Specified by:
 
 selectInstancesOf in interface MutableSortedMap<K,V>
 
 Specified by:
 
 selectInstancesOf in interface SortedMapIterable<K,V>
 
 Specified by:
 
 selectInstancesOf in interface RichIterable<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 MutableSortedMap<K,V>
 
 Specified by:
 
 zip in interface SortedMapIterable<K,V>
 
 Specified by:
 
 zip in interface RichIterable<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 MutableSortedMap<K,V>
 
 Specified by:
 
 zipWithIndex in interface SortedMapIterable<K,V>
 
 Specified by:
 
 zipWithIndex in interface RichIterable<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 MutableSortedMap<K,V>
 
 Specified by:
 
 keySet in interface Map<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 MutableSortedMap<K,V>
 
 Specified by:
 
 values in interface Map<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 MutableSortedMap<K,V>
 
 Specified by:
 
 entrySet in interface Map<K,V>
 
 Specified by:
 
 entrySet in interface SortedMap<K,V>
 
 Overrides:
 
 entrySet in class UnmodifiableMap<K,V>
 - aggregateInPlaceBy
```
public <K2,V2> MutableMap<K2,V2> aggregateInPlaceBy(Function<? super V,? extends K2> groupBy,
 Function0<? extends V2> zeroValueFactory,
 Procedure2<? super V2,? super V> mutatingAggregator)
```
 Description copied from interface: RichIterable
 
 Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).
 
 Specified by:
 
 aggregateInPlaceBy in interface MutableSortedMap<K,V>
 
 Specified by:
 
 aggregateInPlaceBy in interface RichIterable<V>
 - aggregateBy
```
public <K2,V2> MutableMap<K2,V2> aggregateBy(Function<? super V,? extends K2> groupBy,
 Function0<? extends V2> zeroValueFactory,
 Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)
```
 Description copied from interface: RichIterable
 
 Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).
 
 Specified by:
 
 aggregateBy in interface MutableSortedMap<K,V>
 
 Specified by:
 
 aggregateBy in interface RichIterable<V>

Class UnmodifiableTreeMap<K,V>

Nested Class Summary

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

Method Summary

Methods inherited from class com.gs.collections.impl.map.sorted.mutable.UnmodifiableSortedMap

Methods inherited from class com.gs.collections.impl.UnmodifiableMap

Methods inherited from class java.lang.Object

Methods inherited from interface com.gs.collections.api.map.sorted.SortedMapIterable

Methods inherited from interface com.gs.collections.api.map.MapIterable

Methods inherited from interface com.gs.collections.api.RichIterable

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Method Detail

of

removeKey

with

collectKeysAndValues

getIfAbsentPut

getIfAbsentPutWithKey

getIfAbsentPutWith

getIfAbsent

getIfAbsentValue

getIfAbsentWith

flip

clone

asUnmodifiable

asSynchronized

toImmutable

iterator

hashCode

equals

keysView

valuesView

keyValuesView

newEmpty

notEmpty

forEachValue

forEachKey

forEachKeyValue

flipUniqueValues

ifPresentApply

forEach

forEachWithIndex

forEachWith

collectValues

collect

select

reject

detect

anySatisfy

anySatisfyWith

allSatisfy

allSatisfyWith

noneSatisfy

noneSatisfyWith

appendString

appendString

appendString

toBag

asLazy

toList

toMap

toSortedMap

toSortedMap

toSet

toSortedList

toSortedList

toSortedListBy

toSortedSet

toSortedSet

toSortedSetBy

chunk

collect

collectIf

collectWith

collectWith

contains

containsAllArguments

containsAllIterable