com.gs.collections.impl.map.sorted.mutable

Class UnmodifiableTreeMap<K,V>

java.lang.Object

com.gs.collections.impl.UnmodifiableMap<K,V>

com.gs.collections.impl.map.sorted.mutable.UnmodifiableSortedMap<K,V>

com.gs.collections.impl.map.sorted.mutable.UnmodifiableTreeMap<K,V>

All Implemented Interfaces:

com.gs.collections.api.InternalIterable<V>, com.gs.collections.api.map.MapIterable<K,V>, com.gs.collections.api.map.sorted.MutableSortedMap<K,V>, com.gs.collections.api.map.sorted.SortedMapIterable<K,V>, com.gs.collections.api.RichIterable<V>, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<V>, java.util.Map<K,V>, java.util.SortedMap<K,V>

public class UnmodifiableTreeMap<K,V>
extends UnmodifiableSortedMap<K,V>
implements com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

An unmodifiable view of a map.

See Also:

MutableSortedMap.asUnmodifiable(), Serialized Form

Nested Class Summary

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

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

Field Summary

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

delegate

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UnmodifiableTreeMap(com.gs.collections.api.map.sorted.MutableSortedMap<K,V> map)

Method Summary

Methods

Modifier and Type	Method and Description
<K2,V2> com.gs.collections.api.map.MutableMap<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.MutableMap<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.
boolean	allSatisfy(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
<P> boolean	allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter) Returns true if the predicate evaluates to true for every element of the collection, or returns false.
boolean	anySatisfy(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns true if the predicate evaluates to true for any element of the iterable.
<P> boolean	anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter) Returns true if the predicate evaluates to true for any element of the collection, or return false.
void	appendString(java.lang.Appendable appendable) Prints a string representation of this collection onto the given Appendable.
void	appendString(java.lang.Appendable appendable, java.lang.String separator) Prints a string representation of this collection onto the given Appendable.
void	appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end) Prints a string representation of this collection onto the given Appendable.
com.gs.collections.api.LazyIterable<V>	asLazy() Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	asSynchronized() Returns a synchronized (thread-safe) map backed by the specified map.
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	asUnmodifiable() Returns an unmodifiable view of this map.
com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<V>>	chunk(int size) Partitions elements in fixed size chunks.
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	clone()
<R> com.gs.collections.api.list.MutableList<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.
<R,C extends java.util.Collection<R>> C	collect(com.gs.collections.api.block.function.Function<? super V,? extends R> function, C target) Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.
<K2,V2> com.gs.collections.api.map.MutableMap<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.MutableBooleanList	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.
<R extends com.gs.collections.api.collection.primitive.MutableBooleanCollection> R	collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super V> booleanFunction, R target) Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.
com.gs.collections.api.list.primitive.MutableByteList	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.
<R extends com.gs.collections.api.collection.primitive.MutableByteCollection> R	collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super V> byteFunction, R target) Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.
com.gs.collections.api.list.primitive.MutableCharList	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.
<R extends com.gs.collections.api.collection.primitive.MutableCharCollection> R	collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super V> charFunction, R target) Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.
com.gs.collections.api.list.primitive.MutableDoubleList	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.
<R extends com.gs.collections.api.collection.primitive.MutableDoubleCollection> R	collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> doubleFunction, R target) Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.
com.gs.collections.api.list.primitive.MutableFloatList	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 extends com.gs.collections.api.collection.primitive.MutableFloatCollection> R	collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> floatFunction, R target) Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.
<R> com.gs.collections.api.list.MutableList<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.
<R,C extends java.util.Collection<R>> C	collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, com.gs.collections.api.block.function.Function<? super V,? extends R> function, C target) Same as the collectIf method with two parameters but uses the specified target collection for the results.
com.gs.collections.api.list.primitive.MutableIntList	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.
<R extends com.gs.collections.api.collection.primitive.MutableIntCollection> R	collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> intFunction, R target) Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.
<E> com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	collectKeysAndValues(java.lang.Iterable<E> iterable, com.gs.collections.api.block.function.Function<? super E,? extends K> keyFunction, com.gs.collections.api.block.function.Function<? super E,? extends V> valueFunction) Adds all the entries derived from iterable to this.
com.gs.collections.api.list.primitive.MutableLongList	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.
<R extends com.gs.collections.api.collection.primitive.MutableLongCollection> R	collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> longFunction, R target) Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.
com.gs.collections.api.list.primitive.MutableShortList	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 extends com.gs.collections.api.collection.primitive.MutableShortCollection> R	collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super V> shortFunction, R target) Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.
<R> com.gs.collections.api.map.sorted.MutableSortedMap<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,R,C extends java.util.Collection<R>> C	collectWith(com.gs.collections.api.block.function.Function2<? super V,? super P,? extends R> function, P parameter, C targetCollection) Same as collectWith but with a targetCollection parameter to gather the results.
<P,VV> com.gs.collections.api.list.MutableList<VV>	collectWith(com.gs.collections.api.block.function.Function2<? super V,? super P,? extends VV> function, P parameter) Same as collect with a Function2 and specified parameter which is passed to the block
boolean	contains(java.lang.Object object) Returns true if the iterable has an element which responds true to element.equals(object).
boolean	containsAll(java.util.Collection<?> source) Returns true if all elements in source are contained in this collection.
boolean	containsAllArguments(java.lang.Object... elements) Returns true if all elements in the specified var arg array are contained in this collection.
boolean	containsAllIterable(java.lang.Iterable<?> source) Returns true if all elements in source are contained in this collection.
int	count(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Return the total number of elements that answer true to the specified predicate.
<P> int	countWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter) Returns the total number of elements that evaluate to true for the specified predicate.
V	detect(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true.
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.
V	detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, com.gs.collections.api.block.function.Function0<? extends V> function) Returns the first element of the iterable for which the predicate evaluates to true.
<P> V	detectWith(com.gs.collections.api.block.predicate.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(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter, com.gs.collections.api.block.function.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.
com.gs.collections.api.set.MutableSet<java.util.Map.Entry<K,V>>	entrySet()
boolean	equals(java.lang.Object obj) Follows the same general contract as Map.equals(Object).
<R> com.gs.collections.api.list.MutableList<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).
<R,C extends java.util.Collection<R>> C	flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<R>> function, C target) Same as flatCollect, only the results are collected into the target collection.
com.gs.collections.api.multimap.sortedset.MutableSortedSetMultimap<V,K>	flip() Given a map from Domain -> Range return a multimap from Range -> Domain.
com.gs.collections.api.map.MapIterable<V,K>	flipUniqueValues() Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEach(com.gs.collections.api.block.procedure.Procedure<? super V> procedure) The procedure is executed for each element in the iterable.
void	forEachKey(com.gs.collections.api.block.procedure.Procedure<? super K> procedure) Calls the procedure with each key of the map.
void	forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<? super K,? super V> procedure) Calls the procedure with each key-value pair of the map.
void	forEachValue(com.gs.collections.api.block.procedure.Procedure<? super V> procedure) Calls the procedure with each value of the map.
<P> void	forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super V,? super P> procedure, P parameter) The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.
void	forEachWithIndex(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super V> objectIntProcedure) Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure
V	getFirst() Returns the first element of an iterable.
V	getIfAbsent(K key, com.gs.collections.api.block.function.Function0<? extends V> function) Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified Function0.
V	getIfAbsentPut(K key, com.gs.collections.api.block.function.Function0<? extends V> function) Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified Function0, and put that value in the map at the specified key.
<P> V	getIfAbsentPutWith(K key, com.gs.collections.api.block.function.Function<? super P,? extends V> function, P parameter) Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified one argument Function using the specified parameter, and put that value in the map at the specified key.
V	getIfAbsentPutWithKey(K key, com.gs.collections.api.block.function.Function<? super K,? extends V> function) Get and return the value in the Map at the specified key.
V	getIfAbsentValue(K key, V value) Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return value.
<P> V	getIfAbsentWith(K key, com.gs.collections.api.block.function.Function<? super P,? extends V> function, P parameter) Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified function and parameter.
V	getLast() Returns the last element of an iterable.
protected com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	getMutableSortedMap()
<R> com.gs.collections.api.multimap.list.MutableListMultimap<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,C extends com.gs.collections.api.multimap.MutableMultimap<R,V>> C	groupBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function, C target) Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
<R> com.gs.collections.api.multimap.list.MutableListMultimap<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.
<R,C extends com.gs.collections.api.multimap.MutableMultimap<R,V>> C	groupByEach(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<R>> function, C target) Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
<VV> com.gs.collections.api.map.MutableMap<VV,V>	groupByUniqueKey(com.gs.collections.api.block.function.Function<? super V,? extends VV> function) For each element of the iterable, the function is evaluated and he results of these evaluations are collected into a new map, where the transformed value is the key.
int	hashCode() Follows the same general contract as Map.hashCode().
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	headMap(K toKey)
<A> A	ifPresentApply(K key, com.gs.collections.api.block.function.Function<? super V,? extends A> function) If there is a value in the Map that corresponds to the specified key return the result of applying the specified Function on the value, otherwise return null.
double	injectInto(double injectedValue, com.gs.collections.api.block.function.primitive.DoubleObjectToDoubleFunction<? super V> function) Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
float	injectInto(float injectedValue, com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super V> function) Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
int	injectInto(int injectedValue, com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super V> function) Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
<IV> IV	injectInto(IV injectedValue, com.gs.collections.api.block.function.Function2<? super IV,? super V,? extends IV> function) Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
long	injectInto(long injectedValue, com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super V> function) Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
java.util.Iterator<V>	iterator()
com.gs.collections.api.set.MutableSet<K>	keySet() The underlying set for the keys is sorted in ascending order according to their natural ordering or a custom comparator.
com.gs.collections.api.RichIterable<K>	keysView() Returns an unmodifiable lazy iterable wrapped around the keySet for the map
com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,V>>	keyValuesView() Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map
java.lang.String	makeString() Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
java.lang.String	makeString(java.lang.String separator) Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
java.lang.String	makeString(java.lang.String start, java.lang.String separator, java.lang.String end) Returns a string representation of this collection.
V	max() Returns the maximum element out of this container based on the natural order.
V	max(java.util.Comparator<? super V> comparator) Returns the maximum element out of this container based on the comparator.
<R extends java.lang.Comparable<? super R>> V	maxBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function) Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
V	min() Returns the minimum element out of this container based on the natural order.
V	min(java.util.Comparator<? super V> comparator) Returns the minimum element out of this container based on the comparator.
<R extends java.lang.Comparable<? super R>> V	minBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function) Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	newEmpty() Creates a new instance of the same type with the same internal Comparator.
boolean	noneSatisfy(com.gs.collections.api.block.predicate.Predicate<? super V> predicate) Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
<P> boolean	noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter) Returns true if the predicate evaluates to false for every element of the collection, or return false.
boolean	notEmpty() The English equivalent of !this.isEmpty()
static <K,V,M extends java.util.SortedMap<K,V>> UnmodifiableTreeMap<K,V>	of(M map) This method will take a MutableSortedMap and wrap it directly in a UnmodifiableMutableMap.
com.gs.collections.api.partition.list.PartitionMutableList<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.
<P> com.gs.collections.api.partition.list.PartitionMutableList<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.
com.gs.collections.api.list.MutableList<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.
<R extends java.util.Collection<V>> R	reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, R target) Same as the reject method with one parameter but uses the specified target collection for the results.
com.gs.collections.api.map.sorted.MutableSortedMap<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.MutableList<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.
<P,R extends java.util.Collection<V>> R	rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter, R targetCollection) Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
V	removeKey(K key) Remove an entry from the map at the specified key.
com.gs.collections.api.list.MutableList<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.
<R extends java.util.Collection<V>> R	select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate, R target) Same as the select method with one parameter but uses the specified target collection for the results.
com.gs.collections.api.map.sorted.MutableSortedMap<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.MutableList<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.MutableList<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.
<P,R extends java.util.Collection<V>> R	selectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate, P parameter, R targetCollection) Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	subMap(K fromKey, K toKey)
double	sumOfDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> function) Returns the final double result of evaluating function for each element of the iterable and adding the results together.
double	sumOfFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> function) Returns the final double result of evaluating function for each element of the iterable and adding the results together.
long	sumOfInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> function) Returns the final long result of evaluating function for each element of the iterable and adding the results together.
long	sumOfLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> function) Returns the final long result of evaluating function for each element of the iterable and adding the results together.
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	tailMap(K fromKey)
java.lang.Object[]	toArray() Converts this iterable to an array.
<T> T[]	toArray(T[] a) Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
com.gs.collections.api.bag.MutableBag<V>	toBag() Converts the collection to the default MutableBag implementation.
com.gs.collections.api.map.sorted.ImmutableSortedMap<K,V>	toImmutable() Returns an immutable copy of this map.
com.gs.collections.api.list.MutableList<V>	toList() Converts the collection to a MutableList implementation.
<NK,NV> com.gs.collections.api.map.MutableMap<NK,NV>	toMap(com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction, com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction) Converts the collection to a MutableMap implementation using the specified key and value functions.
com.gs.collections.api.set.MutableSet<V>	toSet() Converts the collection to a MutableSet implementation.
com.gs.collections.api.list.MutableList<V>	toSortedList() Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
com.gs.collections.api.list.MutableList<V>	toSortedList(java.util.Comparator<? super V> comparator) Converts the collection to a MutableList implementation and sorts it using the specified comparator.
<R extends java.lang.Comparable<? super R>> com.gs.collections.api.list.MutableList<V>	toSortedListBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function) Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by function.
<NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV>	toSortedMap(java.util.Comparator<? super NK> comparator, com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction, com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction) Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
<NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV>	toSortedMap(com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction, com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction) Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
com.gs.collections.api.set.sorted.MutableSortedSet<V>	toSortedSet() Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
com.gs.collections.api.set.sorted.MutableSortedSet<V>	toSortedSet(java.util.Comparator<? super V> comparator) Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
<R extends java.lang.Comparable<? super R>> com.gs.collections.api.set.sorted.MutableSortedSet<V>	toSortedSetBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function) Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.
com.gs.collections.api.collection.MutableCollection<V>	values()
com.gs.collections.api.RichIterable<V>	valuesView() Returns an unmodifiable lazy iterable wrapped around the values for the map
com.gs.collections.api.map.sorted.MutableSortedMap<K,V>	with(com.gs.collections.api.tuple.Pair<K,V>... pairs)
<S> com.gs.collections.api.list.MutableList<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.
<S,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<V,S>>> R	zip(java.lang.Iterable<S> that, R target) Same as RichIterable.zip(Iterable) but uses target for output.
com.gs.collections.api.list.MutableList<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>>	zipWithIndex() Zips this RichIterable with its indices.
<R extends java.util.Collection<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>>> R	zipWithIndex(R target) Same as RichIterable.zipWithIndex() but uses target for output.

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

