Class ImmutableOrderedMapAdapter<K,V>

java.lang.Object

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

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

org.eclipse.collections.impl.map.ordered.immutable.ImmutableOrderedMapAdapter<K,V>

All Implemented Interfaces:

Serializable, Iterable<V>, Map<K,V>, InternalIterable<V>, ImmutableMapIterable<K,V>, ImmutableOrderedMap<K,V>, MapIterable<K,V>, OrderedMap<K,V>, OrderedIterable<V>, ReversibleIterable<V>, RichIterable<V>

public class ImmutableOrderedMapAdapter<K,V>
extends AbstractMapIterable<K,V>
implements ImmutableOrderedMap<K,V>, Map<K,V>, Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field	Description
private final MutableOrderedMap<K,V>	delegate
private static final long	serialVersionUID

Constructor Summary

Constructors

Constructor	Description
ImmutableOrderedMapAdapter(Map<K,V> delegate)

Method Summary

Modifier and Type	Method	Description
<KK,VVV,VV> ImmutableOrderedMap<KK,VV>	aggregateBy(Function<? super K, ? extends KK> keyFunction, Function<? super V, ? extends VVV> valueFunction, Function0<? extends VV> zeroValueFactory, Function2<? super VV, ? super VVV, ? extends VV> nonMutatingAggregator)	Applies an aggregate function over the map grouping results into a map based on the specific key and value groupBy functions.
<KK,VV> ImmutableOrderedMap<KK,VV>	aggregateBy(Function<? super V, ? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Function2<? super VV, ? super V, ? extends VV> nonMutatingAggregator)	Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
<KK,VV> ImmutableOrderedMap<KK,VV>	aggregateInPlaceBy(Function<? super V, ? extends KK> groupBy, Function0<? extends VV> zeroValueFactory, Procedure2<? super VV, ? super V> mutatingAggregator)	Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
Map<K,V>	castToMap()
void	clear()
<VV> ImmutableList<VV>	collect(Function<? super V, ? extends VV> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
<K2,V2> ImmutableOrderedMap<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.
<VV> ImmutableList<VV>	collectIf(Predicate<? super V> predicate, Function<? super V, ? extends VV> 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> ImmutableOrderedMap<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.
boolean	containsKey(Object key)
boolean	containsValue(Object value)
<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>	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.
V	detect(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.
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<V>	detectOptional(Predicate<? super V> predicate)	Returns the first element of the iterable for which the predicate evaluates to true as an Optional.
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.
ImmutableOrderedMap<K,V>	drop(int count)	Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
ImmutableOrderedMap<K,V>	dropWhile(Predicate<? super V> predicate)	Returns the final elements that do not satisfy the Predicate.
Set<Map.Entry<K,V>>	entrySet()
boolean	equals(Object obj)	Follows the same general contract as Map.equals(Object).
<VV> ImmutableList<VV>	flatCollect(Function<? super V, ? extends Iterable<VV>> function)	flatCollect is a special case of RichIterable.collect(Function).
ImmutableListMultimap<V,K>	flip()	Given a map from Domain -> Range return a multimap from Range -> Domain.
ImmutableOrderedMap<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(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	forEachKey(Procedure<? super K> procedure)	Calls the procedure with each key of the map.
void	forEachKeyValue(Procedure2<? super K, ? super V> procedure)	Calls the procedure with each key-value pair of the map.
void	forEachValue(Procedure<? super V> procedure)	Calls the procedure with each value of the map.
<P> void	forEachWith(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(int fromIndex, int toIndex, ObjectIntProcedure<? super V> objectIntProcedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithIndex(ObjectIntProcedure<? super V> objectIntProcedure)	Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
V	get(Object key)
V	getIfAbsent(K key, 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	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, 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.
<VV> ImmutableListMultimap<VV,V>	groupBy(Function<? super V, ? extends VV> function)	For each element of the iterable, the function is evaluated and the results of these evaluations are collected into a new multimap, where the transformed value is the key and the original values are added to the same (or similar) species of collection as the source iterable.
<VV> ImmutableListMultimap<VV,V>	groupByEach(Function<? super V, ? extends Iterable<VV>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<VV> ImmutableOrderedMap<VV,V>	groupByUniqueKey(Function<? super V, ? extends VV> function)	For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key.
int	hashCode()	Follows the same general contract as Map.hashCode().
<A> A	ifPresentApply(K key, 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.
Iterator<V>	iterator()
Set<K>	keySet()
RichIterable<K>	keysView()	Returns an unmodifiable lazy iterable wrapped around the keySet for the map.
RichIterable<Pair<K,V>>	keyValuesView()	Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.
ImmutableOrderedMap<K,V>	newWithAllKeyValueArguments(Pair<? extends K, ? extends V>... keyValuePairs)
ImmutableOrderedMap<K,V>	newWithAllKeyValues(Iterable<? extends Pair<? extends K, ? extends V>> keyValues)
ImmutableOrderedMap<K,V>	newWithKeyValue(K key, V value)
ImmutableOrderedMap<K,V>	newWithMap(Map<? extends K, ? extends V> map)
ImmutableOrderedMap<K,V>	newWithMapIterable(MapIterable<? extends K, ? extends V> mapIterable)
ImmutableOrderedMap<K,V>	newWithoutAllKeys(Iterable<? extends K> keys)
ImmutableOrderedMap<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)
<KK> ImmutableOrderedMap<KK,V>	reduceBy(Function<? super V, ? extends KK> groupBy, Function2<? super V, ? super V, ? extends V> reduceFunction)	Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
ImmutableList<V>	reject(Predicate<? super V> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
ImmutableOrderedMap<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.
ImmutableOrderedMap<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.
int	size()	Returns the number of items in this iterable.
<VV> ImmutableObjectDoubleMap<VV>	sumByDouble(Function<? super V, ? extends VV> groupBy, DoubleFunction<? super V> function)	Groups and sums the values using the two specified functions.
<VV> ImmutableObjectDoubleMap<VV>	sumByFloat(Function<? super V, ? extends VV> groupBy, FloatFunction<? super V> function)	Groups and sums the values using the two specified functions.
<VV> ImmutableObjectLongMap<VV>	sumByInt(Function<? super V, ? extends VV> groupBy, IntFunction<? super V> function)	Groups and sums the values using the two specified functions.
<VV> ImmutableObjectLongMap<VV>	sumByLong(Function<? super V, ? extends VV> groupBy, LongFunction<? super V> function)	Groups and sums the values using the two specified functions.
ImmutableOrderedMap<K,V>	take(int count)	Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
ImmutableOrderedMap<K,V>	takeWhile(Predicate<? super V> predicate)	Returns the initial elements that satisfy the Predicate.
ImmutableOrderedMap<K,V>	tap(Procedure<? super V> procedure)	Executes the Procedure for each element in the iterable and returns this.
ImmutableOrderedMap<K,V>	toImmutable()
ImmutableOrderedMap<K,V>	toReversed()	Returns a new ReversibleIterable in reverse order.
String	toString()	Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.
Collection<V>	values()
RichIterable<V>	valuesView()	Returns an unmodifiable lazy iterable wrapped around the values for the map.
<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, detectIfNone, detectWith, detectWithIfNone, detectWithOptional, each, getFirst, getLast, getOnly, getOrDefault, 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, zip, zipWithIndex

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface ImmutableMapIterable

countBy, countByWith

Methods inherited from interface ImmutableOrderedMap

flatCollectWith

Methods inherited from interface InternalIterable

forEach

Methods inherited from interface Map

compute, computeIfAbsent, computeIfPresent, getOrDefault, isEmpty, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface MapIterable

getOrDefault, injectIntoKeyValue, parallelStream, spliterator, stream

Methods inherited from interface OrderedIterable

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

Methods inherited from interface ReversibleIterable

asReversed, collectWithIndex, 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, detectIfNone, 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, 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

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

delegate

private final MutableOrderedMap<K,V> delegate

Constructor Details

ImmutableOrderedMapAdapter

public ImmutableOrderedMapAdapter(Map<K,V> delegate)

Method Details

hashCode

public int hashCode()

Description copied from interface: MapIterable

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

Specified by:

hashCode in interface Map<K,V>

Specified by:

hashCode in interface MapIterable<K,V>

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Description copied from interface: MapIterable

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

Specified by:

equals in interface Map<K,V>

Specified by:

equals in interface MapIterable<K,V>

Overrides:

equals in class Object

toString

public String toString()

Description copied from class: AbstractRichIterable

Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.

Assert.assertEquals("[]", Lists.mutable.empty().toString());
Assert.assertEquals("[1]", Lists.mutable.with(1).toString());
Assert.assertEquals("[1, 2, 3]", Lists.mutable.with(1, 2, 3).toString());

Specified by:

toString in interface MapIterable<K,V>

Specified by:

toString in interface RichIterable<K>

Overrides:

toString in class AbstractRichIterable<V>

Returns:

a string representation of this collection.

See Also:

• AbstractCollection.toString()

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>

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface Map<K,V>

Specified by:

size in interface RichIterable<K>

containsKey

public boolean containsKey(Object key)

Specified by:

containsKey in interface Map<K,V>

Specified by:

containsKey in interface MapIterable<K,V>

See Also:

• Map.containsKey(Object)

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface Map<K,V>

Specified by:

containsValue in interface MapIterable<K,V>

See Also:

• Map.containsValue(Object)

get

public V get(Object key)

Specified by:

get in interface Map<K,V>

Specified by:

get in interface MapIterable<K,V>

See Also:

• Map.get(Object)

forEachValue

public void forEachValue(Procedure<? super V> procedure)

Description copied from interface: 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 MapIterable<K,V>

Overrides:

forEachValue in class AbstractMapIterable<K,V>

forEachKey

public void forEachKey(Procedure<? super K> procedure)

Description copied from interface: 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 MapIterable<K,V>

Overrides:

forEachKey in class AbstractMapIterable<K,V>

forEachKeyValue

public void forEachKeyValue(Procedure2<? super K, ? super V> procedure)

Description copied from interface: 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((Integer key, String value) -> collection.add(String.valueOf(key) + value));
    Verify.assertContainsAll(collection, "1One", "2Two", "3Three");

Specified by:

forEachKeyValue in interface MapIterable<K,V>

keysView

public RichIterable<K> keysView()

Description copied from interface: MapIterable

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

Specified by:

keysView in interface MapIterable<K,V>

valuesView

public RichIterable<V> valuesView()

Description copied from interface: MapIterable

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

Specified by:

valuesView in interface MapIterable<K,V>

keyValuesView

public RichIterable<Pair<K,V>> keyValuesView()

Description copied from interface: MapIterable

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

Specified by:

keyValuesView in interface MapIterable<K,V>

forEachWithIndex

public void forEachWithIndex(ObjectIntProcedure<? super V> objectIntProcedure)

Description copied from interface: InternalIterable

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

Example using a Java 8 lambda:

people.forEachWithIndex((Person person, int index) -> LOGGER.info("Index: " + index + " person: " + person.getName()));

Example using an anonymous inner class:

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

Specified by:

forEachWithIndex in interface InternalIterable<K>

Specified by:

forEachWithIndex in interface OrderedIterable<K>

Overrides:

forEachWithIndex in class AbstractMapIterable<K,V>

forEachWith

public <P> void forEachWith(Procedure2<? super V, ? super P> procedure,
 P parameter)

Description copied from interface: InternalIterable

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

Example using a Java 8 lambda:

people.forEachWith((Person person, Person other) ->
    {
        if (person.isRelatedTo(other))
        {
             LOGGER.info(person.getName());
        }
    }, fred);

Example using an anonymous inner class:

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

Specified by:

forEachWith in interface InternalIterable<K>

Overrides:

forEachWith in class AbstractMapIterable<K,V>

ifPresentApply

public <A> A ifPresentApply(K key,
 Function<? super V, ? extends A> function)

Description copied from interface: 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 MapIterable<K,V>

Overrides:

ifPresentApply in class AbstractMapIterable<K,V>

getIfAbsent

public V getIfAbsent(K key,
 Function0<? extends V> function)

Description copied from interface: 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 MapIterable<K,V>

Overrides:

getIfAbsent in class AbstractMapIterable<K,V>

getIfAbsentValue

public V getIfAbsentValue(K key,
 V value)

Description copied from interface: 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 MapIterable<K,V>

Overrides:

getIfAbsentValue in class AbstractMapIterable<K,V>

getIfAbsentWith

public <P> V getIfAbsentWith(K key,
 Function<? super P, ? extends V> function,
 P parameter)

Description copied from interface: 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 MapIterable<K,V>

Overrides:

getIfAbsentWith in class AbstractMapIterable<K,V>

castToMap

public Map<K,V> castToMap()

Specified by:

castToMap in interface ImmutableMapIterable<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>

flip

public ImmutableListMultimap<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 ImmutableOrderedMap<K,V>

Specified by:

flip in interface MapIterable<K,V>

Specified by:

flip in interface OrderedMap<K,V>

newWithKeyValue

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

Specified by:

newWithKeyValue in interface ImmutableMapIterable<K,V>

Specified by:

newWithKeyValue in interface ImmutableOrderedMap<K,V>

newWithAllKeyValues

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

Specified by:

newWithAllKeyValues in interface ImmutableMapIterable<K,V>

Specified by:

newWithAllKeyValues in interface ImmutableOrderedMap<K,V>

newWithMap

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

Specified by:

newWithMap in interface ImmutableMapIterable<K,V>

Specified by:

newWithMap in interface ImmutableOrderedMap<K,V>

newWithMapIterable

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

Specified by:

newWithMapIterable in interface ImmutableMapIterable<K,V>

Specified by:

newWithMapIterable in interface ImmutableOrderedMap<K,V>

newWithAllKeyValueArguments

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

Specified by:

newWithAllKeyValueArguments in interface ImmutableMapIterable<K,V>

Specified by:

newWithAllKeyValueArguments in interface ImmutableOrderedMap<K,V>

newWithoutKey

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

Specified by:

newWithoutKey in interface ImmutableMapIterable<K,V>

Specified by:

newWithoutKey in interface ImmutableOrderedMap<K,V>

newWithoutAllKeys

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

Specified by:

newWithoutAllKeys in interface ImmutableMapIterable<K,V>

Specified by:

newWithoutAllKeys in interface ImmutableOrderedMap<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>

flipUniqueValues

public ImmutableOrderedMap<V,K> flipUniqueValues()

Description copied from interface: MapIterable

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

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

Specified by:

flipUniqueValues in interface ImmutableMapIterable<K,V>

Specified by:

flipUniqueValues in interface ImmutableOrderedMap<K,V>

Specified by:

flipUniqueValues in interface MapIterable<K,V>

Specified by:

flipUniqueValues in interface OrderedMap<K,V>

collect

public <K2,V2> ImmutableOrderedMap<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 ImmutableOrderedMap<K,V>

Specified by:

collect in interface MapIterable<K,V>

Specified by:

collect in interface OrderedMap<K,V>

collectValues

public <R> ImmutableOrderedMap<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 ImmutableOrderedMap<K,V>

Specified by:

collectValues in interface MapIterable<K,V>

Specified by:

collectValues in interface OrderedMap<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 ImmutableOrderedMap<K,V>

Specified by:

collectKeysUnique in interface MapIterable<K,V>

select

public ImmutableOrderedMap<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 ImmutableOrderedMap<K,V>

Specified by:

select in interface MapIterable<K,V>

Specified by:

select in interface OrderedMap<K,V>

reject

public ImmutableOrderedMap<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 ImmutableOrderedMap<K,V>

Specified by:

reject in interface MapIterable<K,V>

Specified by:

reject in interface OrderedMap<K,V>

detect

public V detect(Predicate<? super V> predicate)

Description copied from interface: 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.

Example using a Java 8 lambda expression:

Person person =
    people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));

Specified by:

detect in interface RichIterable<K>

Overrides:

detect in class AbstractMapIterable<K,V>

detectOptional

public Optional<V> detectOptional(Predicate<? super V> predicate)

Description copied from interface: RichIterable

Returns the first element of the iterable for which the predicate evaluates to true as an Optional. This method is commonly called find.

Example using a Java 8 lambda expression:

Person person =
    people.detectOptional(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));

Specified by:

detectOptional in interface RichIterable<K>

Overrides:

detectOptional in class AbstractMapIterable<K,V>

collect

public <VV> ImmutableList<VV> collect(Function<? super V, ? extends VV> 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 ImmutableOrderedMap<K,V>

Specified by:

collect in interface OrderedIterable<K>

Specified by:

collect in interface OrderedMap<K,V>

Specified by:

collect in interface ReversibleIterable<K>

Specified by:

collect in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

collectWith in interface OrderedIterable<K>

Specified by:

collectWith in interface OrderedMap<K,V>

Specified by:

collectWith in interface ReversibleIterable<K>

Specified by:

collectWith in interface RichIterable<K>

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)

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 ImmutableOrderedMap<K,V>

Specified by:

collectBoolean in interface OrderedIterable<K>

Specified by:

collectBoolean in interface OrderedMap<K,V>

Specified by:

collectBoolean in interface ReversibleIterable<K>

Specified by:

collectBoolean in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

collectByte in interface OrderedIterable<K>

Specified by:

collectByte in interface OrderedMap<K,V>

Specified by:

collectByte in interface ReversibleIterable<K>

Specified by:

collectByte in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

collectChar in interface OrderedIterable<K>

Specified by:

collectChar in interface OrderedMap<K,V>

Specified by:

collectChar in interface ReversibleIterable<K>

Specified by:

collectChar in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

collectDouble in interface OrderedIterable<K>

Specified by:

collectDouble in interface OrderedMap<K,V>

Specified by:

collectDouble in interface ReversibleIterable<K>

Specified by:

collectDouble in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

collectFloat in interface OrderedIterable<K>

Specified by:

collectFloat in interface OrderedMap<K,V>

Specified by:

collectFloat in interface ReversibleIterable<K>

Specified by:

collectFloat in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

collectInt in interface OrderedIterable<K>

Specified by:

collectInt in interface OrderedMap<K,V>

Specified by:

collectInt in interface ReversibleIterable<K>

Specified by:

collectInt in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

collectLong in interface OrderedIterable<K>

Specified by:

collectLong in interface OrderedMap<K,V>

Specified by:

collectLong in interface ReversibleIterable<K>

Specified by:

collectLong in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

collectShort in interface OrderedIterable<K>

Specified by:

collectShort in interface OrderedMap<K,V>

Specified by:

collectShort in interface ReversibleIterable<K>

Specified by:

collectShort in interface RichIterable<K>

collectIf

public <VV> ImmutableList<VV> collectIf(Predicate<? super V> predicate,
 Function<? super V, ? extends VV> 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 ImmutableOrderedMap<K,V>

Specified by:

collectIf in interface OrderedIterable<K>

Specified by:

collectIf in interface OrderedMap<K,V>

Specified by:

collectIf in interface ReversibleIterable<K>

Specified by:

collectIf in interface RichIterable<K>

flatCollect

public <VV> ImmutableList<VV> flatCollect(Function<? super V, ? extends Iterable<VV>> 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 ImmutableOrderedMap<K,V>

Specified by:

flatCollect in interface OrderedIterable<K>

Specified by:

flatCollect in interface OrderedMap<K,V>

Specified by:

flatCollect in interface ReversibleIterable<K>

Specified by:

flatCollect in interface RichIterable<K>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

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 ImmutableOrderedMap<K,V>

Specified by:

select in interface OrderedIterable<K>

Specified by:

select in interface OrderedMap<K,V>

Specified by:

select in interface ReversibleIterable<K>

Specified by:

select in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

selectWith in interface OrderedIterable<K>

Specified by:

selectWith in interface OrderedMap<K,V>

Specified by:

selectWith in interface ReversibleIterable<K>

Specified by:

selectWith in interface RichIterable<K>

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 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 ImmutableOrderedMap<K,V>

Specified by:

reject in interface OrderedIterable<K>

Specified by:

reject in interface OrderedMap<K,V>

Specified by:

reject in interface ReversibleIterable<K>

Specified by:

reject in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

rejectWith in interface OrderedIterable<K>

Specified by:

rejectWith in interface OrderedMap<K,V>

Specified by:

rejectWith in interface ReversibleIterable<K>

Specified by:

rejectWith in interface RichIterable<K>

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)

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 ImmutableOrderedMap<K,V>

Specified by:

partition in interface OrderedIterable<K>

Specified by:

partition in interface OrderedMap<K,V>

Specified by:

partition in interface ReversibleIterable<K>

Specified by:

partition in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

partitionWith in interface OrderedIterable<K>

Specified by:

partitionWith in interface OrderedMap<K,V>

Specified by:

partitionWith in interface ReversibleIterable<K>

Specified by:

partitionWith in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

selectInstancesOf in interface OrderedIterable<K>

Specified by:

selectInstancesOf in interface OrderedMap<K,V>

Specified by:

selectInstancesOf in interface ReversibleIterable<K>

Specified by:

selectInstancesOf in interface RichIterable<K>

tap

public ImmutableOrderedMap<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 ImmutableOrderedMap<K,V>

Specified by:

tap in interface MapIterable<K,V>

Specified by:

tap in interface OrderedIterable<K>

Specified by:

tap in interface OrderedMap<K,V>

Specified by:

tap in interface ReversibleIterable<K>

Specified by:

tap in interface RichIterable<K>

See Also:

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

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 ImmutableOrderedMap<K,V>

Specified by:

zip in interface OrderedIterable<K>

Specified by:

zip in interface OrderedMap<K,V>

Specified by:

zip in interface ReversibleIterable<K>

Specified by:

zip in interface RichIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

zipWithIndex in interface OrderedIterable<K>

Specified by:

zipWithIndex in interface OrderedMap<K,V>

Specified by:

zipWithIndex in interface ReversibleIterable<K>

Specified by:

zipWithIndex in interface RichIterable<K>

Returns:

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

See Also:

• RichIterable.zip(Iterable)

groupBy

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

Description copied from interface: RichIterable

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

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 ImmutableOrderedMap<K,V>

Specified by:

groupBy in interface OrderedIterable<K>

Specified by:

groupBy in interface OrderedMap<K,V>

Specified by:

groupBy in interface ReversibleIterable<K>

Specified by:

groupBy in interface RichIterable<K>

groupByEach

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

Description copied from interface: RichIterable

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

Specified by:

groupByEach in interface ImmutableMapIterable<K,V>

Specified by:

groupByEach in interface ImmutableOrderedMap<K,V>

Specified by:

groupByEach in interface OrderedIterable<K>

Specified by:

groupByEach in interface OrderedMap<K,V>

Specified by:

groupByEach in interface ReversibleIterable<K>

Specified by:

groupByEach in interface RichIterable<K>

groupByUniqueKey

public <VV> ImmutableOrderedMap<VV,V> groupByUniqueKey(Function<? super V, ? extends VV> function)

Description copied from interface: RichIterable

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

Specified by:

groupByUniqueKey in interface OrderedMap<K,V>

Specified by:

groupByUniqueKey in interface RichIterable<K>

See Also:

• RichIterable.groupBy(Function)

aggregateInPlaceBy

public <KK,VV> ImmutableOrderedMap<KK,VV> aggregateInPlaceBy(Function<? super V, ? extends KK> groupBy,
 Function0<? extends VV> zeroValueFactory,
 Procedure2<? super VV, ? super V> mutatingAggregator)

Description copied from interface: RichIterable

Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function. Aggregate results are required to be mutable as they will be changed in place by the procedure. A second function specifies the initial "zero" aggregate value to work with (i.e. new AtomicInteger(0)).

Specified by:

aggregateInPlaceBy in interface ImmutableMapIterable<K,V>

Specified by:

aggregateInPlaceBy in interface ImmutableOrderedMap<K,V>

Specified by:

aggregateInPlaceBy in interface RichIterable<K>

aggregateBy

public <KK,VV> ImmutableOrderedMap<KK,VV> aggregateBy(Function<? super V, ? extends KK> groupBy,
 Function0<? extends VV> zeroValueFactory,
 Function2<? super VV, ? super V, ? extends VV> nonMutatingAggregator)

Description copied from interface: RichIterable

Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map. A second function specifies the initial "zero" aggregate value to work with (i.e. Integer.valueOf(0)).

Specified by:

aggregateBy in interface ImmutableMapIterable<K,V>

Specified by:

aggregateBy in interface ImmutableOrderedMap<K,V>

Specified by:

aggregateBy in interface RichIterable<K>

aggregateBy

public <KK,VVV,VV> ImmutableOrderedMap<KK,VV> aggregateBy(Function<? super K, ? extends KK> keyFunction,
 Function<? super V, ? extends VVV> valueFunction,
 Function0<? extends VV> zeroValueFactory,
 Function2<? super VV, ? super VVV, ? extends VV> 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 ImmutableOrderedMap<K,V>

Specified by:

aggregateBy in interface MapIterable<K,V>

reduceBy

public <KK> ImmutableOrderedMap<KK,V> reduceBy(Function<? super V, ? extends KK> groupBy,
 Function2<? super V, ? super V, ? extends V> reduceFunction)

Description copied from interface: RichIterable

Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function. Aggregate results are allowed to be immutable as they will be replaced in place in the map.

Specified by:

reduceBy in interface ImmutableMapIterable<K,V>

Specified by:

reduceBy in interface ImmutableOrderedMap<K,V>

Specified by:

reduceBy in interface RichIterable<K>

sumByInt

public <VV> ImmutableObjectLongMap<VV> sumByInt(Function<? super V, ? extends VV> 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 ImmutableOrderedMap<K,V>

Specified by:

sumByInt in interface RichIterable<K>

sumByFloat

public <VV> ImmutableObjectDoubleMap<VV> sumByFloat(Function<? super V, ? extends VV> 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 ImmutableOrderedMap<K,V>

Specified by:

sumByFloat in interface RichIterable<K>

sumByLong

public <VV> ImmutableObjectLongMap<VV> sumByLong(Function<? super V, ? extends VV> 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 ImmutableOrderedMap<K,V>

Specified by:

sumByLong in interface RichIterable<K>

sumByDouble

public <VV> ImmutableObjectDoubleMap<VV> sumByDouble(Function<? super V, ? extends VV> 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 ImmutableOrderedMap<K,V>

Specified by:

sumByDouble in interface RichIterable<K>

toReversed

public ImmutableOrderedMap<K,V> toReversed()

Description copied from interface: ReversibleIterable

Returns a new ReversibleIterable in reverse order.

Specified by:

toReversed in interface ImmutableOrderedMap<K,V>

Specified by:

toReversed in interface OrderedMap<K,V>

Specified by:

toReversed in interface ReversibleIterable<K>

take

public ImmutableOrderedMap<K,V> take(int count)

Description copied from interface: ReversibleIterable

Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.

Specified by:

take in interface ImmutableOrderedMap<K,V>

Specified by:

take in interface OrderedMap<K,V>

Specified by:

take in interface ReversibleIterable<K>

Parameters:

count - the number of items to take.

takeWhile

public ImmutableOrderedMap<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 ImmutableOrderedMap<K,V>

Specified by:

takeWhile in interface OrderedIterable<K>

Specified by:

takeWhile in interface OrderedMap<K,V>

Specified by:

takeWhile in interface ReversibleIterable<K>

drop

public ImmutableOrderedMap<K,V> drop(int count)

Description copied from interface: ReversibleIterable

Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.

Specified by:

drop in interface ImmutableOrderedMap<K,V>

Specified by:

drop in interface OrderedMap<K,V>

Specified by:

drop in interface ReversibleIterable<K>

Parameters:

count - the number of items to drop.

dropWhile

public ImmutableOrderedMap<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 ImmutableOrderedMap<K,V>

Specified by:

dropWhile in interface OrderedIterable<K>

Specified by:

dropWhile in interface OrderedMap<K,V>

Specified by:

dropWhile in interface ReversibleIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

partitionWhile in interface OrderedIterable<K>

Specified by:

partitionWhile in interface OrderedMap<K,V>

Specified by:

partitionWhile in interface ReversibleIterable<K>

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 ImmutableOrderedMap<K,V>

Specified by:

distinct in interface OrderedIterable<K>

Specified by:

distinct in interface OrderedMap<K,V>

Specified by:

distinct in interface ReversibleIterable<K>

Returns:

OrderedIterable of distinct elements

toImmutable

public ImmutableOrderedMap<K,V> toImmutable()

Specified by:

toImmutable in interface MapIterable<K,V>

Specified by:

toImmutable in interface OrderedMap<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>

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>

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>

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>

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>

keySet

public Set<K> keySet()

Specified by:

keySet in interface Map<K,V>

values

public Collection<V> values()

Specified by:

values in interface Map<K,V>

entrySet

public Set<Map.Entry<K,V>> entrySet()

Specified by:

entrySet in interface Map<K,V>