AbstractMutableSortedMap (Eclipse Collections

java.lang.Object
- org.eclipse.collections.impl.AbstractRichIterable<V>
- - org.eclipse.collections.impl.map.AbstractMapIterable<K,V>
  - - org.eclipse.collections.impl.map.mutable.AbstractMutableMapIterable<K,V>
    - - org.eclipse.collections.impl.map.sorted.mutable.AbstractMutableSortedMap<K,V>

All Implemented Interfaces:

Cloneable, Iterable<V>, Map<K,V>, SortedMap<K,V>, InternalIterable<V>, MapIterable<K,V>, MutableMapIterable<K,V>, MutableSortedMap<K,V>, SortedMapIterable<K,V>, OrderedIterable<V>, ReversibleIterable<V>, RichIterable<V>

Direct Known Subclasses:

SortedMapAdapter, TreeSortedMap
```
public abstract class AbstractMutableSortedMap<K,V>
extends AbstractMutableMapIterable<K,V>
implements MutableSortedMap<K,V>
```

Nested Class Summary
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

AbstractMutableSortedMap()

Constructors
Constructor and Description
`AbstractMutableSortedMap()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`LazyIterable<V>`	`asReversed()` Returns a reversed view of this ReversibleIterable.
`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.
`abstract 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.
`MutableBooleanList`	`collectBoolean(BooleanFunction<? super V> booleanFunction)` Returns a new primitive `boolean` iterable with the results of applying the specified function on each element of the source collection.
`MutableByteList`	`collectByte(ByteFunction<? super V> byteFunction)` Returns a new primitive `byte` iterable with the results of applying the specified function on each element of the source collection.
`MutableCharList`	`collectChar(CharFunction<? super V> charFunction)` Returns a new primitive `char` iterable with the results of applying the specified function on each element of the source collection.
`MutableDoubleList`	`collectDouble(DoubleFunction<? super V> doubleFunction)` Returns a new primitive `double` iterable with the results of applying the specified function on each element of the source collection.
`MutableFloatList`	`collectFloat(FloatFunction<? super V> floatFunction)` Returns a new primitive `float` iterable with the results of applying the specified function on each element of the source collection.
`<R> MutableList<R>`	`collectIf(Predicate<? super V> predicate, Function<? super V,? extends R> function)` Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
`MutableIntList`	`collectInt(IntFunction<? super V> intFunction)` Returns a new primitive `int` iterable with the results of applying the specified function on each element of the source collection.
`<E> MutableSortedMap<K,V>`	`collectKeysAndValues(Iterable<E> iterable, Function<? super E,? extends K> keyFunction, Function<? super E,? extends V> 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.
`MutableShortList`	`collectShort(ShortFunction<? super V> shortFunction)` Returns a new primitive `short` iterable with the results of applying the specified function on each element of the source collection.
`<R> MutableSortedMap<K,R>`	`collectValues(Function2<? super K,? super V,? extends R> function)` For each key and value of the map the function is evaluated.
`<P,VV> MutableList<VV>`	`collectWith(Function2<? super V,? super P,? extends VV> function, P parameter)` Same as `RichIterable.collect(Function)` with a `Function2` and specified parameter which is passed to the block.
`<S> boolean`	`corresponds(OrderedIterable<S> other, Predicate2<? super V,? super S> predicate)` Returns true if both OrderedIterables have the same length and `predicate` returns true for all corresponding elements e1 of this `OrderedIterable` and e2 of `other`.
`int`	`detectIndex(Predicate<? super V> predicate)` Returns the index of the first element of the `OrderedIterable` for which the `predicate` evaluates to true.
`int`	`detectLastIndex(Predicate<? super V> predicate)` Returns the index of the last element of the `ReversibleIterable` for which the `predicate` evaluates to true.
`<R> MutableList<R>`	`flatCollect(Function<? super V,? extends Iterable<R>> function)` `flatCollect` is a special case of `RichIterable.collect(Function)`.
`MutableSortedSetMultimap<V,K>`	`flip()` Given a map from Domain -> Range return a multimap from Range -> Domain.
`void`	`forEach(int startIndex, int endIndex, Procedure<? super V> procedure)` Iterates over the section of the iterable covered by the specified inclusive indexes.
`void`	`forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super V> objectIntProcedure)` Iterates over the section of the iterable covered by the specified inclusive indexes.
`<VV> MutableListMultimap<VV,V>`	`groupBy(Function<? super V,? extends VV> function)` For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
`<VV> MutableListMultimap<VV,V>`	`groupByEach(Function<? super V,? extends Iterable<VV>> function)` Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`int`	`indexOf(Object object)` Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
`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.
`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`.
`void`	`reverseForEach(Procedure<? super V> procedure)` Evaluates the procedure for each element of the list iterating in reverse order.
`MutableList<V>`	`select(Predicate<? super V> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`MutableSortedMap<K,V>`	`select(Predicate2<? super K,? super V> predicate)` For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.
`<S> MutableList<S>`	`selectInstancesOf(Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> MutableList<V>`	`selectWith(Predicate2<? super V,? super P> predicate, P parameter)` Similar to `RichIterable.select(Predicate)`, except with an evaluation parameter for the second generic argument in `Predicate2`.
`MutableSortedMap<K,V>`	`tap(Procedure<? super V> procedure)` Executes the Procedure for each value of the map and returns `this`.
`ImmutableSortedMap<K,V>`	`toImmutable()` Returns an immutable copy of this map.
`MutableStack<V>`	`toStack()` Converts the OrderedIterable to a mutable MutableStack implementation.
`MutableSortedMap<K,V>`	`with(Pair<K,V>... pairs)` Deprecated. in 6.0 Use `withAllKeyValueArguments(Pair[])` instead. Inlineable.
`MutableSortedMap<K,V>`	`withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValues)` Convenience var-args version of withAllKeyValues
`MutableSortedMap<K,V>`	`withAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)` This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
`MutableSortedMap<K,V>`	`withKeyValue(K key, V value)` This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements.
`MutableSortedMap<K,V>`	`withoutAllKeys(Iterable<? extends K> keys)` This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.
`MutableSortedMap<K,V>`	`withoutKey(K key)` This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements.
`<S> MutableList<Pair<V,S>>`	`zip(Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`MutableList<Pair<V,Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

Methods inherited from class org.eclipse.collections.impl.map.mutable.AbstractMutableMapIterable
add, aggregateBy, aggregateInPlaceBy, collect, detect, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWith, getIfAbsentPutWithKey, groupByUniqueKey, iterator, keysView, keyValuesView, updateValue, updateValueWith, valuesView

Methods inherited from class org.eclipse.collections.impl.map.AbstractMapIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asLazy, chunk, contains, detect, detectIfNone, detectWith, detectWithIfNone, each, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, ifPresentApply, noneSatisfy, noneSatisfyWith, toArray, toArray

Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable
appendString, appendString, appendString, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, notEmpty, reject, rejectWith, select, selectWith, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

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

Methods inherited from interface org.eclipse.collections.api.map.sorted.MutableSortedMap
aggregateBy, aggregateInPlaceBy, collect, distinct, drop, dropWhile, entrySet, getIfAbsentPutWith, groupByUniqueKey, headMap, keySet, newEmpty, partitionWhile, subMap, tailMap, take, takeWhile, toReversed, values

Methods inherited from interface org.eclipse.collections.api.map.MutableMapIterable
add, flipUniqueValues, getIfAbsentPut, getIfAbsentPut, getIfAbsentPutWithKey, removeKey, updateValue, updateValueWith

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

Methods inherited from interface org.eclipse.collections.api.map.MapIterable
containsKey, containsValue, detect, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, hashCode, ifPresentApply, keysView, keyValuesView, toString, valuesView

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable
forEachWithIndex, getFirst, getLast, max, min, zip, zipWithIndex

Methods inherited from interface org.eclipse.collections.api.RichIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, each, flatCollect, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, maxBy, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, size, sumByDouble, sumByFloat, sumByInt, sumByLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy

Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach, forEachWith

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

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

Methods inherited from interface java.util.Map
clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, forEach, get, getOrDefault, hashCode, isEmpty, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size

- Constructor Detail
  - AbstractMutableSortedMap
```
public AbstractMutableSortedMap()
```
- Method Detail
  - clone
```
public abstract MutableSortedMap<K,V> clone()
```
    Specified by:
    
    clone in interface MutableSortedMap<K,V>
    
    Overrides:
    
    clone in class Object
  - withKeyValue
```
public MutableSortedMap<K,V> withKeyValue(K key,
                                          V value)
```
    Description copied from interface: MutableMapIterable
    This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus the additional key and value. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:
```
 map = map.withKeyValue("new key", "new value");
 
```
    In the case of FixedSizeMap, a new instance will be returned by withKeyValue, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.
    Specified by:
    
    withKeyValue in interface MutableMapIterable<K,V>
    
    Specified by:
    
    withKeyValue in interface MutableSortedMap<K,V>
    
    See Also:
    
    Map.put(Object, Object)
  - withAllKeyValues
```
public MutableSortedMap<K,V> withAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
```
    Description copied from interface: MutableMapIterable
    This method allows mutable, fixed size, and immutable maps the ability to add elements to their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original plus all of the additional keys and values. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:
```
 map = map.withAllKeyValues(FastList.newListWith(PairImpl.of("new key", "new value")));
 
```
    In the case of FixedSizeMap, a new instance will be returned by withAllKeyValues, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling put on themselves.
    Specified by:
    
    withAllKeyValues in interface MutableMapIterable<K,V>
    
    Specified by:
    
    withAllKeyValues in interface MutableSortedMap<K,V>
    
    See Also:
    
    Map.put(Object, Object)
  - with
```
@Deprecated
public MutableSortedMap<K,V> with(Pair<K,V>... pairs)
```
    Deprecated. in 6.0 Use withAllKeyValueArguments(Pair[]) instead. Inlineable.
    
    Specified by:
    
    with in interface MutableSortedMap<K,V>
  - withAllKeyValueArguments
```
public MutableSortedMap<K,V> withAllKeyValueArguments(Pair<? extends K,? extends V>... keyValues)
```
    Description copied from interface: MutableMapIterable
    
    Convenience var-args version of withAllKeyValues
    
    Specified by:
    
    withAllKeyValueArguments in interface MutableMapIterable<K,V>
    
    Specified by:
    
    withAllKeyValueArguments in interface MutableSortedMap<K,V>
    
    See Also:
    
    MutableMapIterable.withAllKeyValues(Iterable)
  - withoutKey
```
public MutableSortedMap<K,V> withoutKey(K key)
```
    Description copied from interface: MutableMapIterable
    This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus the key and value to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:
```
 map = map.withoutKey("key");
 
```
    In the case of FixedSizeMap, a new instance will be returned by withoutKey, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.
    Specified by:
    
    withoutKey in interface MutableMapIterable<K,V>
    
    Specified by:
    
    withoutKey in interface MutableSortedMap<K,V>
    
    See Also:
    
    Map.remove(Object)
  - withoutAllKeys
```
public MutableSortedMap<K,V> withoutAllKeys(Iterable<? extends K> keys)
```
    Description copied from interface: MutableMapIterable
    This method allows mutable, fixed size, and immutable maps the ability to remove elements from their existing elements. In order to support fixed size maps, a new instance of a map would have to be returned including the keys and values of the original minus all of the keys and values to be removed. In the case of mutable maps, the original map is modified and then returned. In order to use this method properly with mutable and fixed size maps the following approach must be taken:
```
 map = map.withoutAllKeys(FastList.newListWith("key1", "key2"));
 
```
    In the case of FixedSizeMap, a new instance will be returned by withoutAllKeys, and any variables that previously referenced the original map will need to be redirected to reference the new instance. In the case of a FastMap or UnifiedMap, you will be replacing the reference to map with map, since FastMap and UnifiedMap will both return "this" after calling remove on themselves.
    Specified by:
    
    withoutAllKeys in interface MutableMapIterable<K,V>
    
    Specified by:
    
    withoutAllKeys in interface MutableSortedMap<K,V>
    
    See Also:
    
    Map.remove(Object)
  - asUnmodifiable
```
public MutableSortedMap<K,V> asUnmodifiable()
```
    Description copied from interface: MutableMapIterable
    
    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 MutableMapIterable<K,V>
    
    Specified by:
    
    asUnmodifiable in interface MutableSortedMap<K,V>
    
    Returns:
    
    an unmodifiable view of this map.
  - toImmutable
```
public ImmutableSortedMap<K,V> toImmutable()
```
    Description copied from interface: MutableMapIterable
    
    Returns an immutable copy of this map. If the map is immutable, it returns itself.
    
    Specified by:
    
    toImmutable in interface MapIterable<K,V>
    
    Specified by:
    
    toImmutable in interface MutableMapIterable<K,V>
    
    Specified by:
    
    toImmutable in interface SortedMapIterable<K,V>
  - asSynchronized
```
public MutableSortedMap<K,V> asSynchronized()
```
    Description copied from interface: MutableMapIterable
    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 MutableMapIterable<K,V>
    
    Specified by:
    
    asSynchronized in interface MutableSortedMap<K,V>
  - flip
```
public MutableSortedSetMultimap<V,K> flip()
```
    Description copied from interface: MapIterable
    
    Given a map from Domain -> Range return a multimap from Range -> Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.
    Since the keys in the input are unique, the values in the output are unique, so the return type should be a SetMultimap. However since SetMultimap and SortedSetMultimap don't inherit from one another, SetMultimap here does not allow SortedMapIterable to have a SortedSetMultimap return. Thus we compromise and call this Multimap, even though all implementations will be a SetMultimap or SortedSetMultimap.
    
    Specified by:
    
    flip in interface MapIterable<K,V>
    
    Specified by:
    
    flip in interface MutableMapIterable<K,V>
    
    Specified by:
    
    flip in interface MutableSortedMap<K,V>
    
    Specified by:
    
    flip in interface SortedMapIterable<K,V>
  - collectBoolean
```
public MutableBooleanList collectBoolean(BooleanFunction<? super V> booleanFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 BooleanIterable licenses =
     people.collectBoolean(person -> person.hasDrivingLicense());
 
```
    Example using an anonymous inner class:
```
 BooleanIterable licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     });
 
```
    Specified by:
    
    collectBoolean in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectBoolean in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectBoolean in interface OrderedIterable<V>
    
    Specified by:
    
    collectBoolean in interface ReversibleIterable<V>
    
    Specified by:
    
    collectBoolean in interface RichIterable<V>
  - collectByte
```
public MutableByteList collectByte(ByteFunction<? super V> byteFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 ByteIterable bytes =
     people.collectByte(person -> person.getCode());
 
```
    Example using an anonymous inner class:
```
 ByteIterable bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     });
 
```
    Specified by:
    
    collectByte in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectByte in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectByte in interface OrderedIterable<V>
    
    Specified by:
    
    collectByte in interface ReversibleIterable<V>
    
    Specified by:
    
    collectByte in interface RichIterable<V>
  - collectChar
```
public MutableCharList collectChar(CharFunction<? super V> charFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 CharIterable chars =
     people.collectChar(person -> person.getMiddleInitial());
 
```
    Example using an anonymous inner class:
```
 CharIterable chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     });
 
```
    Specified by:
    
    collectChar in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectChar in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectChar in interface OrderedIterable<V>
    
    Specified by:
    
    collectChar in interface ReversibleIterable<V>
    
    Specified by:
    
    collectChar in interface RichIterable<V>
  - collectDouble
```
public MutableDoubleList collectDouble(DoubleFunction<? super V> doubleFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 DoubleIterable doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole());
 
```
    Example using an anonymous inner class:
```
 DoubleIterable doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     });
 
```
    Specified by:
    
    collectDouble in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectDouble in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectDouble in interface OrderedIterable<V>
    
    Specified by:
    
    collectDouble in interface ReversibleIterable<V>
    
    Specified by:
    
    collectDouble in interface RichIterable<V>
  - collectFloat
```
public MutableFloatList collectFloat(FloatFunction<? super V> floatFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 FloatIterable floats =
     people.collectFloat(person -> person.getHeightInInches());
 
```
    Example using an anonymous inner class:
```
 FloatIterable floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     });
 
```
    Specified by:
    
    collectFloat in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectFloat in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectFloat in interface OrderedIterable<V>
    
    Specified by:
    
    collectFloat in interface ReversibleIterable<V>
    
    Specified by:
    
    collectFloat in interface RichIterable<V>
  - collectInt
```
public MutableIntList collectInt(IntFunction<? super V> intFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 IntIterable ints =
     people.collectInt(person -> person.getAge());
 
```
    Example using an anonymous inner class:
```
 IntIterable ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     });
 
```
    Specified by:
    
    collectInt in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectInt in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectInt in interface OrderedIterable<V>
    
    Specified by:
    
    collectInt in interface ReversibleIterable<V>
    
    Specified by:
    
    collectInt in interface RichIterable<V>
  - collectLong
```
public MutableLongList collectLong(LongFunction<? super V> longFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 LongIterable longs =
     people.collectLong(person -> person.getGuid());
 
```
    Example using an anonymous inner class:
```
 LongIterable longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     });
 
```
    Specified by:
    
    collectLong in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectLong in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectLong in interface OrderedIterable<V>
    
    Specified by:
    
    collectLong in interface ReversibleIterable<V>
    
    Specified by:
    
    collectLong in interface RichIterable<V>
  - collectShort
```
public MutableShortList collectShort(ShortFunction<? super V> shortFunction)
```
    Description copied from interface: RichIterable
    Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 ShortIterable shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());
 
```
    Example using an anonymous inner class:
```
 ShortIterable shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth();
         }
     });
 