comparator, firstKey, getSortedMap, lastKey

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

clear, containsKey, containsValue, get, isEmpty, put, putAll, remove, size, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

comparator

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

containsKey, containsValue, get, toString

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

isEmpty, size

Methods inherited from interface java.util.SortedMap

comparator, firstKey, lastKey

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, get, isEmpty, put, putAll, remove, size

Constructor Detail

UnmodifiableTreeMap

protected UnmodifiableTreeMap(com.gs.collections.api.map.sorted.MutableSortedMap<K,V> map)

Method Detail

of

public static <K,V,M extends java.util.SortedMap<K,V>> UnmodifiableTreeMap<K,V> of(M map)

This method will take a MutableSortedMap and wrap it directly in a UnmodifiableMutableMap. It will take any other non-GS-SortedMap and first adapt it will a SortedMapAdapter, and then return a UnmodifiableSortedMap that wraps the adapter.

removeKey

public V removeKey(K key)

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

Remove an entry from the map at the specified key.

Specified by:

removeKey in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Returns:

The value removed from entry at key, or null if not found.

See Also:

Map.remove(Object)

with

public com.gs.collections.api.map.sorted.MutableSortedMap<K,V> with(com.gs.collections.api.tuple.Pair<K,V>... pairs)

Specified by:

with in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

