AbstractImmutableSortedMap (GS Collections

java.lang.Object
- com.gs.collections.impl.map.AbstractMapIterable<K,V>
- - com.gs.collections.impl.map.sorted.immutable.AbstractImmutableSortedMap<K,V>

All Implemented Interfaces:

InternalIterable<V>, MapIterable<K,V>, ImmutableSortedMap<K,V>, SortedMapIterable<K,V>, RichIterable<V>, Iterable<V>, Map<K,V>, SortedMap<K,V>

Direct Known Subclasses:

ImmutableTreeMap
```
@Immutable
public abstract class AbstractImmutableSortedMap<K,V>
extends AbstractMapIterable<K,V>
implements ImmutableSortedMap<K,V>, SortedMap<K,V>
```

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

Constructor Summary

Constructors
Constructor and Description

AbstractImmutableSortedMap()

Constructors
Constructor and Description
`AbstractImmutableSortedMap()`

Method Summary

All Methods Instance Methods Concrete 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.
`SortedMap<K,V>`	`castToSortedMap()`
`void`	`clear()`
`<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.
`ImmutableBooleanList`	`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.
`ImmutableByteList`	`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.
`ImmutableCharList`	`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.
`ImmutableDoubleList`	`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.
`ImmutableFloatList`	`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> 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.
`ImmutableIntList`	`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.
`ImmutableLongList`	`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.
`ImmutableShortList`	`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> 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
`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.
`<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.
`Set<Map.Entry<K,V>>`	`entrySet()`
`<R> ImmutableList<R>`	`flatCollect(Function<? super V,? extends 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.
`<R> ImmutableListMultimap<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> ImmutableListMultimap<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.
`<V1> ImmutableMap<V1,V>`	`groupByUniqueKey(Function<? super V,? extends V1> 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.
`SortedMap<K,V>`	`headMap(K toKey)`
`Iterator<V>`	`iterator()`
`ImmutableSortedMap<K,V>`	`newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)`
`ImmutableSortedMap<K,V>`	`newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)`
`ImmutableSortedMap<K,V>`	`newWithKeyValue(K key, V value)`
`ImmutableSortedMap<K,V>`	`newWithoutAllKeys(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.
`<P> PartitionIterable<V>`	`partitionWith(Predicate2<? super V,? super P> predicate, P parameter)` Filters a collection into a PartitionIterable based on the evaluation of the predicate.
`V`	`put(K key, V value)`
`void`	`putAll(Map<? extends K,? extends V> map)`
`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`.
`V`	`remove(Object key)`
`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(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`.
`SortedMap<K,V>`	`subMap(K fromKey, K toKey)`
`SortedMap<K,V>`	`tailMap(K fromKey)`
`ImmutableSortedMap<K,V>`	`toImmutable()` Converts the SortedMapIterable to an immutable implementation.
`MutableSortedMap<K,V>`	`toSortedMap()`
`<S> ImmutableList<Pair<V,S>>`	`zip(Iterable<S> that)` Returns a `RichIterable` formed from this `RichIterable` and another `RichIterable` by combining corresponding elements in pairs.
`ImmutableList<Pair<V,Integer>>`	`zipWithIndex()` Zips this `RichIterable` with its indices.

Methods inherited from class com.gs.collections.impl.map.AbstractMapIterable
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, flatCollect, forEach, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, groupBy, groupByEach, ifPresentApply, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

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

Methods inherited from interface com.gs.collections.api.map.sorted.ImmutableSortedMap
flipUniqueValues

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

Methods inherited from interface com.gs.collections.api.map.MapIterable
containsKey, containsValue, 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, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countWith, detect, detectIfNone, flatCollect, getFirst, getLast, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, isEmpty, makeString, makeString, makeString, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, notEmpty, 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
forEach, spliterator

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

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

- Constructor Detail
 - AbstractImmutableSortedMap
```
public AbstractImmutableSortedMap()
```
- Method Detail
 - castToSortedMap
```
public SortedMap<K,V> castToSortedMap()
```
 Specified by:
 
 castToSortedMap in interface ImmutableSortedMap<K,V>
 - toSortedMap
```
public MutableSortedMap<K,V> toSortedMap()
```
 Specified by:
 
 toSortedMap in interface ImmutableSortedMap<K,V>
 - toImmutable
```
public ImmutableSortedMap<K,V> toImmutable()
```
 Description copied from interface: SortedMapIterable
 
 Converts the SortedMapIterable to an immutable implementation. Returns this for immutable maps.
 
 Specified by:
 
 toImmutable in interface SortedMapIterable<K,V>
 - iterator
```
public Iterator<V> iterator()
```
 Specified by:
 
 iterator in interface Iterable<V>
 - putAll
```
public void putAll(Map<? extends K,? extends V> map)
```
 Specified by:
 
 putAll in interface Map<K,V>
 - clear
```
public void clear()
```
 Specified by:
 
 clear in interface Map<K,V>
 - entrySet
```
public Set<Map.Entry<K,V>> entrySet()
```
 Specified by:
 
 entrySet in interface Map<K,V>
 
 Specified by:
 
 entrySet in interface SortedMap<K,V>
 - newWithKeyValue
```
public ImmutableSortedMap<K,V> newWithKeyValue(K key,
 V value)
```
 Specified by:
 
 newWithKeyValue in interface ImmutableSortedMap<K,V>
 - newWithAllKeyValues
```
public ImmutableSortedMap<K,V> newWithAllKeyValues(Iterable<? extends Pair<? extends K,? extends V>> keyValues)
```
 Specified by:
 
 newWithAllKeyValues in interface ImmutableSortedMap<K,V>
 - newWithAllKeyValueArguments
```
public ImmutableSortedMap<K,V> newWithAllKeyValueArguments(Pair<? extends K,? extends V>... keyValuePairs)
```
 Specified by:
 
 newWithAllKeyValueArguments in interface ImmutableSortedMap<K,V>
 - newWithoutKey
```
public ImmutableSortedMap<K,V> newWithoutKey(K key)
```
 Specified by:
 
 newWithoutKey in interface ImmutableSortedMap<K,V>
 - newWithoutAllKeys
```
public ImmutableSortedMap<K,V> newWithoutAllKeys(Iterable<? extends K> keys)
```
 Specified by:
 
 newWithoutAllKeys in interface ImmutableSortedMap<K,V>
 - put
```
public V put(K key,
 V value)
```
 Specified by:
 
 put in interface Map<K,V>
 - remove
```
public V remove(Object key)
```
 Specified by:
 
 remove in interface Map<K,V>
 - flip
```
public 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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 flip in interface SortedMapIterable<K,V>
 - select
```
public 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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 select in interface SortedMapIterable<K,V>
 
 Specified by:
 
 select in interface RichIterable<V>
 - selectWith
```
public  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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 selectWith in interface SortedMapIterable<K,V>
 
 Specified by:
 
 selectWith in interface RichIterable<V>
 
 Overrides:
 
 selectWith in class AbstractMapIterable<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)
 - select
```
public 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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 select in interface SortedMapIterable<K,V>
 - reject
```
public 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 ImmutableSortedMap<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  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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 rejectWith in interface SortedMapIterable<K,V>
 
 Specified by:
 
 rejectWith in interface RichIterable<V>
 
 Overrides:
 
 rejectWith in class AbstractMapIterable<K,V>
 
 Parameters:
 
 predicate - a Predicate2 to use as the select criteria
 
 parameter - a parameter to pass in for evaluation of the second argument P in predicate
 
 See Also:
 
 RichIterable.select(Predicate)
 - reject
```
public 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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 reject in interface SortedMapIterable<K,V>
 - partition
```
public 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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 partition in interface SortedMapIterable<K,V>
 
 Specified by:
 
 partition in interface RichIterable<V>
 - partitionWith
```
public  PartitionIterable<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 RichIterable<V>
 - selectInstancesOf
```
public <S> ImmutableList<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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 selectInstancesOf in interface SortedMapIterable<K,V>
 
 Specified by:
 
 selectInstancesOf in interface RichIterable<V>
 - collect
```
public <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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 collect in interface RichIterable<V>
 
 Overrides:
 
 collect in class AbstractMapIterable<K,V>
 - collectBoolean
```
public ImmutableBooleanList 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 RichIterable<V>
 
 Overrides:
 
 collectBoolean in class AbstractMapIterable<K,V>
 - collectByte
```
public ImmutableByteList 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 RichIterable<V>
 - collectChar
```
public ImmutableCharList 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 RichIterable<V>
 - collectDouble
```
public ImmutableDoubleList 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 RichIterable<V>
 - collectFloat
```
public ImmutableFloatList 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 RichIterable<V>
 - collectInt
```
public ImmutableIntList 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 RichIterable<V>
 - collectLong
```
public ImmutableLongList 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 RichIterable<V>
 - collectShort
```
public ImmutableShortList 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 RichIterable<V>
 - collect
```
public <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>
 
 Specified by:
 
 collect in interface ImmutableSortedMap<K,V>
 - collectWith
```
public <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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 collectWith in interface RichIterable<V>
 
 Overrides:
 
 collectWith in class AbstractMapIterable<K,V>
 
 Parameters:
 
 function - A Function2 to use as the collect transformation function
 
 parameter - A parameter to pass in for evaluation of the second argument P in function
 
 Returns:
 
 A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)
 
 See Also:
 
 RichIterable.collect(Function)
 - collectIf
```
public <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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 collectIf in interface RichIterable<V>
 - collectValues
```
public <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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 collectValues 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>
 - 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>
 
 Overrides:
 
 detectWith in class AbstractMapIterable<K,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>
 
 Overrides:
 
 detectWithIfNone in class AbstractMapIterable<K,V>
 - flatCollect
```
public <R> ImmutableList<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 ImmutableSortedMap<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
 - zip
```
public <S> ImmutableList<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 ImmutableSortedMap<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 ImmutableList<Pair<V,Integer>> zipWithIndex()
```
 Description copied from interface: RichIterable
 
 Zips this RichIterable with its indices.
 
 Specified by:
 
 zipWithIndex in interface ImmutableSortedMap<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)
 - subMap
```
public SortedMap<K,V> subMap(K fromKey,
 K toKey)
```
 Specified by:
 
 subMap in interface SortedMap<K,V>
 - headMap
```
public SortedMap<K,V> headMap(K toKey)
```
 Specified by:
 
 headMap in interface SortedMap<K,V>
 - tailMap
```
public SortedMap<K,V> tailMap(K fromKey)
```
 Specified by:
 
 tailMap in interface SortedMap<K,V>
 - groupBy
```
public <R> ImmutableListMultimap<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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 groupBy in interface SortedMapIterable<K,V>
 
 Specified by:
 
 groupBy in interface RichIterable<V>
 - groupByEach
```
public <R> ImmutableListMultimap<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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 groupByEach in interface SortedMapIterable<K,V>
 
 Specified by:
 
 groupByEach in interface RichIterable<V>
 - groupByUniqueKey
```
public <V1> ImmutableMap<V1,V> groupByUniqueKey(Function<? super V,? extends V1> 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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 groupByUniqueKey in interface RichIterable<V>
 
 See Also:
 
 RichIterable.groupBy(Function)
 - aggregateInPlaceBy
```
public <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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 aggregateInPlaceBy in interface RichIterable<V>
 - aggregateBy
```
public <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 ImmutableSortedMap<K,V>
 
 Specified by:
 
 aggregateBy in interface RichIterable<V>

Class AbstractImmutableSortedMap<K,V>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.gs.collections.impl.map.AbstractMapIterable

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.util.SortedMap

Methods inherited from interface java.util.Map

Constructor Detail

AbstractImmutableSortedMap

Method Detail

castToSortedMap

toSortedMap

toImmutable

iterator

putAll

clear

entrySet

newWithKeyValue

newWithAllKeyValues

newWithAllKeyValueArguments

newWithoutKey

newWithoutAllKeys

put

remove

flip

select

selectWith

select

reject

rejectWith

reject

partition

partitionWith

selectInstancesOf

collect

collectBoolean

collectByte

collectChar

collectDouble

collectFloat

collectInt

collectLong

collectShort

collect

collectWith

collectIf

collectValues

detect

detectWith

detectWithIfNone

flatCollect

zip

zipWithIndex

subMap

headMap

tailMap

groupBy

groupByEach

groupByUniqueKey

aggregateInPlaceBy

aggregateBy