```
    Specified by:
    
    collectShort in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectShort in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectShort in interface OrderedIterable<V>
    
    Specified by:
    
    collectShort in interface ReversibleIterable<V>
    
    Specified by:
    
    collectShort in interface RichIterable<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>
  - 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 MutableMapIterable<K,V>
    
    Specified by:
    
    collectValues in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectValues in interface SortedMapIterable<K,V>
  - tap
```
public MutableSortedMap<K,V> tap(Procedure<? super V> procedure)
```
    Description copied from interface: MapIterable
    Executes the Procedure for each value of the map and returns this.
```
e.g.
 return peopleByCity.tap(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 
```
    Specified by:
    
    tap in interface MapIterable<K,V>
    
    Specified by:
    
    tap in interface MutableMapIterable<K,V>
    
    Specified by:
    
    tap in interface MutableSortedMap<K,V>
    
    Specified by:
    
    tap in interface SortedMapIterable<K,V>
    
    Specified by:
    
    tap in interface RichIterable<V>
    
    See Also:
    
    InternalIterable.forEach(Procedure)
  - 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 MutableMapIterable<K,V>
    
    Specified by:
    
    select in interface MutableSortedMap<K,V>
    
    Specified by:
    
    select in interface SortedMapIterable<K,V>
  - reject
```
public MutableSortedMap<K,V> reject(Predicate2<? super K,? super V> predicate)
```
    Description copied from interface: MapIterable
    For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.
```
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 MutableMapIterable<K,V>
    
    Specified by:
    
    reject in interface MutableSortedMap<K,V>
    
    Specified by:
    
    reject in interface SortedMapIterable<K,V>
  - collect
```
public <R> MutableList<R> collect(Function<? super V,? extends R> function)
```
    Description copied from interface: RichIterable
    Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.
    Example using a Java 8 lambda expression:
```
 RichIterable<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName());
 
```
    Example using an anonymous inner class:
```
 RichIterable<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     });
 
```
    Specified by:
    
    collect in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collect in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collect in interface OrderedIterable<V>
    
    Specified by:
    
    collect in interface ReversibleIterable<V>
    
    Specified by:
    
    collect in interface RichIterable<V>
  - collectWith
```
public <P,VV> MutableList<VV> collectWith(Function2<? super V,? super P,? extends VV> function,
                                          P parameter)
```
    Description copied from interface: RichIterable
    Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
    Example using a Java 8 lambda expression:
```
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));
 
```
    Example using an anonymous inner class:
```
 Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(Integer each, Integer parameter)
         {
             return each + parameter;
         }
     };
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 
```
    Specified by:
    
    collectWith in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectWith in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectWith in interface OrderedIterable<V>
    
    Specified by:
    
    collectWith in interface ReversibleIterable<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)
  - collectIf
