Class AbstractImmutableSortedMap<K,V>

java.lang.Object

org.eclipse.collections.impl.AbstractRichIterable<V>

org.eclipse.collections.impl.map.AbstractMapIterable<K,V>

org.eclipse.collections.impl.map.sorted.immutable.AbstractImmutableSortedMap<K,V>

All Implemented Interfaces:

Iterable<V>, Map<K,V>, SequencedMap<K,V>, SortedMap<K,V>, InternalIterable<V>, ImmutableMapIterable<K,V>, MapIterable<K,V>, ImmutableSortedMap<K,V>, SortedMapIterable<K,V>, OrderedIterable<V>, ReversibleIterable<V>, RichIterable<V>

Direct Known Subclasses:

ImmutableEmptySortedMap, ImmutableTreeMap

public abstract class AbstractImmutableSortedMap<K,V>
extends AbstractMapIterable<K,V>
implements ImmutableSortedMap<K,V>, SortedMap<K,V>

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor	Description
AbstractImmutableSortedMap()

Method Summary

Modifier and Type	Method	Description
<K1,V1,V2> ImmutableMap<K1,V2>	aggregateBy(Function<? super K, ? extends K1> keyFunction, Function<? super V, ? extends V1> valueFunction, Function0<? extends V2> zeroValueFactory, Function2<? super V2, ? super V1, ? extends V2> nonMutatingAggregator)	Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions.
SortedMap<K,V>	castToMap()
SortedMap<K,V>	castToSortedMap()
void	clear()
<R> ImmutableList<R>	collect(Function<? super V, ? extends R> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
<K2,V2> ImmutableMap<K2,V2>	collect(Function2<? super K, ? super V, Pair<K2,V2>> function)	For each key and value of the map the function is evaluated.
ImmutableBooleanList	collectBoolean(BooleanFunction<? super V> booleanFunction)	Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
ImmutableByteList	collectByte(ByteFunction<? super V> byteFunction)	Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
ImmutableCharList	collectChar(CharFunction<? super V> charFunction)	Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
ImmutableDoubleList	collectDouble(DoubleFunction<? super V> doubleFunction)	Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
ImmutableFloatList	collectFloat(FloatFunction<? super V> floatFunction)	Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<R> ImmutableList<R>	collectIf(Predicate<? super V> predicate, Function<? super V, ? extends R> function)	Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate.
ImmutableIntList	collectInt(IntFunction<? super V> intFunction)	Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
<R> ImmutableOrderedMap<R,V>	collectKeysUnique(Function2<? super K, ? super V, ? extends R> function)	For each key and value of the map the function is evaluated.
ImmutableLongList	collectLong(LongFunction<? super V> longFunction)	Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
ImmutableShortList	collectShort(ShortFunction<? super V> shortFunction)	Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<R> ImmutableSortedMap<K,R>	collectValues(Function2<? super K, ? super V, ? extends R> function)	For each key and value of the map the function is evaluated.
<P,VV> ImmutableList<VV>	collectWith(Function2<? super V, ? super P, ? extends VV> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
<S> boolean	corresponds(OrderedIterable<S> other, Predicate2<? super V, ? super S> predicate)	Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other.
<V1> ImmutableBag<V1>	countBy(Function<? super V, ? extends V1> function)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
<V1> ImmutableBag<V1>	countByEach(Function<? super V, ? extends Iterable<V1>> function)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
<V1,P> ImmutableBag<V1>	countByWith(Function2<? super V, ? super P, ? extends V1> function, P parameter)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
Pair<K,V>	detect(Predicate2<? super K, ? super V> predicate)	Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments.
int	detectIndex(Predicate<? super V> predicate)	Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true.
int	detectLastIndex(Predicate<? super V> predicate)	Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true.
Optional<Pair<K,V>>	detectOptional(Predicate2<? super K, ? super V> predicate)	Return the first key and value of the map as an Optional for which the predicate evaluates to true when they are given as arguments.
ImmutableList<V>	distinct()	Returns a new OrderedIterable containing the distinct elements in this iterable.
ImmutableSortedMap<K,V>	dropWhile(Predicate<? super V> predicate)	Returns the final elements that do not satisfy the Predicate.
<R> ImmutableList<R>	flatCollect(Function<? super V, ? extends Iterable<R>> function)	flatCollect is a special case of RichIterable.collect(Function).
ImmutableSortedSetMultimap<V,K>	flip()	Given a map from Domain -> Range return a multimap from Range -> Domain.
void	forEach(int startIndex, int endIndex, Procedure<? super V> procedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEach(BiConsumer<? super K, ? super V> action)
void	forEachWithIndex(int fromIndex, int toIndex, ObjectIntProcedure<? super V> objectIntProcedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
<R> ImmutableListMultimap<R,V>	groupBy(Function<? super V, ? extends R> function)	For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<R> ImmutableListMultimap<R,V>	groupByEach(Function<? super V, ? extends Iterable<R>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<V1> ImmutableMap<V1,V>	groupByUniqueKey(Function<? super V, ? extends V1> function)	For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key.
SortedMap<K,V>	headMap(K toKey)
Iterator<V>	iterator()
ImmutableSortedMap<K,V>	newWithAllKeyValueArguments(Pair<? extends K, ? extends V>... keyValuePairs)
ImmutableSortedMap<K,V>	newWithAllKeyValues(Iterable<? extends Pair<? extends K, ? extends V>> keyValues)
ImmutableSortedMap<K,V>	newWithKeyValue(K key, V value)
ImmutableSortedMap<K,V>	newWithMap(Map<? extends K, ? extends V> map)
ImmutableSortedMap<K,V>	newWithMapIterable(MapIterable<? extends K, ? extends V> mapIterable)
ImmutableSortedMap<K,V>	newWithoutAllKeys(Iterable<? extends K> keys)
ImmutableSortedMap<K,V>	newWithoutKey(K key)
PartitionImmutableList<V>	partition(Predicate<? super V> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
PartitionImmutableList<V>	partitionWhile(Predicate<? super V> predicate)	Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
<P> PartitionImmutableList<V>	partitionWith(Predicate2<? super V, ? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
V	put(K key, V value)
void	putAll(Map<? extends K, ? extends V> map)
ImmutableList<V>	reject(Predicate<? super V> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
ImmutableSortedMap<K,V>	reject(Predicate2<? super K, ? super V> predicate)	For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.
<P> ImmutableList<V>	rejectWith(Predicate2<? super V, ? super P> predicate, P parameter)	Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
V	remove(Object key)
ImmutableList<V>	select(Predicate<? super V> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
ImmutableSortedMap<K,V>	select(Predicate2<? super K, ? super V> predicate)	For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.
<S> ImmutableList<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> ImmutableList<V>	selectWith(Predicate2<? super V, ? super P> predicate, P parameter)	Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
SortedMap<K,V>	subMap(K fromKey, K toKey)
<V1> ImmutableObjectDoubleMap<V1>	sumByDouble(Function<? super V, ? extends V1> groupBy, DoubleFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> ImmutableObjectDoubleMap<V1>	sumByFloat(Function<? super V, ? extends V1> groupBy, FloatFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> ImmutableObjectLongMap<V1>	sumByInt(Function<? super V, ? extends V1> groupBy, IntFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> ImmutableObjectLongMap<V1>	sumByLong(Function<? super V, ? extends V1> groupBy, LongFunction<? super V> function)	Groups and sums the values using the two specified functions.
SortedMap<K,V>	tailMap(K fromKey)
ImmutableSortedMap<K,V>	takeWhile(Predicate<? super V> predicate)	Returns the initial elements that satisfy the Predicate.
ImmutableSortedMap<K,V>	tap(Procedure<? super V> procedure)	Executes the Procedure for each element in the iterable and returns this.
ImmutableSortedMap<K,V>	toImmutable()	Converts the SortedMapIterable to an immutable implementation.
ImmutableSortedMap<K,V>	toReversed()	Returns a new ReversibleIterable in reverse order.
MutableSortedMap<K,V>	toSortedMap()
MutableStack<V>	toStack()	Converts the OrderedIterable to a mutable MutableStack implementation.
<S> ImmutableList<Pair<V,S>>	zip(Iterable<S> that)	Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs.
ImmutableList<Pair<V,Integer>>	zipWithIndex()	Zips this RichIterable with its indices.

Methods inherited from class AbstractMapIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, asLazy, chunk, contains, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, forEachKey, forEachValue, forEachWith, forEachWithIndex, getFirst, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getLast, getOnly, getOrDefault, ifPresentApply, isAbsent, keyAndValueEquals, keyAndValueHashCode, noneSatisfy, noneSatisfyWith, toArray, toArray

Methods inherited from class AbstractRichIterable

appendString, appendString, collect, collectIf, collectWith, containsAll, containsAllArguments, containsAllIterable, count, countWith, flatCollect, forEach, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, max, max, maxBy, min, min, minBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toBiMap, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Methods inherited from class Object

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

Methods inherited from interface ImmutableMapIterable

flipUniqueValues

Methods inherited from interface ImmutableSortedMap

aggregateBy, aggregateInPlaceBy, collectWithIndex, flatCollectWith, reduceBy

Methods inherited from interface InternalIterable

forEach, forEachWith

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, equals, get, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll, size

Methods inherited from interface MapIterable

containsKey, containsValue, equals, forEachKey, forEachKeyValue, forEachValue, get, getIfAbsent, getIfAbsentValue, getIfAbsentWith, getOrDefault, hashCode, ifPresentApply, injectIntoKeyValue, keysView, keyValuesView, parallelStream, spliterator, stream, toString, valuesView

Methods inherited from interface OrderedIterable

collectWithIndex, forEachWithIndex, getFirst, getFirstOptional, getLast, getLastOptional, indexOf, max, min, rejectWithIndex, selectWithIndex, zip, zipWithIndex

Methods inherited from interface ReversibleIterable

asReversed, reverseForEach, reverseForEachWithIndex

Methods inherited from interface RichIterable

aggregateBy, allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, count, countBy, countByEach, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, getOnly, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, isEmpty, makeString, makeString, makeString, makeString, max, maxBy, maxByOptional, maxOptional, maxOptional, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reduceBy, reduceInPlace, reduceInPlace, reject, rejectWith, select, selectWith, size, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toBiMap, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toList, toMap, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy

Methods inherited from interface SequencedMap

firstEntry, lastEntry, pollFirstEntry, pollLastEntry, sequencedEntrySet, sequencedKeySet, sequencedValues

Methods inherited from interface SortedMap

comparator, entrySet, firstKey, keySet, lastKey, putFirst, putLast, reversed, values

Methods inherited from interface SortedMapIterable

comparator, drop, take

Constructor Details

AbstractImmutableSortedMap

public AbstractImmutableSortedMap()

Method Details

castToMap

public SortedMap<K,V> castToMap()

Specified by:

castToMap in interface ImmutableMapIterable<K,V>

Specified by:

castToMap in interface ImmutableSortedMap<K,V>

castToSortedMap

public SortedMap<K,V> castToSortedMap()

Specified by:

castToSortedMap in interface ImmutableSortedMap<K,V>

toSortedMap

public MutableSortedMap<K,V> toSortedMap()

Specified by:

toSortedMap in interface ImmutableSortedMap<K,V>

toImmutable

public ImmutableSortedMap<K,V> toImmutable()

Description copied from interface: SortedMapIterable

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

Specified by:

toImmutable in interface MapIterable<K,V>

Specified by:

toImmutable in interface SortedMapIterable<K,V>

iterator

public Iterator<V> iterator()

Specified by:

iterator in interface Iterable<K>

putAll

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

Specified by:

putAll in interface Map<K,V>

clear

public void clear()

Specified by:

clear in interface Map<K,V>

newWithKeyValue

public ImmutableSortedMap<K,V> newWithKeyValue(K key,
 V value)

Specified by:

newWithKeyValue in interface ImmutableMapIterable<K,V>

Specified by:

newWithKeyValue in interface ImmutableSortedMap<K,V>

newWithAllKeyValues

public ImmutableSortedMap<K,V> newWithAllKeyValues(Iterable<? extends Pair<? extends K, ? extends V>> keyValues)

Specified by:

newWithAllKeyValues in interface ImmutableMapIterable<K,V>

Specified by:

newWithAllKeyValues in interface ImmutableSortedMap<K,V>

newWithMap

public ImmutableSortedMap<K,V> newWithMap(Map<? extends K, ? extends V> map)

Specified by:

newWithMap in interface ImmutableMapIterable<K,V>

Specified by:

newWithMap in interface ImmutableSortedMap<K,V>

newWithMapIterable

public ImmutableSortedMap<K,V> newWithMapIterable(MapIterable<? extends K, ? extends V> mapIterable)

Specified by:

newWithMapIterable in interface ImmutableMapIterable<K,V>

Specified by:

newWithMapIterable in interface ImmutableSortedMap<K,V>

newWithAllKeyValueArguments

public ImmutableSortedMap<K,V> newWithAllKeyValueArguments(Pair<? extends K, ? extends V>... keyValuePairs)

Specified by:

newWithAllKeyValueArguments in interface ImmutableMapIterable<K,V>

Specified by:

newWithAllKeyValueArguments in interface ImmutableSortedMap<K,V>

newWithoutKey

public ImmutableSortedMap<K,V> newWithoutKey(K key)

Specified by:

newWithoutKey in interface ImmutableMapIterable<K,V>

Specified by:

newWithoutKey in interface ImmutableSortedMap<K,V>

newWithoutAllKeys

public ImmutableSortedMap<K,V> newWithoutAllKeys(Iterable<? extends K> keys)

Specified by:

newWithoutAllKeys in interface ImmutableMapIterable<K,V>

Specified by:

newWithoutAllKeys in interface ImmutableSortedMap<K,V>

put

public V put(K key,
 V value)

Specified by:

put in interface Map<K,V>

remove

public V remove(Object key)

Specified by:

remove in interface Map<K,V>

flip

public ImmutableSortedSetMultimap<V,K> flip()

Description copied from interface: MapIterable

Given a map from Domain -> Range return a multimap from Range -> Domain. We chose the name 'flip' rather than 'invert' or 'transpose' since this method does not have the property of applying twice returns the original.

Since the keys in the input are unique, the values in the output are unique, so the return type should be a SetMultimap. However, since SetMultimap and SortedSetMultimap don't inherit from one another, SetMultimap here does not allow SortedMapIterable to have a SortedSetMultimap return. Thus, we compromise and call this Multimap, even though all implementations will be a SetMultimap or SortedSetMultimap.

Specified by:

flip in interface ImmutableMapIterable<K,V>

Specified by:

flip in interface ImmutableSortedMap<K,V>

Specified by:

flip in interface MapIterable<K,V>

Specified by:

flip in interface SortedMapIterable<K,V>

tap

public ImmutableSortedMap<K,V> tap(Procedure<? super V> procedure)

Description copied from interface: RichIterable

Executes the Procedure for each element in the iterable and returns this.

Example using a Java 8 lambda expression:

RichIterable<Person> tapped =
    people.tap(person -> LOGGER.info(person.getName()));

Specified by:

tap in interface ImmutableMapIterable<K,V>

Specified by:

tap in interface ImmutableSortedMap<K,V>

Specified by:

tap in interface MapIterable<K,V>

Specified by:

tap in interface OrderedIterable<K>

Specified by:

tap in interface ReversibleIterable<K>

Specified by:

tap in interface RichIterable<K>

Specified by:

tap in interface SortedMapIterable<K,V>

See Also:

• RichIterable.each(Procedure)
• RichIterable.forEach(Procedure)

select

public ImmutableList<V> select(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns all elements of the source collection that return true when evaluating the predicate. This method is also commonly called filter.

Example using a Java 8 lambda expression:

RichIterable<Person> selected =
    people.select(person -> person.getAddress().getCity().equals("London"));

Specified by:

select in interface ImmutableMapIterable<K,V>

Specified by:

select in interface ImmutableSortedMap<K,V>

Specified by:

select in interface OrderedIterable<K>

Specified by:

select in interface ReversibleIterable<K>

Specified by:

select in interface RichIterable<K>

Specified by:

select in interface SortedMapIterable<K,V>

selectWith

public <P> ImmutableList<V> selectWith(Predicate2<? super V, ? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

RichIterable<Person> selected =
    people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18));

Specified by:

selectWith in interface ImmutableMapIterable<K,V>

Specified by:

selectWith in interface ImmutableSortedMap<K,V>

Specified by:

selectWith in interface OrderedIterable<K>

Specified by:

selectWith in interface ReversibleIterable<K>

Specified by:

selectWith in interface RichIterable<K>

Specified by:

selectWith in interface SortedMapIterable<K,V>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

• RichIterable.select(Predicate)

select

public ImmutableSortedMap<K,V> select(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MapIterable

For each key and value of the map the predicate is evaluated, if the result of the evaluation is true, that key and value are returned in a new map.

MapIterable<City, Person> selected =
    peopleByCity.select((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));

Specified by:

select in interface ImmutableMapIterable<K,V>

Specified by:

select in interface ImmutableSortedMap<K,V>

Specified by:

select in interface MapIterable<K,V>

Specified by:

select in interface SortedMapIterable<K,V>

reject

public ImmutableList<V> reject(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns all elements of the source collection that return false when evaluating of the predicate. This method is also sometimes called filterNot and is the equivalent of calling iterable.select(Predicates.not(predicate)).

Example using a Java 8 lambda expression:

RichIterable<Person> rejected =
    people.reject(person -> person.person.getLastName().equals("Smith"));

Specified by:

reject in interface ImmutableMapIterable<K,V>

Specified by:

reject in interface ImmutableSortedMap<K,V>

Specified by:

reject in interface OrderedIterable<K>

Specified by:

reject in interface ReversibleIterable<K>

Specified by:

reject in interface RichIterable<K>

Specified by:

reject in interface SortedMapIterable<K,V>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

a RichIterable that contains elements that cause Predicate.accept(Object) method to evaluate to false

rejectWith

public <P> ImmutableList<V> rejectWith(Predicate2<? super V, ? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

E.g. return a Collection of Person elements where the person has an age greater than or equal to 18 years

Example using a Java 8 lambda expression:

RichIterable<Person> rejected =
    people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18));

Specified by:

rejectWith in interface ImmutableMapIterable<K,V>

Specified by:

rejectWith in interface ImmutableSortedMap<K,V>

Specified by:

rejectWith in interface OrderedIterable<K>

Specified by:

rejectWith in interface ReversibleIterable<K>

Specified by:

rejectWith in interface RichIterable<K>

Specified by:

rejectWith in interface SortedMapIterable<K,V>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

• RichIterable.select(Predicate)

reject

public ImmutableSortedMap<K,V> reject(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MapIterable

For each key and value of the map the predicate is evaluated, if the result of the evaluation is false, that key and value are returned in a new map.

MapIterable<City, Person> rejected =
    peopleByCity.reject((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));

Specified by:

reject in interface ImmutableMapIterable<K,V>

Specified by:

reject in interface ImmutableSortedMap<K,V>

Specified by:

reject in interface MapIterable<K,V>

Specified by:

reject in interface SortedMapIterable<K,V>

partition

public PartitionImmutableList<V> partition(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Filters a collection into a PartitionedIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

PartitionIterable<Person> newYorkersAndNonNewYorkers =
    people.partition(person -> person.getAddress().getState().getName().equals("New York"));

Specified by:

partition in interface ImmutableMapIterable<K,V>

Specified by:

partition in interface ImmutableSortedMap<K,V>

Specified by:

partition in interface OrderedIterable<K>

Specified by:

partition in interface ReversibleIterable<K>

Specified by:

partition in interface RichIterable<K>

Specified by:

partition in interface SortedMapIterable<K,V>

partitionWith

public <P> PartitionImmutableList<V> partitionWith(Predicate2<? super V, ? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Filters a collection into a PartitionIterable based on the evaluation of the predicate.

Example using a Java 8 lambda expression:

PartitionIterable<Person> newYorkersAndNonNewYorkers =
    people.partitionWith((Person person, String state) -> person.getAddress().getState().getName().equals(state), "New York");

Specified by:

partitionWith in interface ImmutableSortedMap<K,V>

Specified by:

partitionWith in interface OrderedIterable<K>

Specified by:

partitionWith in interface ReversibleIterable<K>

Specified by:

partitionWith in interface RichIterable<K>

Specified by:

partitionWith in interface SortedMapIterable<K,V>

selectInstancesOf

public <S> ImmutableList<S> selectInstancesOf(Class<S> clazz)

Description copied from interface: RichIterable

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

RichIterable<Integer> integers =
    List.mutable.with(new Integer(0), new Long(0L), new Double(0.0)).selectInstancesOf(Integer.class);

Specified by:

selectInstancesOf in interface ImmutableMapIterable<K,V>

Specified by:

selectInstancesOf in interface ImmutableSortedMap<K,V>

Specified by:

selectInstancesOf in interface OrderedIterable<K>

Specified by:

selectInstancesOf in interface ReversibleIterable<K>

Specified by:

selectInstancesOf in interface RichIterable<K>

Specified by:

selectInstancesOf in interface SortedMapIterable<K,V>

collect

public <R> ImmutableList<R> collect(Function<? super V, ? extends R> function)

Description copied from interface: RichIterable

Returns a new collection with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

RichIterable<String> names =
    people.collect(person -> person.getFirstName() + " " + person.getLastName());

Specified by:

collect in interface ImmutableSortedMap<K,V>

Specified by:

collect in interface OrderedIterable<K>

Specified by:

collect in interface ReversibleIterable<K>

Specified by:

collect in interface RichIterable<K>

Specified by:

collect in interface SortedMapIterable<K,V>

collectBoolean

public ImmutableBooleanList collectBoolean(BooleanFunction<? super V> booleanFunction)

Description copied from interface: RichIterable

Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

BooleanIterable licenses =
    people.collectBoolean(person -> person.hasDrivingLicense());

Specified by:

collectBoolean in interface ImmutableSortedMap<K,V>

Specified by:

collectBoolean in interface OrderedIterable<K>

Specified by:

collectBoolean in interface ReversibleIterable<K>

Specified by:

collectBoolean in interface RichIterable<K>

Specified by:

collectBoolean in interface SortedMapIterable<K,V>

collectByte

public ImmutableByteList collectByte(ByteFunction<? super V> byteFunction)

Description copied from interface: RichIterable

Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

ByteIterable bytes =
    people.collectByte(person -> person.getCode());

Specified by:

collectByte in interface ImmutableSortedMap<K,V>

Specified by:

collectByte in interface OrderedIterable<K>

Specified by:

collectByte in interface ReversibleIterable<K>

Specified by:

collectByte in interface RichIterable<K>

Specified by:

collectByte in interface SortedMapIterable<K,V>

collectChar

public ImmutableCharList collectChar(CharFunction<? super V> charFunction)

Description copied from interface: RichIterable

Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

CharIterable chars =
    people.collectChar(person -> person.getMiddleInitial());

Specified by:

collectChar in interface ImmutableSortedMap<K,V>

Specified by:

collectChar in interface OrderedIterable<K>

Specified by:

collectChar in interface ReversibleIterable<K>

Specified by:

collectChar in interface RichIterable<K>

Specified by:

collectChar in interface SortedMapIterable<K,V>

collectDouble

public ImmutableDoubleList collectDouble(DoubleFunction<? super V> doubleFunction)

Description copied from interface: RichIterable

Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

DoubleIterable doubles =
    people.collectDouble(person -> person.getMilesFromNorthPole());

Specified by:

collectDouble in interface ImmutableSortedMap<K,V>

Specified by:

collectDouble in interface OrderedIterable<K>

Specified by:

collectDouble in interface ReversibleIterable<K>

Specified by:

collectDouble in interface RichIterable<K>

Specified by:

collectDouble in interface SortedMapIterable<K,V>

collectFloat

public ImmutableFloatList collectFloat(FloatFunction<? super V> floatFunction)

Description copied from interface: RichIterable

Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

FloatIterable floats =
    people.collectFloat(person -> person.getHeightInInches());

Specified by:

collectFloat in interface ImmutableSortedMap<K,V>

Specified by:

collectFloat in interface OrderedIterable<K>

Specified by:

collectFloat in interface ReversibleIterable<K>

Specified by:

collectFloat in interface RichIterable<K>

Specified by:

collectFloat in interface SortedMapIterable<K,V>

collectInt

public ImmutableIntList collectInt(IntFunction<? super V> intFunction)

Description copied from interface: RichIterable

Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

IntIterable ints =
    people.collectInt(person -> person.getAge());

Specified by:

collectInt in interface ImmutableSortedMap<K,V>

Specified by:

collectInt in interface OrderedIterable<K>

Specified by:

collectInt in interface ReversibleIterable<K>

Specified by:

collectInt in interface RichIterable<K>

Specified by:

collectInt in interface SortedMapIterable<K,V>

collectLong

public ImmutableLongList collectLong(LongFunction<? super V> longFunction)

Description copied from interface: RichIterable

Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

LongIterable longs =
    people.collectLong(person -> person.getGuid());

Specified by:

collectLong in interface ImmutableSortedMap<K,V>

Specified by:

collectLong in interface OrderedIterable<K>

Specified by:

collectLong in interface ReversibleIterable<K>

Specified by:

collectLong in interface RichIterable<K>

Specified by:

collectLong in interface SortedMapIterable<K,V>

collectShort

public ImmutableShortList collectShort(ShortFunction<? super V> shortFunction)

Description copied from interface: RichIterable

Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection. This method is also commonly called transform or map.

Example using a Java 8 lambda expression:

ShortIterable shorts =
    people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth());

Specified by:

collectShort in interface ImmutableSortedMap<K,V>

Specified by:

collectShort in interface OrderedIterable<K>

Specified by:

collectShort in interface ReversibleIterable<K>

Specified by:

collectShort in interface RichIterable<K>

Specified by:

collectShort in interface SortedMapIterable<K,V>

collect

public <K2,V2> ImmutableMap<K2,V2> collect(Function2<? super K, ? super V, Pair<K2,V2>> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

MapIterable<String, String> collected =
    peopleByCity.collect((City city, Person person) -> Pair.of(city.getCountry(), person.getAddress().getCity()));

Specified by:

collect in interface ImmutableMapIterable<K,V>

Specified by:

collect in interface ImmutableSortedMap<K,V>

Specified by:

collect in interface MapIterable<K,V>

Specified by:

collect in interface SortedMapIterable<K,V>

collectWith

public <P,VV> ImmutableList<VV> collectWith(Function2<? super V, ? super P, ? extends VV> function,
 P parameter)

Description copied from interface: RichIterable

Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.

Example using a Java 8 lambda expression:

RichIterable<Integer> integers =
    Lists.mutable.with(1, 2, 3).collectWith((each, parameter) -> each + parameter, Integer.valueOf(1));

Specified by:

collectWith in interface ImmutableSortedMap<K,V>

Specified by:

collectWith in interface OrderedIterable<K>

Specified by:

collectWith in interface ReversibleIterable<K>

Specified by:

collectWith in interface RichIterable<K>

Specified by:

collectWith in interface SortedMapIterable<K,V>

Parameters:

function - A Function2 to use as the collect transformation function

parameter - A parameter to pass in for evaluation of the second argument P in function

Returns:

A new RichIterable that contains the transformed elements returned by Function2.value(Object, Object)

See Also:

• RichIterable.collect(Function)

collectIf

public <R> ImmutableList<R> collectIf(Predicate<? super V> predicate,
 Function<? super V, ? extends R> function)

Description copied from interface: RichIterable

Returns a new collection with the results of applying the specified function on each element of the source collection, but only for those elements which return true upon evaluation of the predicate. This is the optimized equivalent of calling iterable.select(predicate).collect(function).

Example using a Java 8 lambda and method reference:

RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(e -> e != null, Object::toString);

Example using Predicates factory:

RichIterable<String> strings = Lists.mutable.with(1, 2, 3).collectIf(Predicates.notNull(), Functions.getToString());

Specified by:

collectIf in interface ImmutableSortedMap<K,V>

Specified by:

collectIf in interface OrderedIterable<K>

Specified by:

collectIf in interface ReversibleIterable<K>

Specified by:

collectIf in interface RichIterable<K>

Specified by:

collectIf in interface SortedMapIterable<K,V>

collectValues

public <R> ImmutableSortedMap<K,R> collectValues(Function2<? super K, ? super V, ? extends R> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the values projected from the function rather than the original values.

MapIterable<City, String> collected =
    peopleByCity.collectValues((City city, Person person) -> person.getFirstName() + " " + person.getLastName());

Specified by:

collectValues in interface ImmutableMapIterable<K,V>

Specified by:

collectValues in interface ImmutableSortedMap<K,V>

Specified by:

collectValues in interface MapIterable<K,V>

Specified by:

collectValues in interface SortedMapIterable<K,V>

collectKeysUnique

public <R> ImmutableOrderedMap<R,V> collectKeysUnique(Function2<? super K, ? super V, ? extends R> function)

Description copied from interface: MapIterable

For each key and value of the map the function is evaluated. The results of these evaluations are returned in a new map. The map returned will use the keys projected from the function rather than the original keys.

Specified by:

collectKeysUnique in interface ImmutableMapIterable<K,V>

Specified by:

collectKeysUnique in interface ImmutableSortedMap<K,V>

Specified by:

collectKeysUnique in interface MapIterable<K,V>

detect

public Pair<K,V> detect(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MapIterable

Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all 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.

Pair<City, Person> detected =
    peopleByCity.detect((City city, Person person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));

Specified by:

detect in interface MapIterable<K,V>

detectOptional

public Optional<Pair<K,V>> detectOptional(Predicate2<? super K, ? super V> predicate)

Description copied from interface: MapIterable

Return the first key and value of the map as an Optional 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 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.

Optional<Pair<City, Person>> detected =
    peopleByCity.detectOptional((city, person)
         -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));

Specified by:

detectOptional in interface MapIterable<K,V>

flatCollect

public <R> ImmutableList<R> flatCollect(Function<? super V, ? extends Iterable<R>> function)

Description copied from interface: RichIterable

flatCollect is a special case of RichIterable.collect(Function). With collect, when the Function returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.

Consider the following example where we have a Person class, and each Person has a list of Address objects. Take the following Function:

Function<Person, List<Address>> addressFunction = Person::getAddresses;
RichIterable<Person> people = ...;

Using collect returns a collection of collections of addresses.

RichIterable<List<Address>> addresses = people.collect(addressFunction);

Using flatCollect returns a single flattened list of addresses.

RichIterable<Address> addresses = people.flatCollect(addressFunction);

Specified by:

flatCollect in interface ImmutableSortedMap<K,V>

Specified by:

flatCollect in interface OrderedIterable<K>

Specified by:

flatCollect in interface ReversibleIterable<K>

Specified by:

flatCollect in interface RichIterable<K>

Specified by:

flatCollect in interface SortedMapIterable<K,V>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

zip

public <S> ImmutableList<Pair<V,S>> zip(Iterable<S> that)

Description copied from interface: RichIterable

Returns a RichIterable formed from this RichIterable and another RichIterable by combining corresponding elements in pairs. If one of the two RichIterables is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface ImmutableMapIterable<K,V>

Specified by:

zip in interface ImmutableSortedMap<K,V>

Specified by:

zip in interface OrderedIterable<K>

Specified by:

zip in interface ReversibleIterable<K>

Specified by:

zip in interface RichIterable<K>

Specified by:

zip in interface SortedMapIterable<K,V>

Type Parameters:

S - the type of the second half of the returned pairs

Parameters:

that - The RichIterable providing the second half of each result pair

Returns:

A new RichIterable containing pairs consisting of corresponding elements of this RichIterable and that. The length of the returned RichIterable is the minimum of the lengths of this RichIterable and that.

zipWithIndex

public ImmutableList<Pair<V,Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface ImmutableMapIterable<K,V>

Specified by:

zipWithIndex in interface ImmutableSortedMap<K,V>

Specified by:

zipWithIndex in interface OrderedIterable<K>

Specified by:

zipWithIndex in interface ReversibleIterable<K>

Specified by:

zipWithIndex in interface RichIterable<K>

Specified by:

zipWithIndex in interface SortedMapIterable<K,V>

Returns:

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

See Also:

• RichIterable.zip(Iterable)

subMap

public SortedMap<K,V> subMap(K fromKey,
 K toKey)

Specified by:

subMap in interface SortedMap<K,V>

headMap

public SortedMap<K,V> headMap(K toKey)

Specified by:

headMap in interface SortedMap<K,V>

tailMap

public SortedMap<K,V> tailMap(K fromKey)

Specified by:

tailMap in interface SortedMap<K,V>

groupBy

public <R> ImmutableListMultimap<R,V> groupBy(Function<? super V, ? extends R> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.

Example using a Java 8 method reference:

Multimap<String, Person> peopleByLastName =
    people.groupBy(Person::getLastName);

Specified by:

groupBy in interface ImmutableMapIterable<K,V>

Specified by:

groupBy in interface ImmutableSortedMap<K,V>

Specified by:

groupBy in interface OrderedIterable<K>

Specified by:

groupBy in interface ReversibleIterable<K>

Specified by:

groupBy in interface RichIterable<K>

Specified by:

groupBy in interface SortedMapIterable<K,V>

groupByEach

public <R> ImmutableListMultimap<R,V> groupByEach(Function<? super V, ? extends Iterable<R>> function)

Description copied from interface: RichIterable

Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.

Specified by:

groupByEach in interface ImmutableMapIterable<K,V>

Specified by:

groupByEach in interface ImmutableSortedMap<K,V>

Specified by:

groupByEach in interface OrderedIterable<K>

Specified by:

groupByEach in interface ReversibleIterable<K>

Specified by:

groupByEach in interface RichIterable<K>

Specified by:

groupByEach in interface SortedMapIterable<K,V>

groupByUniqueKey

public <V1> ImmutableMap<V1,V> groupByUniqueKey(Function<? super V, ? extends V1> function)

Description copied from interface: RichIterable

For each element of the iterable, the function is evaluated, and the 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 ImmutableMapIterable<K,V>

Specified by:

groupByUniqueKey in interface ImmutableSortedMap<K,V>

Specified by:

groupByUniqueKey in interface RichIterable<K>

See Also:

• RichIterable.groupBy(Function)

aggregateBy

public <K1,V1,V2> ImmutableMap<K1,V2> aggregateBy(Function<? super K, ? extends K1> keyFunction,
 Function<? super V, ? extends V1> valueFunction,
 Function0<? extends V2> zeroValueFactory,
 Function2<? super V2, ? super V1, ? extends V2> nonMutatingAggregator)

Description copied from interface: MapIterable

Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions. 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.

MapIterable<String, Interval> map = Maps.mutable.with("oneToFive", Interval.fromTo(1, 5), "sixToNine", Interval.fromTo(6, 9));

MapIterable<String, Long> result = map.aggregateBy(
        eachKey -> {
            return eachKey.equals("oneToFive")  ? "lessThanSix" : "greaterOrEqualsToSix";
        },
        each -> each.sumOfInt(Integer::intValue),
        () -> 0L,
        (argument1, argument2) -> argument1 + argument2);

MapIterable<String, Long> expected =
        Maps.mutable.with("lessThanSix", Interval.fromTo(1, 5).sumOfInt(Integer::intValue),
                "greaterOrEqualsToSix", Interval.fromTo(6, 9).sumOfInt(Integer::intValue));
Assert.assertEquals(expected, result);

Specified by:

aggregateBy in interface ImmutableMapIterable<K,V>

Specified by:

aggregateBy in interface ImmutableSortedMap<K,V>

Specified by:

aggregateBy in interface MapIterable<K,V>

sumByInt

public <V1> ImmutableObjectLongMap<V1> sumByInt(Function<? super V, ? extends V1> groupBy,
 IntFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface RichIterable<K>

sumByFloat

public <V1> ImmutableObjectDoubleMap<V1> sumByFloat(Function<? super V, ? extends V1> groupBy,
 FloatFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByFloat in interface RichIterable<K>

sumByLong

public <V1> ImmutableObjectLongMap<V1> sumByLong(Function<? super V, ? extends V1> groupBy,
 LongFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface RichIterable<K>

sumByDouble

public <V1> ImmutableObjectDoubleMap<V1> sumByDouble(Function<? super V, ? extends V1> groupBy,
 DoubleFunction<? super V> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByDouble in interface RichIterable<K>

toReversed

public ImmutableSortedMap<K,V> toReversed()

Description copied from interface: ReversibleIterable

Returns a new ReversibleIterable in reverse order.

Specified by:

toReversed in interface ReversibleIterable<K>

Specified by:

toReversed in interface SortedMapIterable<K,V>

detectLastIndex

public int detectLastIndex(Predicate<? super V> predicate)

Description copied from interface: ReversibleIterable

Returns the index of the last element of the ReversibleIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

detectLastIndex in interface ReversibleIterable<K>

takeWhile

public ImmutableSortedMap<K,V> takeWhile(Predicate<? super V> predicate)

Description copied from interface: ReversibleIterable

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

Specified by:

takeWhile in interface OrderedIterable<K>

Specified by:

takeWhile in interface ReversibleIterable<K>

Specified by:

takeWhile in interface SortedMapIterable<K,V>

dropWhile

public ImmutableSortedMap<K,V> dropWhile(Predicate<? super V> predicate)

Description copied from interface: ReversibleIterable

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

Specified by:

dropWhile in interface OrderedIterable<K>

Specified by:

dropWhile in interface ReversibleIterable<K>

Specified by:

dropWhile in interface SortedMapIterable<K,V>

partitionWhile

public PartitionImmutableList<V> partitionWhile(Predicate<? super V> predicate)

Description copied from interface: OrderedIterable

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

Specified by:

partitionWhile in interface OrderedIterable<K>

Specified by:

partitionWhile in interface ReversibleIterable<K>

Specified by:

partitionWhile in interface SortedMapIterable<K,V>

distinct

public ImmutableList<V> distinct()

Description copied from interface: OrderedIterable

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

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

Specified by:

distinct in interface OrderedIterable<K>

Specified by:

distinct in interface ReversibleIterable<K>

Specified by:

distinct in interface SortedMapIterable<K,V>

Returns:

OrderedIterable of distinct elements

corresponds

public <S> boolean corresponds(OrderedIterable<S> other,
 Predicate2<? super V, ? super S> predicate)

Description copied from interface: OrderedIterable

Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other. The predicate is evaluated for each element at the same position of each OrderedIterable in a forward iteration order. This is a short circuit pattern.

Specified by:

corresponds in interface OrderedIterable<K>

forEach

public void forEach(int startIndex,
 int endIndex,
 Procedure<? super V> procedure)

Description copied from interface: OrderedIterable

Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.

e.g.
OrderedIterable<Person> people = FastList.newListWith(ted, mary, bob, sally)
people.forEach(0, 1, person -> LOGGER.info(person.getName()));

This code would output ted and mary's names.

Specified by:

forEach in interface OrderedIterable<K>

forEachWithIndex

public void forEachWithIndex(int fromIndex,
 int toIndex,
 ObjectIntProcedure<? super V> objectIntProcedure)

Description copied from interface: OrderedIterable

Iterates over the section of the iterable covered by the specified inclusive indexes. The indexes are both inclusive.

e.g.
OrderedIterable<People> people = FastList.newListWith(ted, mary, bob, sally)
people.forEachWithIndex(0, 1, (person, index) -> LOGGER.info(person.getName()));

This code would output ted and mary's names.

Specified by:

forEachWithIndex in interface OrderedIterable<K>

toStack

public MutableStack<V> toStack()

Description copied from interface: OrderedIterable

Converts the OrderedIterable to a mutable MutableStack implementation.

Specified by:

toStack in interface OrderedIterable<K>

detectIndex

public int detectIndex(Predicate<? super V> predicate)

Description copied from interface: OrderedIterable

Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true. Returns -1 if no element evaluates true for the predicate.

Specified by:

detectIndex in interface OrderedIterable<K>

countBy

public <V1> ImmutableBag<V1> countBy(Function<? super V, ? extends V1> function)

Description copied from interface: RichIterable

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.

Specified by:

countBy in interface ImmutableMapIterable<K,V>

Specified by:

countBy in interface RichIterable<K>

Since:

9.0

countByWith

public <V1,P> ImmutableBag<V1> countByWith(Function2<? super V, ? super P, ? extends V1> function,
 P parameter)

Description copied from interface: RichIterable

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.

Specified by:

countByWith in interface ImmutableMapIterable<K,V>

Specified by:

countByWith in interface RichIterable<K>

Since:

9.0

countByEach

public <V1> ImmutableBag<V1> countByEach(Function<? super V, ? extends Iterable<V1>> function)

Description copied from interface: RichIterable

This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.

Specified by:

countByEach in interface ImmutableMapIterable<K,V>

Specified by:

countByEach in interface RichIterable<K>

Overrides:

countByEach in class AbstractRichIterable<V>

Since:

10.0.0

forEach

public void forEach(BiConsumer<? super K, ? super V> action)

Specified by:

forEach in interface Map<K,V>

Specified by:

forEach in interface MapIterable<K,V>