ImmutableSortedMap (Goldman Sachs Collections API

All Superinterfaces:

InternalIterable<V>, java.lang.Iterable<V>, MapIterable<K,V>, RichIterable<V>, SortedMapIterable<K,V>
```
@Immutable
public interface ImmutableSortedMap<K,V>
extends SortedMapIterable<K,V>
```
An ImmutableSortedMap is different than a JCF SortedMap in that it has no mutating methods, but it shares the read-only protocol of a SortedMap.

Method Summary

Methods
Modifier and Type	Method and Description
`<K2,V2> ImmutableMap<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> ImmutableMap<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.
`java.util.SortedMap<K,V>`	`castToSortedMap()`
`<R> ImmutableList<R>`	`collect(Function<? super V,? extends R> function)` Returns a new collection with the results of applying the specified function on each element of the source collection.
`<K2,V2> ImmutableMap<K2,V2>`	`collect(Function2<? super K,? super V,Pair<K2,V2>> function)` For each key and value of the map the function is evaluated.
`<R> ImmutableList<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> ImmutableSortedMap<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> ImmutableList<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
`<R> ImmutableList<R>`	`flatCollect(Function<? super V,? extends java.lang.Iterable<R>> function)` `flatCollect` is a special case of `RichIterable.collect(Function)`.
`ImmutableSortedSetMultimap<V,K>`	`flip()` Given a map from Domain -> Range return a multimap from Range -> Domain.
`ImmutableMap<V,K>`	`flipUniqueValues()` Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
`<VV> ImmutableListMultimap<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> ImmutableListMultimap<VV,V>`	`groupByEach(Function<? super V,? extends java.lang.Iterable<VV>> function)` Similar to `RichIterable.groupBy(Function)`, except the result of evaluating function will return a collection of keys for each value.
`<VV> ImmutableMap<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.
`ImmutableSortedMap<K,V>`	`newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)`
`ImmutableSortedMap<K,V>`	`newWithAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)`
`ImmutableSortedMap<K,V>`	`newWithKeyValue(K key, V value)`
`ImmutableSortedMap<K,V>`	`newWithoutAllKeys(java.lang.Iterable<? extends K> keys)`
`ImmutableSortedMap<K,V>`	`newWithoutKey(K key)`
`PartitionImmutableList<V>`	`partition(Predicate<? super V> predicate)` Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
`ImmutableList<V>`	`reject(Predicate<? super V> predicate)` Returns all elements of the source collection that return false when evaluating of the predicate.
`ImmutableSortedMap<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> ImmutableList<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`.
`ImmutableList<V>`	`select(Predicate<? super V> predicate)` Returns all elements of the source collection that return true when evaluating the predicate.
`ImmutableSortedMap<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> ImmutableList<S>`	`selectInstancesOf(java.lang.Class<S> clazz)` Returns all elements of the source collection that are instances of the Class `clazz`.
`<P> ImmutableList<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>`	`toSortedMap()`
`<S> ImmutableList<Pair<V,S>>`	`zip(java.lang.Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`ImmutableList<Pair<V,java.lang.Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

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

Methods inherited from interface com.gs.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 com.gs.collections.api.RichIterable
allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectBoolean, collectByte, collectByte, collectChar, collectChar, collectDouble, collectDouble, collectFloat, collectFloat, collectIf, collectInt, collectInt, collectLong, collectLong, collectShort, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, detectWith, detectWithIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, partitionWith, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Methods inherited from interface com.gs.collections.api.InternalIterable
forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable
iterator

- Method Detail
  - castToSortedMap
```
java.util.SortedMap<K,V> castToSortedMap()
```
  - flip
```
ImmutableSortedSetMultimap<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 SortedMapIterable<K,V>
  - newWithKeyValue
```
ImmutableSortedMap<K,V> newWithKeyValue(K key,
                                      V value)
```
  - newWithAllKeyValues
```
ImmutableSortedMap<K,V> newWithAllKeyValues(java.lang.Iterable<? extends Pair<? extends K,? extends V>> keyValues)
```
  - newWithAllKeyValueArguments
```
ImmutableSortedMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
```
  - newWithoutKey
```
ImmutableSortedMap<K,V> newWithoutKey(K key)
```
  - newWithoutAllKeys
```
ImmutableSortedMap<K,V> newWithoutAllKeys(java.lang.Iterable<? extends K> keys)
```
  - toSortedMap
```
MutableSortedMap<K,V> toSortedMap()
```
  - flipUniqueValues
```
ImmutableMap<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>
  - select
```
ImmutableSortedMap<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 SortedMapIterable<K,V>
  - collect
```
<K2,V2> ImmutableMap<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>
  - reject
```
ImmutableSortedMap<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 SortedMapIterable<K,V>
  - partition
```
PartitionImmutableList<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 RichIterable<V>
    
    Specified by:
    
    partition in interface SortedMapIterable<K,V>
  - collectValues
```
<R> ImmutableSortedMap<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 SortedMapIterable<K,V>
  - select
```
ImmutableList<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 RichIterable<V>
    
    Specified by:
    
    select in interface SortedMapIterable<K,V>
  - selectWith
```
<P> ImmutableList<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 RichIterable<V>
    
    Specified by:
    
    selectWith in interface SortedMapIterable<K,V>
    
    Parameters:
    predicate - a Predicate2 to use as the select criteria
    parameter - a parameter to pass in for evaluation of the second argument P in predicate
    See Also:
    RichIterable.select(Predicate)
  - reject
```
ImmutableList<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 RichIterable<V>
    
    Specified by:
    
    reject in interface SortedMapIterable<K,V>
    
    Parameters:
    predicate - a Predicate to use as the reject criteria
    
    Returns:
    a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false
  - rejectWith
```
<P> ImmutableList<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 RichIterable<V>
    
    Specified by:
    
    rejectWith in interface SortedMapIterable<K,V>
    
    Parameters:
    predicate - a Predicate2 to use as the select criteria
    parameter - a parameter to pass in for evaluation of the second argument P in predicate
    See Also:
    RichIterable.select(Predicate)
  - selectInstancesOf
```
<S> ImmutableList<S> selectInstancesOf(java.lang.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 RichIterable<V>
    
    Specified by:
    
    selectInstancesOf in interface SortedMapIterable<K,V>
  - collect
```
<R> ImmutableList<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 RichIterable<V>
  - collectWith
```
<P,VV> ImmutableList<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 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
```
<R> ImmutableList<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 RichIterable<V>
  - flatCollect
```
<R> ImmutableList<R> flatCollect(Function<? super V,? extends java.lang.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 RichIterable<V>
    
    Parameters:
    function - The Function to apply
    
    Returns:
    a new flattened collection produced by applying the given function
  - zip
```
<S> ImmutableList<Pair<V,S>> zip(java.lang.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 RichIterable<V>
    
    Specified by:
    
    zip in interface SortedMapIterable<K,V>
    
    Type Parameters:
    S - the type of the second half of the returned pairs
    Parameters:
    that - The RichIterable providing the second half of each result pair
    
    Returns:
    A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.
  - zipWithIndex
```
ImmutableList<Pair<V,java.lang.Integer>> zipWithIndex()
```
    Description copied from interface: RichIterable
    
    Zips this RichIterable with its indices.
    
    Specified by:
    
    zipWithIndex in interface RichIterable<V>
    
    Specified by:
    
    zipWithIndex in interface SortedMapIterable<K,V>
    
    Returns:
    A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.
    See Also:
    RichIterable.zip(Iterable)
  - groupBy
```
<VV> ImmutableListMultimap<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.
```
e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 
```
    Specified by:
    
    groupBy in interface RichIterable<V>
    
    Specified by:
    
    groupBy in interface SortedMapIterable<K,V>
  - groupByEach
```
<VV> ImmutableListMultimap<VV,V> groupByEach(Function<? super V,? extends java.lang.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 RichIterable<V>
    
    Specified by:
    
    groupByEach in interface SortedMapIterable<K,V>
  - groupByUniqueKey
```
<VV> ImmutableMap<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 RichIterable<V>
    
    See Also:
    RichIterable.groupBy(Function)
  - aggregateInPlaceBy
```
<K2,V2> ImmutableMap<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 RichIterable<V>
  - aggregateBy
```
<K2,V2> ImmutableMap<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 RichIterable<V>

Interface ImmutableSortedMap<K,V>

Method Summary

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 com.gs.collections.api.InternalIterable

Methods inherited from interface java.lang.Iterable

Method Detail

castToSortedMap

flip

newWithKeyValue

newWithAllKeyValues

newWithAllKeyValueArguments

newWithoutKey

newWithoutAllKeys

toSortedMap

flipUniqueValues

select

collect

reject

partition

collectValues

select

selectWith

reject

rejectWith

selectInstancesOf

collect

collectWith

collectIf

flatCollect

zip

zipWithIndex

groupBy

groupByEach

groupByUniqueKey

aggregateInPlaceBy

aggregateBy