```
public <R> MutableList<R> collectIf(Predicate<? super V> predicate,
                                    Function<? super V,? extends R> function)
```
    Description copied from interface: RichIterable
    Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the the optimized equivalent of calling iterable.select(predicate).collect(function).
    Example using a Java 8 lambda and method reference:
```
 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);
 
```
    Example using Predicates factory:
```
 RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());
 
```
    Specified by:
    
    collectIf in interface MutableSortedMap<K,V>
    
    Specified by:
    
    collectIf in interface SortedMapIterable<K,V>
    
    Specified by:
    
    collectIf in interface OrderedIterable<V>
    
    Specified by:
    
    collectIf in interface ReversibleIterable<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 = 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 SortedMapIterable<K,V>
    
    Specified by:
    
    flatCollect in interface OrderedIterable<V>
    
    Specified by:
    
    flatCollect in interface ReversibleIterable<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
  - reject
```
public MutableList<V> reject(Predicate<? super V> predicate)
```
    Description copied from interface: RichIterable
    Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).
    Example using a Java 8 lambda expression:
```
 RichIterable<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     });
 
```
    Specified by:
    
    reject in interface MutableMapIterable<K,V>
    
    Specified by:
    
    reject in interface MutableSortedMap<K,V>
    
    Specified by:
    
    reject in interface SortedMapIterable<K,V>
    
    Specified by:
    
    reject in interface OrderedIterable<V>
    
    Specified by:
    
    reject in interface ReversibleIterable<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
  - selectWith
