com.gs.collections.impl.map.sorted.immutable

Class AbstractImmutableSortedMap<K,V>

java.lang.Object

com.gs.collections.impl.AbstractRichIterable<V>

com.gs.collections.impl.map.AbstractMapIterable<K,V>

com.gs.collections.impl.map.sorted.immutable.AbstractImmutableSortedMap<K,V>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<V>, com.gs.collections.api.map.ImmutableMapIterable<K,V>, com.gs.collections.api.map.MapIterable<K,V>, com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>, com.gs.collections.api.map.sorted.SortedMapIterable<K,V>, com.gs.collections.api.ordered.OrderedIterable<V>, com.gs.collections.api.ordered.ReversibleIterable<V>, com.gs.collections.api.RichIterable<V>, java.lang.Iterable<V>, java.util.Map<K,V>, java.util.SortedMap<K,V>

Direct Known Subclasses:

ImmutableTreeMap

@Immutable
public abstract class AbstractImmutableSortedMap<K,V>
extends AbstractMapIterable<K,V>
implements com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>, java.util.SortedMap<K,V>

Nested Class Summary

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AbstractImmutableSortedMap()

Method Summary

Methods

Modifier and Type	Method and Description
<K2,V2> com.gs.collections.api.map.ImmutableMap<K2,V2>	aggregateBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy, com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory, com.gs.collections.api.block.function.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> com.gs.collections.api.map.ImmutableMap<K2,V2>	aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy, com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory, com.gs.collections.api.block.procedure.Procedure2<? super V2,? super V> mutatingAggregator) Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
com.gs.collections.api.LazyIterable<V>	asReversed() Returns a reversed view of this ReversibleIterable.
java.util.SortedMap<K,V>	castToMap()
java.util.SortedMap<K,V>	castToSortedMap()
void	clear()
<R> com.gs.collections.api.list.ImmutableList<R>	collect(com.gs.collections.api.block.function.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> com.gs.collections.api.map.ImmutableMap<K2,V2>	collect(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function) For each key and value of the map the function is evaluated.
com.gs.collections.api.list.primitive.ImmutableBooleanList	collectBoolean(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.list.primitive.ImmutableByteList	collectByte(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.list.primitive.ImmutableCharList	collectChar(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.list.primitive.ImmutableDoubleList	collectDouble(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.list.primitive.ImmutableFloatList	collectFloat(com.gs.collections.api.block.function.primitive.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> com.gs.collections.api.list.ImmutableList<R>	collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, com.gs.collections.api.block.function.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.
com.gs.collections.api.list.primitive.ImmutableIntList	collectInt(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.list.primitive.ImmutableLongList	collectLong(com.gs.collections.api.block.function.primitive.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.
com.gs.collections.api.list.primitive.ImmutableShortList	collectShort(com.gs.collections.api.block.function.primitive.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> com.gs.collections.api.map.sorted.ImmutableSortedMap<K,R>	collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function) For each key and value of the map the function is evaluated.
<P,VV> com.gs.collections.api.list.ImmutableList<VV>	collectWith(com.gs.collections.api.block.function.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(com.gs.collections.api.ordered.OrderedIterable<S> other, com.gs.collections.api.block.predicate.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.
com.gs.collections.api.tuple.Pair<K,V>	detect(com.gs.collections.api.block.predicate.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.
int	detectIndex(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true.
int	detectLastIndex(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true.
com.gs.collections.api.list.ImmutableList<V>	distinct() Returns a new OrderedIterable containing the distinct elements in this iterable.
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	dropWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns the final elements that do not satisfy the Predicate.
<R> com.gs.collections.api.list.ImmutableList<R>	flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<R>> function) flatCollect is a special case of RichIterable.collect(Function).
com.gs.collections.api.multimap.sortedset.ImmutableSortedSetMultimap<V,K>	flip() Given a map from Domain -> Range return a multimap from Range -> Domain.
void	forEach(int startIndex, int endIndex, com.gs.collections.api.block.procedure.Procedure<? super V> procedure) Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithIndex(int fromIndex, int toIndex, com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super V> objectIntProcedure) Iterates over the section of the iterable covered by the specified inclusive indexes.
<R> com.gs.collections.api.multimap.list.ImmutableListMultimap<R,V>	groupBy(com.gs.collections.api.block.function.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> com.gs.collections.api.multimap.list.ImmutableListMultimap<R,V>	groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<R>> function) Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<V1> com.gs.collections.api.map.ImmutableMap<V1,V>	groupByUniqueKey(com.gs.collections.api.block.function.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.
java.util.SortedMap<K,V>	headMap(K toKey)
int	indexOf(java.lang.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.
java.util.Iterator<V>	iterator()
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	newWithAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs)
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	newWithAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues)
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	newWithKeyValue(K key, V value)
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	newWithoutAllKeys(java.lang.Iterable<? extends K> keys)
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	newWithoutKey(K key)
com.gs.collections.api.partition.list.PartitionImmutableList<V>	partition(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
com.gs.collections.api.partition.list.PartitionImmutableList<V>	partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
<P> com.gs.collections.api.partition.list.PartitionImmutableList<V>	partitionWith(com.gs.collections.api.block.predicate.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(java.util.Map<? extends K,? extends V> map)
com.gs.collections.api.list.ImmutableList<V>	reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns all elements of the source collection that return false when evaluating of the predicate.
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	reject(com.gs.collections.api.block.predicate.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> com.gs.collections.api.list.ImmutableList<V>	rejectWith(com.gs.collections.api.block.predicate.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(java.lang.Object key)
void	reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure) Evaluates the procedure for each element of the list iterating in reverse order.
com.gs.collections.api.list.ImmutableList<V>	select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns all elements of the source collection that return true when evaluating the predicate.
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	select(com.gs.collections.api.block.predicate.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> com.gs.collections.api.list.ImmutableList<S>	selectInstancesOf(java.lang.Class<S> clazz) Returns all elements of the source collection that are instances of the Class clazz.
<P> com.gs.collections.api.list.ImmutableList<V>	selectWith(com.gs.collections.api.block.predicate.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.
java.util.SortedMap<K,V>	subMap(K fromKey, K toKey)
java.util.SortedMap<K,V>	tailMap(K fromKey)
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	takeWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns the initial elements that satisfy the Predicate.
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	tap(com.gs.collections.api.block.procedure.Procedure<? super V> procedure) Executes the Procedure for each value of the map and returns this.
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	toImmutable() Converts the SortedMapIterable to an immutable implementation.
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	toReversed() Returns a new ReversibleIterable in reverse order.
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	toSortedMap()
com.gs.collections.api.stack.MutableStack<V>	toStack() Converts the OrderedIterable to a mutable MutableStack implementation.
<S> com.gs.collections.api.list.ImmutableList<com.gs.collections.api.tuple.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.
com.gs.collections.api.list.ImmutableList<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.

Methods inherited from class com.gs.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, isAbsent, keyAndValueEquals, keyAndValueHashCode, noneSatisfy, noneSatisfyWith, toArray, toArray

Methods inherited from class com.gs.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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

comparator, drop, take

Methods inherited from interface com.gs.collections.api.ordered.OrderedIterable

forEachWithIndex, getFirst, getLast, max, min, zip, zipWithIndex

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

forEach, forEachWith

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

flipUniqueValues

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 java.util.SortedMap

comparator, entrySet, firstKey, keySet, lastKey, values

Methods inherited from interface java.util.Map

containsKey, containsValue, equals, get, hashCode, isEmpty, size

Constructor Detail

AbstractImmutableSortedMap

public AbstractImmutableSortedMap()

Method Detail

castToMap

public java.util.SortedMap<K,V> castToMap()

Specified by:

castToMap in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

castToMap in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

castToSortedMap

public java.util.SortedMap<K,V> castToSortedMap()

Specified by:

castToSortedMap in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

toSortedMap

public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> toSortedMap()

Specified by:

toSortedMap in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

toImmutable

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> toImmutable()

Description copied from interface: com.gs.collections.api.map.sorted.SortedMapIterable

Converts the SortedMapIterable to an immutable implementation. Returns this for immutable maps.

Specified by:

toImmutable in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

toImmutable in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

iterator

public java.util.Iterator<V> iterator()

Specified by:

iterator in interface java.lang.Iterable<V>

putAll

public void putAll(java.util.Map<? extends K,? extends V> map)

Specified by:

putAll in interface java.util.Map<K,V>

clear

public void clear()

Specified by:

clear in interface java.util.Map<K,V>

newWithKeyValue

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> newWithKeyValue(K key,
                                                                        V value)

Specified by:

newWithKeyValue in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

newWithKeyValue in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

newWithAllKeyValues

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> newWithAllKeyValues(java.lang.Iterable<? extends com.gs.collections.api.tuple.Pair<? extends K,? extends V>> keyValues)

Specified by:

newWithAllKeyValues in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

newWithAllKeyValues in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

newWithAllKeyValueArguments

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> newWithAllKeyValueArguments(com.gs.collections.api.tuple.Pair<? extends K,? extends V>... keyValuePairs)

Specified by:

newWithAllKeyValueArguments in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

newWithAllKeyValueArguments in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

newWithoutKey

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> newWithoutKey(K key)

Specified by:

newWithoutKey in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

newWithoutKey in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

newWithoutAllKeys

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> newWithoutAllKeys(java.lang.Iterable<? extends K> keys)

Specified by:

newWithoutAllKeys in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

newWithoutAllKeys in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

put

public V put(K key,
    V value)

Specified by:

put in interface java.util.Map<K,V>

remove

public V remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<K,V>

flip

public com.gs.collections.api.multimap.sortedset.ImmutableSortedSetMultimap<V,K> flip()

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

flip in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

flip in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

flip in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

tap

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> tap(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

tap in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

tap in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

tap in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

tap in interface com.gs.collections.api.RichIterable<V>

See Also:

InternalIterable.forEach(Procedure)

select

public com.gs.collections.api.list.ImmutableList<V> select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

select in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

select in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

select in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

select in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

select in interface com.gs.collections.api.RichIterable<V>

selectWith

public <P> com.gs.collections.api.list.ImmutableList<V> selectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                          P parameter)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

selectWith in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

selectWith in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

selectWith in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

selectWith in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

selectWith in interface com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> select(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

select in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

select in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

select in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

reject

public com.gs.collections.api.list.ImmutableList<V> reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

reject in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

reject in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

reject in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

reject in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

reject in interface com.gs.collections.api.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 <P> com.gs.collections.api.list.ImmutableList<V> rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                          P parameter)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

rejectWith in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

rejectWith in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

rejectWith in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

rejectWith in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

rejectWith in interface com.gs.collections.api.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)

reject

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> reject(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

reject in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

reject in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

reject in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

partition

public com.gs.collections.api.partition.list.PartitionImmutableList<V> partition(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

partition in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

partition in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

partition in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

partition in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

partition in interface com.gs.collections.api.RichIterable<V>

partitionWith

public <P> com.gs.collections.api.partition.list.PartitionImmutableList<V> partitionWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                                                P parameter)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

partitionWith in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

partitionWith in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

partitionWith in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

partitionWith in interface com.gs.collections.api.RichIterable<V>

selectInstancesOf

public <S> com.gs.collections.api.list.ImmutableList<S> selectInstancesOf(java.lang.Class<S> clazz)

Description copied from interface: com.gs.collections.api.RichIterable

Returns all elements of the source collection that are instances of the Class clazz.

Specified by:

selectInstancesOf in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

selectInstancesOf in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

selectInstancesOf in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

selectInstancesOf in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

selectInstancesOf in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

selectInstancesOf in interface com.gs.collections.api.RichIterable<V>

collect

public <R> com.gs.collections.api.list.ImmutableList<R> collect(com.gs.collections.api.block.function.Function<? super V,? extends R> function)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collect in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collect in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collect in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collect in interface com.gs.collections.api.RichIterable<V>

collectBoolean

public com.gs.collections.api.list.primitive.ImmutableBooleanList collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super V> booleanFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectBoolean in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectBoolean in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectBoolean in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectBoolean in interface com.gs.collections.api.RichIterable<V>

collectByte

public com.gs.collections.api.list.primitive.ImmutableByteList collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super V> byteFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectByte in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectByte in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectByte in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectByte in interface com.gs.collections.api.RichIterable<V>

collectChar

public com.gs.collections.api.list.primitive.ImmutableCharList collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super V> charFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectChar in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectChar in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectChar in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectChar in interface com.gs.collections.api.RichIterable<V>

collectDouble

public com.gs.collections.api.list.primitive.ImmutableDoubleList collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> doubleFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectDouble in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectDouble in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectDouble in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectDouble in interface com.gs.collections.api.RichIterable<V>

collectFloat

public com.gs.collections.api.list.primitive.ImmutableFloatList collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> floatFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectFloat in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectFloat in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectFloat in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectFloat in interface com.gs.collections.api.RichIterable<V>

collectInt

public com.gs.collections.api.list.primitive.ImmutableIntList collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> intFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectInt in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectInt in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectInt in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectInt in interface com.gs.collections.api.RichIterable<V>

collectLong

public com.gs.collections.api.list.primitive.ImmutableLongList collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> longFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectLong in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectLong in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectLong in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectLong in interface com.gs.collections.api.RichIterable<V>

collectShort

public com.gs.collections.api.list.primitive.ImmutableShortList collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super V> shortFunction)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectShort in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectShort in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectShort in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectShort in interface com.gs.collections.api.RichIterable<V>

collect

public <K2,V2> com.gs.collections.api.map.ImmutableMap<K2,V2> collect(com.gs.collections.api.block.function.Function2<? super K,? super V,com.gs.collections.api.tuple.Pair<K2,V2>> function)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

collect in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

collect in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

collectWith

public <P,VV> com.gs.collections.api.list.ImmutableList<VV> collectWith(com.gs.collections.api.block.function.Function2<? super V,? super P,? extends VV> function,
                                                               P parameter)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectWith in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectWith in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectWith in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectWith in interface com.gs.collections.api.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> com.gs.collections.api.list.ImmutableList<R> collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
                                                         com.gs.collections.api.block.function.Function<? super V,? extends R> function)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectIf in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

collectIf in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

collectIf in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

collectIf in interface com.gs.collections.api.RichIterable<V>

collectValues

public <R> com.gs.collections.api.map.sorted.ImmutableSortedMap<K,R> collectValues(com.gs.collections.api.block.function.Function2<? super K,? super V,? extends R> function)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

collectValues in interface com.gs.collections.api.map.MapIterable<K,V>

Specified by:

collectValues in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

collectValues in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

detect

public com.gs.collections.api.tuple.Pair<K,V> detect(com.gs.collections.api.block.predicate.Predicate2<? super K,? super V> predicate)

Description copied from interface: com.gs.collections.api.map.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 com.gs.collections.api.map.MapIterable<K,V>

flatCollect

public <R> com.gs.collections.api.list.ImmutableList<R> flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<R>> function)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

flatCollect in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

flatCollect in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

flatCollect in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

flatCollect in interface com.gs.collections.api.RichIterable<V>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

zip

public <S> com.gs.collections.api.list.ImmutableList<com.gs.collections.api.tuple.Pair<V,S>> zip(java.lang.Iterable<S> that)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

zip in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

zip in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

zip in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

zip in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

zip in interface com.gs.collections.api.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 com.gs.collections.api.list.ImmutableList<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>> zipWithIndex()

Description copied from interface: com.gs.collections.api.RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

zipWithIndex in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

zipWithIndex in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

zipWithIndex in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

zipWithIndex in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

zipWithIndex in interface com.gs.collections.api.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 java.util.SortedMap<K,V> subMap(K fromKey,
                              K toKey)

Specified by:

subMap in interface java.util.SortedMap<K,V>

headMap

public java.util.SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface java.util.SortedMap<K,V>

tailMap

public java.util.SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface java.util.SortedMap<K,V>

groupBy

public <R> com.gs.collections.api.multimap.list.ImmutableListMultimap<R,V> groupBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

groupBy in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

groupBy in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

groupBy in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

groupBy in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

groupBy in interface com.gs.collections.api.RichIterable<V>

groupByEach

public <R> com.gs.collections.api.multimap.list.ImmutableListMultimap<R,V> groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<R>> function)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

groupByEach in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

groupByEach in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

groupByEach in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

groupByEach in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Specified by:

groupByEach in interface com.gs.collections.api.RichIterable<V>

groupByUniqueKey

public <V1> com.gs.collections.api.map.ImmutableMap<V1,V> groupByUniqueKey(com.gs.collections.api.block.function.Function<? super V,? extends V1> function)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

groupByUniqueKey in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

groupByUniqueKey in interface com.gs.collections.api.RichIterable<V>

See Also:

RichIterable.groupBy(Function)

aggregateInPlaceBy

public <K2,V2> com.gs.collections.api.map.ImmutableMap<K2,V2> aggregateInPlaceBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy,
                                                                        com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory,
                                                                        com.gs.collections.api.block.procedure.Procedure2<? super V2,? super V> mutatingAggregator)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

aggregateInPlaceBy in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

aggregateInPlaceBy in interface com.gs.collections.api.RichIterable<V>

aggregateBy

public <K2,V2> com.gs.collections.api.map.ImmutableMap<K2,V2> aggregateBy(com.gs.collections.api.block.function.Function<? super V,? extends K2> groupBy,
                                                                 com.gs.collections.api.block.function.Function0<? extends V2> zeroValueFactory,
                                                                 com.gs.collections.api.block.function.Function2<? super V2,? super V,? extends V2> nonMutatingAggregator)

Description copied from interface: com.gs.collections.api.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 com.gs.collections.api.map.ImmutableMapIterable<K,V>

Specified by:

aggregateBy in interface com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>

Specified by:

aggregateBy in interface com.gs.collections.api.RichIterable<V>

reverseForEach

public void reverseForEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure)

Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.ReversibleIterable<V>

asReversed

public com.gs.collections.api.LazyIterable<V> asReversed()

Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable

Returns a reversed view of this ReversibleIterable.

Specified by:

asReversed in interface com.gs.collections.api.ordered.ReversibleIterable<V>

toReversed

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> toReversed()

Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable

Returns a new ReversibleIterable in reverse order.

Specified by:

toReversed in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

toReversed in interface com.gs.collections.api.ordered.ReversibleIterable<V>

detectLastIndex

public int detectLastIndex(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.ReversibleIterable<V>

takeWhile

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> takeWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable

Returns the initial elements that satisfy the Predicate. Short circuits at the first element which does not satisfy the Predicate.

Specified by:

takeWhile in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

takeWhile in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

takeWhile in interface com.gs.collections.api.ordered.ReversibleIterable<V>

dropWhile

public com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V> dropWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.ordered.ReversibleIterable

Returns the final elements that do not satisfy the Predicate. Short circuits at the first element which does satisfy the Predicate.

Specified by:

dropWhile in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

dropWhile in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

dropWhile in interface com.gs.collections.api.ordered.ReversibleIterable<V>

partitionWhile

public com.gs.collections.api.partition.list.PartitionImmutableList<V> partitionWhile(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.ordered.OrderedIterable

Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements. Short circuits at the first element which does satisfy the Predicate.

Specified by:

partitionWhile in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

partitionWhile in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

partitionWhile in interface com.gs.collections.api.ordered.ReversibleIterable<V>

distinct

public com.gs.collections.api.list.ImmutableList<V> distinct()

Description copied from interface: com.gs.collections.api.ordered.OrderedIterable

Returns a new OrderedIterable containing the distinct elements in this iterable.

Conceptually similar to RichIterable.toSet().RichIterable.toList() but retains the original order. If an element appears multiple times in this iterable, the first one will be copied into the result.

Specified by:

distinct in interface com.gs.collections.api.map.sorted.SortedMapIterable<K,V>

Specified by:

distinct in interface com.gs.collections.api.ordered.OrderedIterable<V>

Specified by:

distinct in interface com.gs.collections.api.ordered.ReversibleIterable<V>

Returns:

OrderedIterable of distinct elements

indexOf

public int indexOf(java.lang.Object object)

Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.OrderedIterable<V>

See Also:

List.indexOf(Object)

corresponds

public <S> boolean corresponds(com.gs.collections.api.ordered.OrderedIterable<S> other,
                      com.gs.collections.api.block.predicate.Predicate2<? super V,? super S> predicate)

Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.OrderedIterable<V>

forEach

public void forEach(int startIndex,
           int endIndex,
           com.gs.collections.api.block.procedure.Procedure<? super V> procedure)

Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.OrderedIterable<V>

forEachWithIndex

public void forEachWithIndex(int fromIndex,
                    int toIndex,
                    com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super V> objectIntProcedure)

Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.OrderedIterable<V>

toStack

public com.gs.collections.api.stack.MutableStack<V> toStack()

Description copied from interface: com.gs.collections.api.ordered.OrderedIterable

Converts the OrderedIterable to a mutable MutableStack implementation.

Specified by:

toStack in interface com.gs.collections.api.ordered.OrderedIterable<V>

detectIndex

public int detectIndex(com.gs.collections.api.block.predicate.Predicate<? super V> predicate)

Description copied from interface: com.gs.collections.api.ordered.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 com.gs.collections.api.ordered.OrderedIterable<V>