collectKeysAndValues

public <E> com.gs.collections.api.map.sorted.MutableSortedMap<K,V> collectKeysAndValues(java.lang.Iterable<E> iterable,
                                                                               com.gs.collections.api.block.function.Function<? super E,? extends K> keyFunction,
                                                                               com.gs.collections.api.block.function.Function<? super E,? extends V> valueFunction)

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

Adds all the entries derived from iterable to this. The key and value for each entry is determined by applying the keyFunction and valueFunction to each item in collection. Any entry in map that has the same key as an entry in this will have it's value replaced by that in map.

Specified by:

collectKeysAndValues in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

getIfAbsentPut

public V getIfAbsentPut(K key,
               com.gs.collections.api.block.function.Function0<? extends V> function)

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

Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified Function0, and put that value in the map at the specified key.

Specified by:

getIfAbsentPut in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

getIfAbsentPutWithKey

public V getIfAbsentPutWithKey(K key,
                      com.gs.collections.api.block.function.Function<? super K,? extends V> function)

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

Get and return the value in the Map at the specified key. Alternatively, if there is no value in the map for that key return the result of evaluating the specified Function using the specified key, and put that value in the map at the specified key.

Specified by:

getIfAbsentPutWithKey in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

getIfAbsentPutWith

public <P> V getIfAbsentPutWith(K key,
                       com.gs.collections.api.block.function.Function<? super P,? extends V> function,
                       P parameter)

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

Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified one argument Function using the specified parameter, and put that value in the map at the specified key.

Specified by:

getIfAbsentPutWith in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

getIfAbsent

public V getIfAbsent(K key,
            com.gs.collections.api.block.function.Function0<? extends V> function)

Description copied from interface: com.gs.collections.api.map.MapIterable

Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified Function0.

Specified by:

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

getIfAbsentValue

public V getIfAbsentValue(K key,
                 V value)

Description copied from interface: com.gs.collections.api.map.MapIterable

Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return value.

Specified by:

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

getIfAbsentWith

public <P> V getIfAbsentWith(K key,
                    com.gs.collections.api.block.function.Function<? super P,? extends V> function,
                    P parameter)

Description copied from interface: com.gs.collections.api.map.MapIterable

Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified function and parameter.

Specified by:

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

flip

public com.gs.collections.api.multimap.sortedset.MutableSortedSetMultimap<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.MapIterable<K,V>

Specified by:

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

Specified by:

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

clone

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

Specified by:

clone in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Overrides:

clone in class java.lang.Object

asUnmodifiable

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

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

Returns an unmodifiable view of this map. This method allows modules to provide users with "read-only" access to internal maps. Any query operations on the returned map that "read through" to this map and attempt to modify the returned map, whether direct or via its iterator, result in an UnsupportedOperationException.

The returned map will be Serializable if this map is Serializable.