```
public <P> MutableList<V> selectWith(Predicate2<? super V,? super P> predicate,
                                     P parameter)
```
    Description copied from interface: RichIterable
    Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
    E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
    Example using a Java 8 lambda expression:
```
 RichIterable<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge() >= age, Integer.valueOf(18));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() >= age;
         }
     }, Integer.valueOf(18));
 
```
    Specified by:
    
    selectWith in interface MutableMapIterable<K,V>
    
    Specified by:
    
    selectWith in interface MutableSortedMap<K,V>
    
    Specified by:
    
    selectWith in interface SortedMapIterable<K,V>
    
    Specified by:
    
    selectWith in interface OrderedIterable<V>
    
    Specified by:
    
    selectWith in interface ReversibleIterable<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)
  - rejectWith
```
public <P> MutableList<V> rejectWith(Predicate2<? super V,? super P> predicate,
                                     P parameter)
```
    Description copied from interface: RichIterable
    Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
    E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years
    Example using a Java 8 lambda expression:
```
 RichIterable<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));
 
```
    Example using an anonymous inner class:
```
 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 
```
    Specified by:
    
    rejectWith in interface MutableMapIterable<K,V>
    
    Specified by:
    
    rejectWith in interface MutableSortedMap<K,V>
    
    Specified by:
    
    rejectWith in interface SortedMapIterable<K,V>
    
    Specified by:
    
    rejectWith in interface OrderedIterable<V>
    
    Specified by:
    
    rejectWith in interface ReversibleIterable<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)
  - select
```
public MutableList<V> select(Predicate<? super V> predicate)
```
    Description copied from interface: RichIterable
    Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.
    Example using a Java 8 lambda expression:
```
 RichIterable<Person> selected =
     people.select(person -> person.getAddress().getCity().equals("London"));
 
```
    Example using an anonymous inner class:
```
 RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });
```
    Specified by:
    
    select in interface MutableMapIterable<K,V>
    
    Specified by:
    
    select in interface MutableSortedMap<K,V>
    
    Specified by:
    
    select in interface SortedMapIterable<K,V>
    
    Specified by:
    
    select in interface OrderedIterable<V>
    
    Specified by:
    
    select in interface ReversibleIterable<V>
    
    Specified by:
    
    select in interface RichIterable<V>
  - partition
```
public PartitionMutableList<V> partition(Predicate<? super V> predicate)
```
    Description copied from interface: RichIterable
    Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
    Example using a Java 8 lambda expression:
```
 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(person -> person.getAddress().getState().getName().equals("New York"));
 
```
    Example using an anonymous inner class:
```
 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
 
```
    Specified by:
    
    partition in interface MutableMapIterable<K,V>
    
    Specified by:
    
    partition in interface MutableSortedMap<K,V>
    
    Specified by:
    
    partition in interface SortedMapIterable<K,V>
    
    Specified by:
    
    partition in interface OrderedIterable<V>
    
    Specified by:
    
    partition in interface ReversibleIterable<V>
    
    Specified by:
    
    partition in interface RichIterable<V>
  - partitionWith