Specified by:

asUnmodifiable in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Returns:

an unmodifiable view of this map.

asSynchronized

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

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

Returns a synchronized (thread-safe) map backed by the specified map. In order to guarantee serial access, it is critical that all access to the backing map is accomplished through the returned map.

It is imperative that the user manually synchronize on the returned map when iterating over any of its collection views:

  MutableMap map = myMutableMap.asSynchronized();
      ...
  Set set = map.keySet();  // Needn't be in synchronized block
      ...
  synchronized(map)
  {  // Synchronizing on map, not set!
      Iterator i = s.iterator(); // Must be in synchronized block
      while (i.hasNext())
          foo(i.next());
  }
 

Failure to follow this advice may result in non-deterministic behavior.

The preferred way of iterating over a synchronized collection is to use the collection.forEach() method which is properly synchronized internally.

  MutableMap map = myMutableMap.asSynchronized();
      ...
  Set set = map.keySet();  // Needn't be in synchronized block
     ...
  Iterate.forEach(set, new Procedure()
  {
      public void value(Object each)
      {
          ...
      }
  });
 

The returned map will be serializable if the specified map is serializable.

Specified by:

asSynchronized in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

toImmutable

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

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

Returns an immutable copy of this map. If the map is immutable, it returns itself.

The returned map will be Serializable if this map is Serializable.

Specified by:

toImmutable in interface com.gs.collections.api.map.sorted.MutableSortedMap<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>

hashCode

public int hashCode()

Description copied from interface: com.gs.collections.api.map.MapIterable

Follows the same general contract as Map.hashCode().

Specified by:

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

Specified by:

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

Overrides:

hashCode in class UnmodifiableMap<K,V>

equals

public boolean equals(java.lang.Object obj)

Description copied from interface: com.gs.collections.api.map.MapIterable

Follows the same general contract as Map.equals(Object).

Specified by:

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

Specified by:

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

Overrides:

equals in class UnmodifiableMap<K,V>

keysView

public com.gs.collections.api.RichIterable<K> keysView()

Description copied from interface: com.gs.collections.api.map.MapIterable

Returns an unmodifiable lazy iterable wrapped around the keySet for the map

Specified by:

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

valuesView

public com.gs.collections.api.RichIterable<V> valuesView()

Description copied from interface: com.gs.collections.api.map.MapIterable

Returns an unmodifiable lazy iterable wrapped around the values for the map

Specified by:

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

keyValuesView

public com.gs.collections.api.RichIterable<com.gs.collections.api.tuple.Pair<K,V>> keyValuesView()

Description copied from interface: com.gs.collections.api.map.MapIterable

Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map

Specified by:

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

getMutableSortedMap

protected com.gs.collections.api.map.sorted.MutableSortedMap<K,V> getMutableSortedMap()

newEmpty

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

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

Creates a new instance of the same type with the same internal Comparator.

Specified by:

newEmpty in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

notEmpty

public boolean notEmpty()

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

The English equivalent of !this.isEmpty()

Specified by:

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

forEachValue

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

Description copied from interface: com.gs.collections.api.map.MapIterable

Calls the procedure with each value of the map.

     Set<String> result = UnifiedSet.newSet();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three", 4, "Four");
     map.forEachValue(new CollectionAddProcedure<String>(result));
     Verify.assertSetsEqual(UnifiedSet.newSetWith("One", "Two", "Three", "Four"), result);
 

Specified by:

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

forEachKey

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

Description copied from interface: com.gs.collections.api.map.MapIterable

Calls the procedure with each key of the map.

     final Collection<Integer> result = new ArrayList<Integer>();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     map.forEachKey(new CollectionAddProcedure<Integer>(result));
     Verify.assertContainsAll(result, 1, 2, 3);
 

Specified by:

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

forEachKeyValue

public void forEachKeyValue(com.gs.collections.api.block.procedure.Procedure2<? super K,? super V> procedure)

Description copied from interface: com.gs.collections.api.map.MapIterable

Calls the procedure with each key-value pair of the map.

     final Collection<String> collection = new ArrayList<String>();
     MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three");
     map.forEachKeyValue(new Procedure2<Integer, String>()
     {
         public void value(final Integer key, final String value)
         {
             collection.add(String.valueOf(key) + value);
         }
     });
     Verify.assertContainsAll(collection, "1One", "2Two", "3Three");
 

Specified by:

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

flipUniqueValues

public com.gs.collections.api.map.MapIterable<V,K> flipUniqueValues()

Description copied from interface: com.gs.collections.api.map.MapIterable

Return the MapIterable that is obtained by flipping the direction of this map and making the associations from value to key.

     MapIterable map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3");
     MapIterable result = map.flipUniqueValues();
     Assert.assertTrue(result.equals(UnifiedMap.newWithKeysValues("1", 1, "2", 2, "3", 3)));
 

Specified by:

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

ifPresentApply

public <A> A ifPresentApply(K key,
                   com.gs.collections.api.block.function.Function<? super V,? extends A> function)

Description copied from interface: com.gs.collections.api.map.MapIterable

If there is a value in the Map that corresponds to the specified key return the result of applying the specified Function on the value, otherwise return null.

Specified by:

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

forEach

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

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

The procedure is executed for each element in the iterable.

e.g.
 people.forEach(new Procedure()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

Specified by:

forEach in interface com.gs.collections.api.InternalIterable<V>

forEachWithIndex

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

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

Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure

e.g.
 people.forEachWithIndex(new ObjectIntProcedure()
 {
     public void value(Person person, int index)
     {
         LOGGER.info("Index: " + index + " person: " + person.getName());
     }
 });
 

Specified by:

forEachWithIndex in interface com.gs.collections.api.InternalIterable<V>

forEachWith

public <P> void forEachWith(com.gs.collections.api.block.procedure.Procedure2<? super V,? super P> procedure,
                   P parameter)

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

The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.

e.g.
 people.forEachWith(new Procedure2()
 {
     public void value(Person person, Person other)
     {
         if (person.isRelatedTo(other))
         {
              LOGGER.info(person.getName());
         }
     }
 }, fred);
 

Specified by:

forEachWith in interface com.gs.collections.api.InternalIterable<V>

collectValues

public <R> com.gs.collections.api.map.sorted.MutableSortedMap<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.MapIterable<K,V>

Specified by:

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

Specified by:

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

collect

public <K2,V2> com.gs.collections.api.map.MutableMap<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.MapIterable<K,V>

Specified by:

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

select

public com.gs.collections.api.map.sorted.MutableSortedMap<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.MapIterable<K,V>

Specified by:

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

Specified by:

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

reject

public com.gs.collections.api.map.sorted.MutableSortedMap<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.MapIterable<K,V>

Specified by:

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

Specified by:

reject 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>

anySatisfy

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

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

Returns true if the predicate evaluates to true for any element of the iterable. Returns false if the iterable is empty, or if no element returned true when evaluating the predicate.

Specified by:

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

anySatisfyWith

public <P> boolean anySatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                         P parameter)

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

Returns true if the predicate evaluates to true for any element of the collection, or return false. Returns false if the collection is empty.

Specified by:

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

allSatisfy

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

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

Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

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

allSatisfyWith

public <P> boolean allSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                         P parameter)

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

Returns true if the predicate evaluates to true for every element of the collection, or returns false.

Specified by:

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

noneSatisfy

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

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

Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty. Otherwise, returns false.

Specified by:

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

noneSatisfyWith

public <P> boolean noneSatisfyWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                          P parameter)

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

Returns true if the predicate evaluates to false for every element of the collection, or return false. Returns true if the collection is empty.

Specified by:

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

appendString

public void appendString(java.lang.Appendable appendable)

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

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString().

Specified by:

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

appendString

public void appendString(java.lang.Appendable appendable,
                java.lang.String separator)

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

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String).

Specified by:

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

appendString

public void appendString(java.lang.Appendable appendable,
                java.lang.String start,
                java.lang.String separator,
                java.lang.String end)

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

Prints a string representation of this collection onto the given Appendable. Prints the string returned by RichIterable.makeString(String, String, String).

Specified by:

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

toBag

public com.gs.collections.api.bag.MutableBag<V> toBag()

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

Converts the collection to the default MutableBag implementation.

Specified by:

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

asLazy

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

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

Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).

Specified by:

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

toList

public com.gs.collections.api.list.MutableList<V> toList()

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

Converts the collection to a MutableList implementation.

Specified by:

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

toMap

public <NK,NV> com.gs.collections.api.map.MutableMap<NK,NV> toMap(com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction,
                                                         com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction)

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

Converts the collection to a MutableMap implementation using the specified key and value functions.

Specified by:

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

toSortedMap

public <NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV> toSortedMap(com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction,
                                                                            com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction)

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

Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.

Specified by:

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

toSortedMap

public <NK,NV> com.gs.collections.api.map.sorted.MutableSortedMap<NK,NV> toSortedMap(java.util.Comparator<? super NK> comparator,
                                                                            com.gs.collections.api.block.function.Function<? super V,? extends NK> keyFunction,
                                                                            com.gs.collections.api.block.function.Function<? super V,? extends NV> valueFunction)

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

Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.

Specified by:

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

toSet

public com.gs.collections.api.set.MutableSet<V> toSet()

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

Converts the collection to a MutableSet implementation.

Specified by:

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

toSortedList

public com.gs.collections.api.list.MutableList<V> toSortedList()

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

Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.

Specified by:

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

toSortedList

public com.gs.collections.api.list.MutableList<V> toSortedList(java.util.Comparator<? super V> comparator)

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

Converts the collection to a MutableList implementation and sorts it using the specified comparator.

Specified by:

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

toSortedListBy

public <R extends java.lang.Comparable<? super R>> com.gs.collections.api.list.MutableList<V> toSortedListBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function)

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

Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by function.

Specified by:

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

toSortedSet

public com.gs.collections.api.set.sorted.MutableSortedSet<V> toSortedSet()

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

Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.

Specified by:

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

toSortedSet

public com.gs.collections.api.set.sorted.MutableSortedSet<V> toSortedSet(java.util.Comparator<? super V> comparator)

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

Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.

Specified by:

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

toSortedSetBy

public <R extends java.lang.Comparable<? super R>> com.gs.collections.api.set.sorted.MutableSortedSet<V> toSortedSetBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function)

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

Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.

Specified by:

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

chunk

public com.gs.collections.api.RichIterable<com.gs.collections.api.RichIterable<V>> chunk(int size)

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

Partitions elements in fixed size chunks.

Specified by:

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

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing RichIterables of size size, except the last will be truncated if the elements don't divide evenly.

collect

public <R,C extends java.util.Collection<R>> C collect(com.gs.collections.api.block.function.Function<? super V,? extends R> function,
                                              C target)

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

Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.

e.g.
 return people.collect(new Function<Person, String>()
 {
     public String valueOf(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 }, Lists.mutable.of());
 

Specified by:

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

Parameters:

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

target, which contains appended elements as a result of the collect transformation

See Also:

RichIterable.collect(Function)

collectIf

public <R,C extends java.util.Collection<R>> C collectIf(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
                                                com.gs.collections.api.block.function.Function<? super V,? extends R> function,
                                                C target)

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

Same as the collectIf method with two parameters but uses the specified target collection for the results.

Specified by:

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

Parameters:

predicate - a Predicate to use as the select criteria

function - a Function to use as the collect transformation function

target - the Collection to append to for all elements in this RichIterable that meet the collect criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the collect criteria and transformation

See Also:

RichIterable.collectIf(Predicate, Function)

collectWith

public <P,VV> com.gs.collections.api.list.MutableList<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 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 com.gs.collections.api.map.sorted.MutableSortedMap<K,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)

collectWith

public <P,R,C extends java.util.Collection<R>> C collectWith(com.gs.collections.api.block.function.Function2<? super V,? super P,? extends R> function,
                                                    P parameter,
                                                    C targetCollection)

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

Same as collectWith but with a targetCollection parameter to gather the results.

e.g.
 Function2 addParameterFunction =
 new Function2()
 {
      public Integer value(final Integer each, final Integer parameter)
      {
          return each + parameter;
      }
 };
 FastList.newListWith(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), UnifiedSet.newSet());
 

Specified by:

collectWith in interface 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

targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria function

Returns:

targetCollection, which contains appended elements as a result of the collect transformation

contains

public boolean contains(java.lang.Object object)

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

Returns true if the iterable has an element which responds true to element.equals(object).

Specified by:

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

containsAllArguments

public boolean containsAllArguments(java.lang.Object... elements)

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

Returns true if all elements in the specified var arg array are contained in this collection.

Specified by:

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