```
public <P> PartitionMutableList<V> partitionWith(Predicate2<? super V,? super P> predicate,
                                                 P parameter)
```
    Description copied from interface: RichIterable
    Filters a collection into a PartitionIterable based on the evaluation of the predicate.
    Example using a Java 8 lambda expression:
```
 PartitionIterable<Person>> newYorkersAndNonNewYorkers =
     people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");
 
```
    Example using an anonymous inner class:
```
 PartitionIterable<Person>> newYorkersAndNonNewYorkers =
     people.partitionWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String state)
         {
             return person.getAddress().getState().getName().equals(state);
         }
     }, "New York");
 
```
    Specified by:
    
    partitionWith in interface MutableSortedMap<K,V>
    
    Specified by:
    
    partitionWith in interface SortedMapIterable<K,V>
    
    Specified by:
    
    partitionWith in interface OrderedIterable<V>
    
    Specified by:
    
    partitionWith in interface ReversibleIterable<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 MutableMapIterable<K,V>
    
    Specified by:
    
    selectInstancesOf in interface MutableSortedMap<K,V>
    
    Specified by:
    
    selectInstancesOf in interface SortedMapIterable<K,V>
    
    Specified by:
    
    selectInstancesOf in interface OrderedIterable<V>
    
    Specified by:
    
    selectInstancesOf in interface ReversibleIterable<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 MutableMapIterable<K,V>
    
    Specified by:
    
    zip in interface MutableSortedMap<K,V>
    
    Specified by:
    
    zip in interface SortedMapIterable<K,V>
    
    Specified by:
    
    zip in interface OrderedIterable<V>
    
    Specified by:
    
    zip in interface ReversibleIterable<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 MutableMapIterable<K,V>
    
    Specified by:
    
    zipWithIndex in interface MutableSortedMap<K,V>
    
    Specified by:
    
    zipWithIndex in interface SortedMapIterable<K,V>
    
    Specified by:
    
    zipWithIndex in interface OrderedIterable<V>
    
    Specified by:
    
    zipWithIndex in interface ReversibleIterable<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)
  - groupBy