containsAllIterable

public boolean containsAllIterable(java.lang.Iterable<?> source)

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

Returns true if all elements in source are contained in this collection.

Specified by:

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

containsAll

public boolean containsAll(java.util.Collection<?> source)

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

Returns true if all elements in source are contained in this collection.

Specified by:

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

See Also:

Collection.containsAll(Collection)

count

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

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

Return the total number of elements that answer true to the specified predicate.

e.g.
 return people.count(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getAddress().getState().getName().equals("New York");
     }
 });
 

Specified by:

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

countWith

public <P> int countWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                P parameter)

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

Returns the total number of elements that evaluate to true for the specified predicate.

e.g.
 return lastNames.countWith(PredicatesLite.equal(), "Smith");
 

Specified by:

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

detect

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

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

Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.

e.g.
 return people.detect(new Predicate<Person>()
 {
     public boolean value(Person person)
     {
         return person.getFirstName().equals("John") && person.getLastName().equals("Smith");
     }
 });
 

Specified by:

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

detectWith

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

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

detectIfNone

public V detectIfNone(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
             com.gs.collections.api.block.function.Function0<? extends V> function)

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

Returns the first element of the iterable for which the predicate evaluates to true. If no element matches the predicate, then returns the value of applying the specified function.

Specified by:

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

detectWithIfNone

public <P> V detectWithIfNone(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                     P parameter,
                     com.gs.collections.api.block.function.Function0<? extends V> function)

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

flatCollect

public <R,C extends java.util.Collection<R>> C flatCollect(com.gs.collections.api.block.function.Function<? super V,? extends java.lang.Iterable<R>> function,
                                                  C target)

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

Same as flatCollect, only the results are collected into the target collection.

Specified by:

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

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

target, which will contain a flattened collection of results produced by applying the given function

See Also:

RichIterable.flatCollect(Function)

getFirst

public V getFirst()

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

Returns the first element of an iterable. In the case of a List it is the element at the first index. In the case of any other Collection, it is the first element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the first element could be any element from the Set.

Specified by:

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

getLast

public V getLast()

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

Returns the last element of an iterable. In the case of a List it is the element at the last index. In the case of any other Collection, it is the last element that would be returned during an iteration. If the iterable is empty, null is returned. If null is a valid element of the container, then a developer would need to check to see if the iterable is empty to validate that a null result was not due to the container being empty.

The order of Sets are not guaranteed (except for TreeSets and other Ordered Set implementations), so if you use this method, the last element could be any element from the Set.

Specified by:

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

groupBy

public <R> com.gs.collections.api.multimap.list.MutableListMultimap<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.

e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 });
 

Specified by:

groupBy in interface com.gs.collections.api.map.sorted.MutableSortedMap<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.RichIterable<V>

groupBy

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

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

Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.

e.g.
 return people.groupBy(new Function<Person, String>()
 {
     public String value(Person person)
     {
         return person.getFirstName() + " " + person.getLastName();
     }
 }, new FastListMultimap<String, Person>());
 

Specified by:

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

groupByEach

public <R> com.gs.collections.api.multimap.list.MutableListMultimap<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.sorted.MutableSortedMap<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.RichIterable<V>

groupByEach

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

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

Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.

Specified by:

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

groupByUniqueKey

public <VV> com.gs.collections.api.map.MutableMap<VV,V> groupByUniqueKey(com.gs.collections.api.block.function.Function<? super V,? extends VV> 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.sorted.MutableSortedMap<K,V>

Specified by:

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

See Also:

RichIterable.groupBy(Function)

injectInto

public <IV> IV injectInto(IV injectedValue,
                 com.gs.collections.api.block.function.Function2<? super IV,? super V,? extends IV> function)

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

Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter. This method is commonly called fold or sometimes reduce.

Specified by:

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

injectInto

public int injectInto(int injectedValue,
             com.gs.collections.api.block.function.primitive.IntObjectToIntFunction<? super V> function)

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

Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

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

injectInto

public long injectInto(long injectedValue,
              com.gs.collections.api.block.function.primitive.LongObjectToLongFunction<? super V> function)

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

Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

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

injectInto

public double injectInto(double injectedValue,
                com.gs.collections.api.block.function.primitive.DoubleObjectToDoubleFunction<? super V> function)

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

Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

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

injectInto

public float injectInto(float injectedValue,
               com.gs.collections.api.block.function.primitive.FloatObjectToFloatFunction<? super V> function)

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

Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.

Specified by:

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

sumOfInt

public long sumOfInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> function)

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

Returns the final long result of evaluating function for each element of the iterable and adding the results together.

Specified by:

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

sumOfFloat

public double sumOfFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> function)

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

Returns the final double result of evaluating function for each element of the iterable and adding the results together.

Specified by:

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

sumOfLong

public long sumOfLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> function)

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

Returns the final long result of evaluating function for each element of the iterable and adding the results together.

Specified by:

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

sumOfDouble

public double sumOfDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> function)

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

Returns the final double result of evaluating function for each element of the iterable and adding the results together.

Specified by:

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

makeString

public java.lang.String makeString()

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

Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

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

Returns:

a string representation of this collection.

makeString

public java.lang.String makeString(java.lang.String separator)

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

Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

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

Returns:

a string representation of this collection.

makeString

public java.lang.String makeString(java.lang.String start,
                          java.lang.String separator,
                          java.lang.String end)

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

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings as by String.valueOf(Object).

Specified by:

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

Returns:

a string representation of this collection.

max

public V max()

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

Returns the maximum element out of this container based on the natural order.

Specified by:

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

max

public V max(java.util.Comparator<? super V> comparator)

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

Returns the maximum element out of this container based on the comparator.

Specified by:

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

maxBy

public <R extends java.lang.Comparable<? super R>> V maxBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function)

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

Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

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

min

public V min()

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

Returns the minimum element out of this container based on the natural order.

Specified by:

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

min

public V min(java.util.Comparator<? super V> comparator)

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

Returns the minimum element out of this container based on the comparator.

Specified by:

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

minBy

public <R extends java.lang.Comparable<? super R>> V minBy(com.gs.collections.api.block.function.Function<? super V,? extends R> function)

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

Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.

Specified by:

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

select

public com.gs.collections.api.list.MutableList<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.

e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.getAddress().getCity().equals("Metuchen");
     }
 });
 

Specified by:

select in interface com.gs.collections.api.map.sorted.MutableSortedMap<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.RichIterable<V>

select

public <R extends java.util.Collection<V>> R select(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
                                           R target)

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

Same as the select method with one parameter but uses the specified target collection for the results.

e.g.
 return people.select(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, Lists.mutable.of());
 

e.g.
 return collection.select(Predicates.attributeEqual("lastName", "Smith"), new ArrayList());
 

Specified by:

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

Parameters:

predicate - a Predicate to use as the select criteria

target - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

target, which contains appended elements as a result of the select criteria

See Also:

RichIterable.select(Predicate)

selectWith

public <P> com.gs.collections.api.list.MutableList<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.

Specified by:

selectWith in interface com.gs.collections.api.map.sorted.MutableSortedMap<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.RichIterable<V>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

RichIterable.select(Predicate)

selectWith

public <P,R extends java.util.Collection<V>> R selectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                 P parameter,
                                                 R targetCollection)

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

Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.

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

targetCollection - the Collection to append to for all elements in this RichIterable that meet select criteria predicate

Returns:

targetCollection, which contains appended elements as a result of the select criteria

See Also:

RichIterable.select(Predicate), RichIterable.select(Predicate, Collection)

reject

public <R extends java.util.Collection<V>> R reject(com.gs.collections.api.block.predicate.Predicate<? super V> predicate,
                                           R target)

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

Same as the reject method with one parameter but uses the specified target collection for the results.

e.g.
 return people.reject(new Predicate<Person>()
 {
     public boolean accept(Person person)
     {
         return person.person.getLastName().equals("Smith");
     }
 }, Lists.mutable.of());
 

Specified by:

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

Parameters:

predicate - a Predicate to use as the reject criteria

target - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

target, which contains appended elements as a result of the reject criteria

reject

public com.gs.collections.api.list.MutableList<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)).

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 com.gs.collections.api.map.sorted.MutableSortedMap<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.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.MutableList<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.

Specified by:

rejectWith in interface com.gs.collections.api.map.sorted.MutableSortedMap<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.RichIterable<V>

Parameters:

predicate - a Predicate2 to use as the select criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

See Also:

RichIterable.select(Predicate)

rejectWith

public <P,R extends java.util.Collection<V>> R rejectWith(com.gs.collections.api.block.predicate.Predicate2<? super V,? super P> predicate,
                                                 P parameter,
                                                 R targetCollection)

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

Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.

E.g. return a Collection of Person elements where the person has a height greater than 100cm

 return people.reject(new Predicate2<Person, Integer>()
 {
     public boolean accept(Person p, Integer i)
     {
         return p.getHeightInCm() < i.intValue();
     }
 }, Integer.valueOf(100), FastList.newList());
 

Specified by:

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

Parameters:

predicate - a Predicate2 to use as the reject criteria

parameter - a parameter to pass in for evaluation of the second argument P in predicate

targetCollection - the Collection to append to for all elements in this RichIterable that cause Predicate#accept(Object) method to evaluate to false

Returns:

targetCollection, which contains appended elements as a result of the reject criteria

See Also:

RichIterable.reject(Predicate), RichIterable.reject(Predicate, Collection)

toArray

public java.lang.Object[] toArray()

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

Converts this iterable to an array.

Specified by:

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

See Also:

Collection.toArray()

toArray

public <T> T[] toArray(T[] a)

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

Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.

Specified by:

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

See Also:

Collection.toArray(Object[])

zip

public <S,R extends java.util.Collection<com.gs.collections.api.tuple.Pair<V,S>>> R zip(java.lang.Iterable<S> that,
                                                                               R target)

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

Same as RichIterable.zip(Iterable) but uses target for output.

Specified by:

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

zipWithIndex

public <R extends java.util.Collection<com.gs.collections.api.tuple.Pair<V,java.lang.Integer>>> R zipWithIndex(R target)

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

Same as RichIterable.zipWithIndex() but uses target for output.

Specified by:

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

collect

public <R> com.gs.collections.api.list.MutableList<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.

e.g.
 return 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.MutableSortedMap<K,V>

Specified by:

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

collectBoolean

public com.gs.collections.api.list.primitive.MutableBooleanList 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.

e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return person.hasDrivingLicense();
     }
 });
 

Specified by:

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

Specified by:

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

collectBoolean

public <R extends com.gs.collections.api.collection.primitive.MutableBooleanCollection> R collectBoolean(com.gs.collections.api.block.function.primitive.BooleanFunction<? super V> booleanFunction,
                                                                                                R target)

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

Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.

e.g.
 return people.collectBoolean(new BooleanFunction<Person>()
 {
     public boolean booleanValueOf(Person person)
     {
         return person.hasDrivingLicense();
     }
 }, new BooleanArrayList());
 

Specified by:

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

Parameters:

booleanFunction - a BooleanFunction to use as the collect transformation function

target - the MutableBooleanCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectByte

public com.gs.collections.api.list.primitive.MutableByteList 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.

e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return person.getCode();
     }
 });
 

Specified by:

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

Specified by:

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

collectByte

public <R extends com.gs.collections.api.collection.primitive.MutableByteCollection> R collectByte(com.gs.collections.api.block.function.primitive.ByteFunction<? super V> byteFunction,
                                                                                          R target)

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

Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.

e.g.
 return people.collectByte(new ByteFunction<Person>()
 {
     public byte byteValueOf(Person person)
     {
         return person.getCode();
     }
 }, new ByteArrayList());
 

Specified by:

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

Parameters:

byteFunction - a ByteFunction to use as the collect transformation function

target - the MutableByteCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectChar

public com.gs.collections.api.list.primitive.MutableCharList 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.

e.g.
 return people.collectChar(new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return person.getMiddleInitial();
     }
 });
 

Specified by:

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

Specified by:

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

collectChar

public <R extends com.gs.collections.api.collection.primitive.MutableCharCollection> R collectChar(com.gs.collections.api.block.function.primitive.CharFunction<? super V> charFunction,
                                                                                          R target)

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

Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.

e.g.
 return people.collectChar(new CharFunction<Person>()
 {
     public char charValueOf(Person person)
     {
         return person.getMiddleInitial();
     }
 }, new CharArrayList());
 

Specified by:

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

Parameters:

charFunction - a CharFunction to use as the collect transformation function

target - the MutableCharCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectDouble

public com.gs.collections.api.list.primitive.MutableDoubleList 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.

e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return person.getMilesFromNorthPole();
     }
 });
 