```
public <VV> MutableListMultimap<VV,V> groupBy(Function<? super V,? extends VV> function)
```
    Description copied from interface: RichIterable
    For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
    Example using a Java 8 method reference:
```
 Multimap<String, Person> peopleByLastName =
     people.groupBy(Person::getLastName);
 
```
    Example using an anonymous inner class:
```
 Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String value(Person person)
         {
             return person.getLastName();
         }
     });
 
```
    Specified by:
    
    groupBy in interface MutableMapIterable<K,V>
    
    Specified by:
    
    groupBy in interface MutableSortedMap<K,V>
    
    Specified by:
    
    groupBy in interface SortedMapIterable<K,V>
    
    Specified by:
    
    groupBy in interface OrderedIterable<V>
    
    Specified by:
    
    groupBy in interface ReversibleIterable<V>
    
    Specified by:
    
    groupBy in interface RichIterable<V>
  - groupByEach
```
public <VV> MutableListMultimap<VV,V> groupByEach(Function<? super V,? extends Iterable<VV>> function)
```
    Description copied from interface: RichIterable
    
    Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
    
    Specified by:
    
    groupByEach in interface MutableMapIterable<K,V>
    
    Specified by:
    
    groupByEach in interface MutableSortedMap<K,V>
    
    Specified by:
    
    groupByEach in interface SortedMapIterable<K,V>
    
    Specified by:
    
    groupByEach in interface OrderedIterable<V>
    
    Specified by:
    
    groupByEach in interface ReversibleIterable<V>
    
    Specified by:
    
    groupByEach in interface RichIterable<V>
  - reverseForEach
```
public void reverseForEach(Procedure<? super V> procedure)
```
    Description copied from interface: ReversibleIterable
    Evaluates the procedure for each element of the list iterating in reverse order.
```
e.g.
 people.reverseForEach(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 
```
    Specified by:
    
    reverseForEach in interface ReversibleIterable<V>
  - asReversed
```
public LazyIterable<V> asReversed()
```
    Description copied from interface: ReversibleIterable
    
    Returns a reversed view of this ReversibleIterable.
    
    Specified by:
    
    asReversed in interface ReversibleIterable<V>
  - detectLastIndex
```
public int detectLastIndex(Predicate<? super V> predicate)
```
    Description copied from interface: ReversibleIterable
    
    Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
    
    Specified by:
    
    detectLastIndex in interface ReversibleIterable<V>
  - indexOf
```
public int indexOf(Object object)
```
    Description copied from interface: OrderedIterable
    
    Returns the index of the first occurrence of the specified item in this iterable, or -1 if this iterable does not contain the item.
    
    Specified by:
    
    indexOf in interface OrderedIterable<V>
    
    See Also:
    
    List.indexOf(Object)
  - corresponds
```
public <S> boolean corresponds(OrderedIterable<S> other,
                               Predicate2<? super V,? super S> predicate)
```
    Description copied from interface: OrderedIterable
    
    Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.
    
    Specified by:
    
    corresponds in interface OrderedIterable<V>
  - forEach
```
public void forEach(int startIndex,
                    int endIndex,
                    Procedure<? super V> procedure)
```
    Description copied from interface: OrderedIterable
    Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.
```
e.g.
 OrderedIterable people = FastList.newListWith(ted, mary, bob, sally)
 people.forEach(0, 1, new Procedure()
 {
     public void value(Person person)
     {
          LOGGER.info(person.getName());
     }
 });
 
```
    This code would output ted and mary's names.
    Specified by:
    
    forEach in interface OrderedIterable<V>
  - forEachWithIndex
```
public void forEachWithIndex(int fromIndex,
                             int toIndex,
                             ObjectIntProcedure<? super V> objectIntProcedure)
```
    Description copied from interface: OrderedIterable
    Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.
```
e.g.
 OrderedIterable people = FastList.newListWith(ted, mary, bob, sally)
 people.forEachWithIndex(0, 1, new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
          LOGGER.info(person.getName());
     }
 });
 
```
    This code would output ted and mary's names.
    Specified by:
    
    forEachWithIndex in interface OrderedIterable<V>
  - toStack
```
public MutableStack<V> toStack()
```
    Description copied from interface: OrderedIterable
    
    Converts the OrderedIterable to a mutable MutableStack implementation.
    
    Specified by:
    
    toStack in interface OrderedIterable<V>
  - detectIndex
```
public int detectIndex(Predicate<? super V> predicate)
```
    Description copied from interface: OrderedIterable
    
    Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.
    
    Specified by:
    
    detectIndex in interface OrderedIterable<V>

Class AbstractMutableSortedMap<K,V>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class org.eclipse.collections.impl.map.mutable.AbstractMutableMapIterable

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

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

AbstractMutableSortedMap

Method Detail

clone

withKeyValue

withAllKeyValues

with

withAllKeyValueArguments

withoutKey

withoutAllKeys

asUnmodifiable

toImmutable

asSynchronized

flip

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collectKeysAndValues

collectValues

tap

select

reject

collect

collectWith

collectIf

flatCollect

reject

selectWith

rejectWith

select

partition

partitionWith

selectInstancesOf

zip

zipWithIndex

groupBy

groupByEach

reverseForEach

asReversed

detectLastIndex

indexOf

corresponds

forEach

forEachWithIndex

toStack

detectIndex