Specified by:

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

Specified by:

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

collectDouble

public <R extends com.gs.collections.api.collection.primitive.MutableDoubleCollection> R collectDouble(com.gs.collections.api.block.function.primitive.DoubleFunction<? super V> doubleFunction,
                                                                                              R target)

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

Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.

e.g.
 return people.collectDouble(new DoubleFunction<Person>()
 {
     public double doubleValueOf(Person person)
     {
         return person.getMilesFromNorthPole();
     }
 }, new DoubleArrayList());
 

Specified by:

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

Parameters:

doubleFunction - a DoubleFunction to use as the collect transformation function

target - the MutableDoubleCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectFloat

public com.gs.collections.api.list.primitive.MutableFloatList 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.

e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return person.getHeightInInches();
     }
 });
 

Specified by:

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

Specified by:

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

collectFloat

public <R extends com.gs.collections.api.collection.primitive.MutableFloatCollection> R collectFloat(com.gs.collections.api.block.function.primitive.FloatFunction<? super V> floatFunction,
                                                                                            R target)

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

Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.

e.g.
 return people.collectFloat(new FloatFunction<Person>()
 {
     public float floatValueOf(Person person)
     {
         return person.getHeightInInches();
     }
 }, new FloatArrayList());
 

Specified by:

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

Parameters:

floatFunction - a FloatFunction to use as the collect transformation function

target - the MutableFloatCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectInt

public com.gs.collections.api.list.primitive.MutableIntList 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.

e.g.
 return people.collectInt(new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return person.getAge();
     }
 });
 

Specified by:

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

Specified by:

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

collectInt

public <R extends com.gs.collections.api.collection.primitive.MutableIntCollection> R collectInt(com.gs.collections.api.block.function.primitive.IntFunction<? super V> intFunction,
                                                                                        R target)

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

Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.

e.g.
 return people.collectInt(new IntFunction<Person>()
 {
     public int intValueOf(Person person)
     {
         return person.getAge();
     }
 }, new IntArrayList());
 

Specified by:

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

Parameters:

intFunction - a IntFunction to use as the collect transformation function

target - the MutableIntCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectLong

public com.gs.collections.api.list.primitive.MutableLongList 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.

e.g.
 return people.collectLong(new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return person.getGuid();
     }
 });
 

Specified by:

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

Specified by:

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

collectLong

public <R extends com.gs.collections.api.collection.primitive.MutableLongCollection> R collectLong(com.gs.collections.api.block.function.primitive.LongFunction<? super V> longFunction,
                                                                                          R target)

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

Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.

e.g.
 return people.collectLong(new LongFunction<Person>()
 {
     public long longValueOf(Person person)
     {
         return person.getGuid();
     }
 }, new LongArrayList());
 

Specified by:

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

Parameters:

longFunction - a LongFunction to use as the collect transformation function

target - the MutableLongCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectShort

public com.gs.collections.api.list.primitive.MutableShortList 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.

e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return person.getNumberOfJunkMailItemsReceivedPerMonth();
     }
 });
 

Specified by:

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

Specified by:

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

collectShort

public <R extends com.gs.collections.api.collection.primitive.MutableShortCollection> R collectShort(com.gs.collections.api.block.function.primitive.ShortFunction<? super V> shortFunction,
                                                                                            R target)

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

Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.

e.g.
 return people.collectShort(new ShortFunction<Person>()
 {
     public short shortValueOf(Person person)
     {
         return person.getNumberOfJunkMailItemsReceivedPerMonth;
     }
 }, new ShortArrayList());
 

Specified by:

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

Parameters:

shortFunction - a ShortFunction to use as the collect transformation function

target - the MutableShortCollection to append to for all elements in this RichIterable

Returns:

target, which contains appended elements as a result of the collect transformation

collectIf

public <R> com.gs.collections.api.list.MutableList<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).

e.g.
 Lists.mutable.of().with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString())
 

Specified by:

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

Specified by:

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

flatCollect

public <R> com.gs.collections.api.list.MutableList<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 = 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 com.gs.collections.api.map.sorted.MutableSortedMap<K,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

partition

public com.gs.collections.api.partition.list.PartitionMutableList<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.

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 com.gs.collections.api.map.sorted.MutableSortedMap<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.RichIterable<V>

partitionWith

public <P> com.gs.collections.api.partition.list.PartitionMutableList<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.

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 com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

selectInstancesOf

public <S> com.gs.collections.api.list.MutableList<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.sorted.MutableSortedMap<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.RichIterable<V>

zip

public <S> com.gs.collections.api.list.MutableList<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.sorted.MutableSortedMap<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.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.MutableList<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.sorted.MutableSortedMap<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.RichIterable<V>

Returns:

A new RichIterable containing pairs consisting of all elements of this RichIterable paired with their index. Indices start at 0.

See Also:

RichIterable.zip(Iterable)

keySet

public com.gs.collections.api.set.MutableSet<K> keySet()

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

The underlying set for the keys is sorted in ascending order according to their natural ordering or a custom comparator. However, Java 5 TreeMap returns a keySet that does not inherit from SortedSet therefore we have decided to return the keySet simply as a MutableSet to maintain Java 5 compatibility.

Specified by:

keySet in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Specified by:

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

Overrides:

keySet in class UnmodifiableMap<K,V>

values

public com.gs.collections.api.collection.MutableCollection<V> values()

Specified by:

values in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Specified by:

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

Overrides:

values in class UnmodifiableMap<K,V>

headMap

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

Specified by:

headMap in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Overrides:

headMap in class UnmodifiableSortedMap<K,V>

tailMap

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

Specified by:

tailMap in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Overrides:

tailMap in class UnmodifiableSortedMap<K,V>

subMap

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

Specified by:

subMap in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Overrides:

subMap in class UnmodifiableSortedMap<K,V>

entrySet

public com.gs.collections.api.set.MutableSet<java.util.Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface com.gs.collections.api.map.sorted.MutableSortedMap<K,V>

Specified by:

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

Specified by:

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

Overrides:

entrySet in class UnmodifiableMap<K,V>

aggregateInPlaceBy

public <K2,V2> com.gs.collections.api.map.MutableMap<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.sorted.MutableSortedMap<K,V>

Specified by:

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

aggregateBy

public <K2,V2> com.gs.collections.api.map.MutableMap<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.sorted.MutableSortedMap<K,V>

Specified by:

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