Package org.eclipse.collections.impl.map.mutable.primitive

Class SynchronizedLongObjectMap<V>

java.lang.Object

org.eclipse.collections.impl.map.mutable.primitive.SynchronizedLongObjectMap<V>

All Implemented Interfaces:

Serializable, Iterable<V>, InternalIterable<V>, LongObjectMap<V>, MutableLongObjectMap<V>, MutablePrimitiveObjectMap<V>, PrimitiveObjectMap<V>, RichIterable<V>

public class SynchronizedLongObjectMap<V>
extends Object
implements MutableLongObjectMap<V>, Serializable

A synchronized view of a MutableLongObjectMap. It is imperative that the user manually synchronize on the collection when iterating over it using the standard JDK iterator or JDK 5 for loop, as per Collections.synchronizedCollection(Collection).

This file was automatically generated from template file synchronizedPrimitiveObjectMap.stg.

Since:

3.1.

See Also:

• MutableLongObjectMap.asSynchronized()
• MutableMap.asSynchronized()
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SynchronizedLongObjectMap(MutableLongObjectMap<V> map)
SynchronizedLongObjectMap(MutableLongObjectMap<V> map, Object newLock)

Method Summary

Modifier and Type	Method	Description
<K, VV> MutableMap<K,VV>	aggregateBy(Function<? super V,? extends K> 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.
<K, VV> MutableMap<K,VV>	aggregateInPlaceBy(Function<? super V,? extends K> 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.
boolean	allSatisfy(Predicate<? super V> predicate)	Returns true if the predicate evaluates to true for every element of the iterable or if the iterable is empty.
<P> boolean	allSatisfyWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns true if the predicate evaluates to true for every element of the collection, or returns false.
boolean	anySatisfy(Predicate<? super V> predicate)	Returns true if the predicate evaluates to true for any element of the iterable.
<P> boolean	anySatisfyWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns true if the predicate evaluates to true for any element of the collection, or return false.
void	appendString(Appendable appendable)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyIterable<V>	asLazy()	Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
MutableLongObjectMap<V>	asSynchronized()	Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.
MutableLongObjectMap<V>	asUnmodifiable()	Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations.
RichIterable<RichIterable<V>>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<VV> MutableBag<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.
<VV, R extends Collection<VV>> R	collect(Function<? super V,? extends VV> function, R target)	Same as RichIterable.collect(Function), except that the results are gathered into the specified target collection.
MutableBooleanBag	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.
<R extends MutableBooleanCollection> R	collectBoolean(BooleanFunction<? super V> booleanFunction, R target)	Same as RichIterable.collectBoolean(BooleanFunction), except that the results are gathered into the specified target collection.
MutableByteBag	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.
<R extends MutableByteCollection> R	collectByte(ByteFunction<? super V> byteFunction, R target)	Same as RichIterable.collectByte(ByteFunction), except that the results are gathered into the specified target collection.
MutableCharBag	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.
<R extends MutableCharCollection> R	collectChar(CharFunction<? super V> charFunction, R target)	Same as RichIterable.collectChar(CharFunction), except that the results are gathered into the specified target collection.
MutableDoubleBag	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.
<R extends MutableDoubleCollection> R	collectDouble(DoubleFunction<? super V> doubleFunction, R target)	Same as RichIterable.collectDouble(DoubleFunction), except that the results are gathered into the specified target collection.
MutableFloatBag	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 extends MutableFloatCollection> R	collectFloat(FloatFunction<? super V> floatFunction, R target)	Same as RichIterable.collectFloat(FloatFunction), except that the results are gathered into the specified target collection.
<VV> MutableBag<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.
<VV, R extends Collection<VV>> R	collectIf(Predicate<? super V> predicate, Function<? super V,? extends VV> function, R target)	Same as the collectIf method with two parameters but uses the specified target collection for the results.
MutableIntBag	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 extends MutableIntCollection> R	collectInt(IntFunction<? super V> intFunction, R target)	Same as RichIterable.collectInt(IntFunction), except that the results are gathered into the specified target collection.
MutableLongBag	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.
<R extends MutableLongCollection> R	collectLong(LongFunction<? super V> longFunction, R target)	Same as RichIterable.collectLong(LongFunction), except that the results are gathered into the specified target collection.
MutableShortBag	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 extends MutableShortCollection> R	collectShort(ShortFunction<? super V> shortFunction, R target)	Same as RichIterable.collectShort(ShortFunction), except that the results are gathered into the specified target collection.
<P, VV> MutableBag<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.
<P, VV, R extends Collection<VV>> R	collectWith(Function2<? super V,? super P,? extends VV> function, P parameter, R targetCollection)	Same as collectWith but with a targetCollection parameter to gather the results.
boolean	contains(Object object)	Returns true if the iterable has an element which responds true to element.equals(object).
boolean	containsAll(Collection<?> source)	Returns true if all elements in source are contained in this collection.
boolean	containsAllArguments(Object... elements)	Returns true if all elements in the specified var arg array are contained in this collection.
boolean	containsAllIterable(Iterable<?> source)	Returns true if all elements in source are contained in this collection.
boolean	containsAny(Collection<?> source)	Returns true if any of the elements in source is contained in this collection.
boolean	containsAnyIterable(Iterable<?> source)	Returns true if any of the elements in source is contained in this collection.
boolean	containsKey(long key)	Returns whether or not the key is present in the map.
boolean	containsNone(Collection<?> source)	Returns true if none of the elements in source are contained in this collection.
boolean	containsNoneIterable(Iterable<?> source)	Returns true if none of the elements in source are contained in this collection.
boolean	containsValue(Object value)
int	count(Predicate<? super V> predicate)	Return the total number of elements that answer true to the specified predicate.
<P> int	countWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns the total number of elements that evaluate to true for the specified predicate.
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.
V	detectIfNone(Predicate<? super V> predicate, Function0<? extends V> function)	Returns the first element of the iterable 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.
<P> V	detectWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.
<P> V	detectWithIfNone(Predicate2<? super V,? super P> predicate, P parameter, Function0<? extends V> function)	Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.
<P> Optional<V>	detectWithOptional(Predicate2<? super V,? super P> predicate, P parameter)	Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.
void	each(Procedure<? super V> procedure)	The procedure is executed for each element in the iterable.
boolean	equals(Object obj)	Follows the same general contract as Map.equals(Object).
<VV> MutableBag<VV>	flatCollect(Function<? super V,? extends Iterable<VV>> function)	flatCollect is a special case of RichIterable.collect(Function).
<VV, R extends Collection<VV>> R	flatCollect(Function<? super V,? extends Iterable<VV>> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableBooleanCollection> R	flatCollectBoolean(Function<? super V,? extends BooleanIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableByteCollection> R	flatCollectByte(Function<? super V,? extends ByteIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableCharCollection> R	flatCollectChar(Function<? super V,? extends CharIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableDoubleCollection> R	flatCollectDouble(Function<? super V,? extends DoubleIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableFloatCollection> R	flatCollectFloat(Function<? super V,? extends FloatIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableIntCollection> R	flatCollectInt(Function<? super V,? extends IntIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableLongCollection> R	flatCollectLong(Function<? super V,? extends LongIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
<R extends MutableShortCollection> R	flatCollectShort(Function<? super V,? extends ShortIterable> function, R target)	Same as flatCollect, only the results are collected into the target collection.
MutableObjectLongMap<V>	flipUniqueValues()	Return the ObjectLongMap that is obtained by flipping the direction of this map and making the associations from value to key.
void	forEach(Procedure<? super V> procedure)	The procedure is executed for each element in the iterable.
void	forEachKey(LongProcedure procedure)	Iterates through each key in the map, invoking the procedure for each.
void	forEachKeyValue(LongObjectProcedure<? super V> procedure)	Iterates through each key/value pair in the map, invoking the procedure for each.
void	forEachValue(Procedure<? super V> procedure)
<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(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(long key)	Retrieves the value associated with the key.
V	getFirst()	Returns the first element of an iterable.
V	getIfAbsent(long key, Function0<? extends V> ifAbsent)	Retrieves the value associated with the key if one exists; if it does not, returns the result of invoking the value supplier.
V	getIfAbsentPut(long key, Function0<? extends V> function)	Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.
V	getIfAbsentPut(long key, V value)	Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.
<P> V	getIfAbsentPutWith(long key, Function<? super P,? extends V> function, P parameter)	Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.
V	getIfAbsentPutWithKey(long key, LongToObjectFunction<? extends V> function)	Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.
V	getLast()	Returns the last element of an iterable.
V	getOnly()	Returns the element if the iterable has exactly one element.
<VV> MutableBagMultimap<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, R extends MutableMultimap<VV, V>> R	groupBy(Function<? super V,? extends VV> function, R target)	Same as RichIterable.groupBy(Function), except that the results are gathered into the specified target multimap.
<VV> MutableBagMultimap<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, R extends MutableMultimap<VV, V>> R	groupByEach(Function<? super V,? extends Iterable<VV>> function, R target)	Same as RichIterable.groupByEach(Function), except that the results are gathered into the specified target multimap.
<VV> MutableMap<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.
<VV, R extends MutableMapIterable<VV, V>> R	groupByUniqueKey(Function<? super V,? extends VV> function, R target)	Same as RichIterable.groupByUniqueKey(Function), except that the results are gathered into the specified target map.
int	hashCode()	Follows the same general contract as Map.hashCode().
double	injectInto(double injectedValue, DoubleObjectToDoubleFunction<? super V> function)	Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
float	injectInto(float injectedValue, FloatObjectToFloatFunction<? super V> function)	Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
int	injectInto(int injectedValue, IntObjectToIntFunction<? super V> function)	Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
long	injectInto(long injectedValue, LongObjectToLongFunction<? super V> function)	Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
<IV> IV	injectInto(IV injectedValue, Function2<? super IV,? super V,? extends IV> function)	Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
<R extends Collection<V>> R	into(R target)	Adds all the elements in this iterable to the specific target Collection.
boolean	isEmpty()	Returns true if this iterable has zero items.
Iterator<V>	iterator()	Must be called in a synchronized block.
MutableLongSet	keySet()	Returns a set containing all the keys in this map.
LazyLongIterable	keysView()	Returns a view of the keys in this map.
RichIterable<LongObjectPair<V>>	keyValuesView()	Returns a view of the key/value pairs in this map.
String	makeString()	Returns a string representation of this collection by delegating to RichIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
String	makeString(String separator)	Returns a string representation of this collection by delegating to RichIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
String	makeString(String start, String separator, String end)	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
V	max()	Returns the maximum element out of this container based on the natural order.
V	max(Comparator<? super V> comparator)	Returns the maximum element out of this container based on the comparator.
<VV extends Comparable<? super VV>> V	maxBy(Function<? super V,? extends VV> function)	Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
V	min()	Returns the minimum element out of this container based on the natural order.
V	min(Comparator<? super V> comparator)	Returns the minimum element out of this container based on the comparator.
<VV extends Comparable<? super VV>> V	minBy(Function<? super V,? extends VV> function)	Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
boolean	noneSatisfy(Predicate<? super V> predicate)	Returns true if the predicate evaluates to false for every element of the iterable or if the iterable is empty.
<P> boolean	noneSatisfyWith(Predicate2<? super V,? super P> predicate, P parameter)	Returns true if the predicate evaluates to false for every element of the collection, or return false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
PartitionMutableBag<V>	partition(Predicate<? super V> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> PartitionMutableBag<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(long key, V value)	Associates a value with the specified key.
void	putAll(LongObjectMap<? extends V> map)	Puts all of the key/value mappings from the specified map into this map.
V	putPair(LongObjectPair<V> keyValuePair)	This method allows MutableLongObjectMap the ability to add an element in the form of LongObjectPair<V>.
MutableBag<V>	reject(Predicate<? super V> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
<R extends Collection<V>> R	reject(Predicate<? super V> predicate, R target)	Same as the reject method with one parameter but uses the specified target collection for the results.
MutableLongObjectMap<V>	reject(LongObjectPredicate<? super V> predicate)	Return a copy of this map containing only the key/value pairs that do not match the predicate.
<P> MutableBag<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.
<P, R extends Collection<V>> R	rejectWith(Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)	Similar to RichIterable.reject(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
V	remove(long key)	Removes the mapping associated with the key, if one exists, from the map.
V	removeKey(long key)	Removes the mapping associated with the key, if one exists, from the map.
MutableBag<V>	select(Predicate<? super V> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
<R extends Collection<V>> R	select(Predicate<? super V> predicate, R target)	Same as the select method with one parameter but uses the specified target collection for the results.
MutableLongObjectMap<V>	select(LongObjectPredicate<? super V> predicate)	Return a copy of this map containing only the key/value pairs that match the predicate.
<S> MutableBag<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
<P> MutableBag<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.
<P, R extends Collection<V>> R	selectWith(Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)	Similar to RichIterable.select(Predicate, Collection), except with an evaluation parameter for the second generic argument in Predicate2.
int	size()	Returns the number of items in this iterable.
<V1> MutableObjectDoubleMap<V1>	sumByDouble(Function<? super V,? extends V1> groupBy, DoubleFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> MutableObjectDoubleMap<V1>	sumByFloat(Function<? super V,? extends V1> groupBy, FloatFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> MutableObjectLongMap<V1>	sumByInt(Function<? super V,? extends V1> groupBy, IntFunction<? super V> function)	Groups and sums the values using the two specified functions.
<V1> MutableObjectLongMap<V1>	sumByLong(Function<? super V,? extends V1> groupBy, LongFunction<? super V> function)	Groups and sums the values using the two specified functions.
double	sumOfDouble(DoubleFunction<? super V> function)	Returns the final double result of evaluating function for each element of the iterable and adding the results together.
double	sumOfFloat(FloatFunction<? super V> function)	Returns the final double result of evaluating function for each element of the iterable and adding the results together.
long	sumOfInt(IntFunction<? super V> function)	Returns the final long result of evaluating function for each element of the iterable and adding the results together.
long	sumOfLong(LongFunction<? super V> function)	Returns the final long result of evaluating function for each element of the iterable and adding the results together.
MutableLongObjectMap<V>	tap(Procedure<? super V> procedure)	Executes the Procedure for each element in the iterable and returns this.
Object[]	toArray()	Converts this iterable to an array.
<T> T[]	toArray(T[] a)	Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.
MutableBag<V>	toBag()	Converts the collection to the default MutableBag implementation.
<NK, NV> MutableBiMap<NK,NV>	toBiMap(Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction)	Converts the collection to a BiMap implementation using the specified key and value functions.
ImmutableLongObjectMap<V>	toImmutable()	Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.
ImmutableBag<V>	toImmutableBag()	Converts the RichIterable to the default ImmutableBag implementation.
ImmutableList<V>	toImmutableList()	Converts the RichIterable to the default ImmutableList implementation.
ImmutableSet<V>	toImmutableSet()	Converts the RichIterable to the default ImmutableSet implementation.
ImmutableSortedBag<V>	toImmutableSortedBag()	Converts the RichIterable to the default ImmutableSortedBag implementation.
ImmutableSortedBag<V>	toImmutableSortedBag(Comparator<? super V> comparator)	Converts the collection to an ImmutableSortedBag implementation and sorts it using the specified comparator.
<VV extends Comparable<? super VV>> ImmutableSortedBag<V>	toImmutableSortedBagBy(Function<? super V,? extends VV> function)	Converts the collection to an ImmutableSortedBag implementation and sorts it based on the natural order of the attribute returned by function.
ImmutableList<V>	toImmutableSortedList()	Converts the RichIterable to the default sorted ImmutableList implementation.
ImmutableList<V>	toImmutableSortedList(Comparator<? super V> comparator)	Converts the collection to an ImmutableList implementation and sorts it using the specified comparator.
<VV extends Comparable<? super VV>> ImmutableList<V>	toImmutableSortedListBy(Function<? super V,? extends VV> function)	Converts the collection to an ImmutableList implementation and sorts it based on the natural order of the attribute returned by function.
ImmutableSortedSet<V>	toImmutableSortedSet()	Converts the RichIterable to the default ImmutableSortedSet implementation.
ImmutableSortedSet<V>	toImmutableSortedSet(Comparator<? super V> comparator)	Converts the collection to an ImmutableSortedSet implementation and sorts it using the specified comparator.
<VV extends Comparable<? super VV>> ImmutableSortedSet<V>	toImmutableSortedSetBy(Function<? super V,? extends VV> function)	Converts the collection to an ImmutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.
MutableList<V>	toList()	Converts the collection to a MutableList implementation.
<NK, NV> MutableMap<NK,NV>	toMap(Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction)	Converts the collection to a MutableMap implementation using the specified key and value functions.
<NK, NV, R extends Map<NK, NV>> R	toMap(Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction, R target)	Same as RichIterable.toMap(Function, Function), except that the results are gathered into the specified target map.
MutableSet<V>	toSet()	Converts the collection to a MutableSet implementation.
MutableSortedBag<V>	toSortedBag()	Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.
MutableSortedBag<V>	toSortedBag(Comparator<? super V> comparator)	Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.
<VV extends Comparable<? super VV>> MutableSortedBag<V>	toSortedBagBy(Function<? super V,? extends VV> function)	Converts the collection to a MutableSortedBag implementation and sorts it based on the natural order of the attribute returned by function.
MutableList<V>	toSortedList()	Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
MutableList<V>	toSortedList(Comparator<? super V> comparator)	Converts the collection to a MutableList implementation and sorts it using the specified comparator.
<VV extends Comparable<? super VV>> MutableList<V>	toSortedListBy(Function<? super V,? extends VV> function)	Converts the collection to a MutableList implementation and sorts it based on the natural order of the attribute returned by function.
<NK, NV> MutableSortedMap<NK,NV>	toSortedMap(Comparator<? super NK> comparator, Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction)	Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the given comparator.
<NK, NV> MutableSortedMap<NK,NV>	toSortedMap(Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction)	Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
<KK extends Comparable<? super KK>, NK, NV> MutableSortedMap<NK,NV>	toSortedMapBy(Function<? super NK,KK> sortBy, Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction)	Converts the collection to a MutableSortedMap implementation using the specified key and value functions and sorts it based on the natural order of the attribute returned by sortBy function.
MutableSortedSet<V>	toSortedSet()	Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.
MutableSortedSet<V>	toSortedSet(Comparator<? super V> comparator)	Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.
<VV extends Comparable<? super VV>> MutableSortedSet<V>	toSortedSetBy(Function<? super V,? extends VV> function)	Converts the collection to a MutableSortedSet implementation and sorts it based on the natural order of the attribute returned by function.
String	toString()	Returns a string with the keys and values of this map separated by commas with spaces and enclosed in curly braces.
V	updateValue(long key, Function0<? extends V> factory, Function<? super V,? extends V> function)	Look up the value associated with key, apply the function to it, and replace the value.
<P> V	updateValueWith(long key, Function0<? extends V> factory, Function2<? super V,? super P,? extends V> function, P parameter)	Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or the initial value supplied by the factory if one does not.
Collection<V>	values()
MutableLongObjectMap<V>	withKeyValue(long key, V value)	Associates a value with the specified key.
MutableLongObjectMap<V>	withoutAllKeys(LongIterable keys)	Removes the mappings associated with all the keys, if they exist, from this map.
MutableLongObjectMap<V>	withoutKey(long key)	Removes the mapping associated with the key, if one exists, from this map.
<S> MutableBag<Pair<V,S>>	zip(Iterable<S> that)	Deprecated. in 7.0.
<S, R extends Collection<Pair<V, S>>> R	zip(Iterable<S> that, R target)	Same as RichIterable.zip(Iterable) but uses target for output.
MutableSet<Pair<V,Integer>>	zipWithIndex()	Deprecated. in 7.0.
<R extends Collection<Pair<V, Integer>>> R	zipWithIndex(R target)	Same as RichIterable.zipWithIndex() but uses target for output.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.eclipse.collections.api.InternalIterable

forEach

Methods inherited from interface org.eclipse.collections.api.map.primitive.LongObjectMap

injectIntoKeyValue

Methods inherited from interface org.eclipse.collections.api.map.primitive.MutableLongObjectMap

withAllKeyValues

Methods inherited from interface org.eclipse.collections.api.map.primitive.MutablePrimitiveObjectMap

flatCollectWith

Methods inherited from interface org.eclipse.collections.api.map.primitive.PrimitiveObjectMap

parallelStream, spliterator, stream

Methods inherited from interface org.eclipse.collections.api.RichIterable

aggregateBy, containsBy, countBy, countBy, countByEach, countByEach, countByWith, countByWith, flatCollectWith, getAny, groupByAndCollect, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, makeString, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, reduce, reduceInPlace, reduceInPlace, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, toImmutableBiMap, toImmutableMap

Constructor Details

SynchronizedLongObjectMap

public SynchronizedLongObjectMap(MutableLongObjectMap<V> map)

SynchronizedLongObjectMap

public SynchronizedLongObjectMap(MutableLongObjectMap<V> map,
 Object newLock)

Method Details

put

public V put(long key,
 V value)

Description copied from interface: MutableLongObjectMap

Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.

Specified by:

put in interface MutableLongObjectMap<V>

Parameters:

key - the key

value - the value to associate with value

Returns:

the value previously associated with key if one existed, or null if not

putPair

public V putPair(LongObjectPair<V> keyValuePair)

Description copied from interface: MutableLongObjectMap

This method allows MutableLongObjectMap the ability to add an element in the form of LongObjectPair<V>.

Specified by:

putPair in interface MutableLongObjectMap<V>

See Also:

• MutableLongObjectMap.put(long, Object)

putAll

public void putAll(LongObjectMap<? extends V> map)

Description copied from interface: MutableLongObjectMap

Puts all of the key/value mappings from the specified map into this map. If this map already has a value associated with one of the keys in the map, it will be replaced with the value in map.

Specified by:

putAll in interface MutableLongObjectMap<V>

Parameters:

map - the map to copy into this map

removeKey

public V removeKey(long key)

Description copied from interface: MutableLongObjectMap

Removes the mapping associated with the key, if one exists, from the map.

Specified by:

removeKey in interface MutableLongObjectMap<V>

Parameters:

key - the key to remove

See Also:

• MutableLongObjectMap.remove(long)

remove

public V remove(long key)

Description copied from interface: MutableLongObjectMap

Removes the mapping associated with the key, if one exists, from the map.

Specified by:

remove in interface MutableLongObjectMap<V>

Parameters:

key - the key to remove

See Also:

• MutableLongObjectMap.removeKey(long)

getIfAbsentPut

public V getIfAbsentPut(long key,
 V value)

Description copied from interface: MutableLongObjectMap

Retrieves the value associated with the key if one exists; if it does not, associates a value with the key.

Specified by:

getIfAbsentPut in interface MutableLongObjectMap<V>

Parameters:

key - the key

value - the value to associate with key if no such mapping exists

Returns:

the value associated with key, if one exists, or value if not

getIfAbsentPut

public V getIfAbsentPut(long key,
 Function0<? extends V> function)

Description copied from interface: MutableLongObjectMap

Retrieves the value associated with the key if one exists; if it does not, invokes the supplier and associates the result with the key.

Specified by:

getIfAbsentPut in interface MutableLongObjectMap<V>

Parameters:

key - the key

function - the supplier that provides the value if no mapping exists for key

Returns:

the value associated with the key, if one exists, or the result of invoking function if not

getIfAbsentPutWithKey

public V getIfAbsentPutWithKey(long key,
 LongToObjectFunction<? extends V> function)

Description copied from interface: MutableLongObjectMap

Retrieves the value associated with the key if one exists; if it does not, associates the result of invoking the value function with the key.

Specified by:

getIfAbsentPutWithKey in interface MutableLongObjectMap<V>

Parameters:

key - the key

function - the function that provides the value if no mapping exists. The key will be passed as the argument to the function.

Returns:

the value associated with the key, if one exists, or the result of invoking function with key if not

getIfAbsentPutWith

public <P> V getIfAbsentPutWith(long key,
 Function<? super P,? extends V> function,
 P parameter)

Description copied from interface: MutableLongObjectMap

Retrieves the value associated with the key if one exists; if it does not, invokes the value function with the parameter and associates the result with the key.

Specified by:

getIfAbsentPutWith in interface MutableLongObjectMap<V>

Type Parameters:

P - the type of the value function's parameter

Parameters:

key - the key

function - the function that provides the value if no mapping exists. The specified parameter will be passed as the argument to the function.

parameter - the parameter to provide to function if no value exists for key

Returns:

the value associated with the key, if one exists, or the result of invoking function with parameter if not

updateValue

public V updateValue(long key,
 Function0<? extends V> factory,
 Function<? super V,? extends V> function)

Description copied from interface: MutableLongObjectMap

Look up the value associated with key, apply the function to it, and replace the value. If there is no value associated with key, start it off with a value supplied by factory.

Specified by:

updateValue in interface MutableLongObjectMap<V>

updateValueWith

public <P> V updateValueWith(long key,
 Function0<? extends V> factory,
 Function2<? super V,? super P,? extends V> function,
 P parameter)

Description copied from interface: MutableLongObjectMap

Updates or sets the value associated with the key by applying the function to the existing value, if one exists, or the initial value supplied by the factory if one does not.

Specified by:

updateValueWith in interface MutableLongObjectMap<V>

Type Parameters:

P - the type of the value function's parameter

Parameters:

key - the key

factory - the supplier providing the initial value to the function if no mapping exists for the key

function - the function that returns the updated value based on the current value or the initial value, if no value exists. The specified parameter will also be passed as the second argument to the function.

parameter - the parameter to provide to function if no value exists for key

Returns:

the new value associated with the key, either as a result of applying function to the value already associated with the key or as a result of applying it to the value returned by factory and associating the result with key

get

public V get(long key)

Description copied from interface: LongObjectMap

Retrieves the value associated with the key. If no mapping exists for the key, null is returned.

Specified by:

get in interface LongObjectMap<V>

Parameters:

key - the key

Returns:

the value associated with the key, or the default value if no such mapping exists

getIfAbsent

public V getIfAbsent(long key,
 Function0<? extends V> ifAbsent)

Description copied from interface: LongObjectMap

Retrieves the value associated with the key if one exists; if it does not, returns the result of invoking the value supplier.

Specified by:

getIfAbsent in interface LongObjectMap<V>

Parameters:

key - the key

Returns:

the value associated with the key, if one exists, or the result of invoking ifAbsent if not

containsKey

public boolean containsKey(long key)

Description copied from interface: LongObjectMap

Returns whether or not the key is present in the map.

Specified by:

containsKey in interface LongObjectMap<V>

Parameters:

key - the key

Returns:

if a mapping exists in this map for the key

containsValue

public boolean containsValue(Object value)

Specified by:

containsValue in interface PrimitiveObjectMap<V>

tap

public MutableLongObjectMap<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()));
 

Example using an anonymous inner class:

 RichIterable<Person> tapped =
     people.tap(new Procedure<Person>()
     {
         public void value(Person person)
         {
             LOGGER.info(person.getName());
         }
     });
 

Specified by:

tap in interface LongObjectMap<V>

Specified by:

tap in interface MutableLongObjectMap<V>

Specified by:

tap in interface RichIterable<V>

See Also:

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

forEachValue

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

Specified by:

forEachValue in interface PrimitiveObjectMap<V>

forEachKey

public void forEachKey(LongProcedure procedure)

Description copied from interface: LongObjectMap

Iterates through each key in the map, invoking the procedure for each.

Specified by:

forEachKey in interface LongObjectMap<V>

Parameters:

procedure - the procedure to invoke for each key

forEachKeyValue

public void forEachKeyValue(LongObjectProcedure<? super V> procedure)

Description copied from interface: LongObjectMap

Iterates through each key/value pair in the map, invoking the procedure for each.

Specified by:

forEachKeyValue in interface LongObjectMap<V>

Parameters:

procedure - the procedure to invoke for each key/value pair

select

public MutableLongObjectMap<V> select(LongObjectPredicate<? super V> predicate)

Description copied from interface: LongObjectMap

Return a copy of this map containing only the key/value pairs that match the predicate.

Specified by:

select in interface LongObjectMap<V>

Specified by:

select in interface MutableLongObjectMap<V>

Parameters:

predicate - the predicate to determine which key/value pairs in this map should be included in the returned map

Returns:

a copy of this map with the matching key/value pairs

reject

public MutableLongObjectMap<V> reject(LongObjectPredicate<? super V> predicate)

Description copied from interface: LongObjectMap

Return a copy of this map containing only the key/value pairs that do not match the predicate.

Specified by:

reject in interface LongObjectMap<V>

Specified by:

reject in interface MutableLongObjectMap<V>

Parameters:

predicate - the predicate to determine which key/value pairs in this map should be excluded from the returned map

Returns:

a copy of this map without the matching key/value pairs

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface RichIterable<V>

isEmpty

public boolean isEmpty()

Description copied from interface: RichIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface RichIterable<V>

notEmpty

public boolean notEmpty()

Description copied from interface: RichIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface RichIterable<V>

getFirst

public V getFirst()

Description copied from interface: RichIterable

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

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

Specified by:

getFirst in interface RichIterable<V>

getLast

public V getLast()

Description copied from interface: RichIterable

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

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

Specified by:

getLast in interface RichIterable<V>

getOnly

public V getOnly()

Description copied from interface: RichIterable

Returns the element if the iterable has exactly one element. Otherwise, throw IllegalStateException.

Specified by:

getOnly in interface RichIterable<V>

Returns:

an element of an iterable.

contains

public boolean contains(Object object)

Description copied from interface: RichIterable

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

Specified by:

contains in interface RichIterable<V>

containsAllIterable

public boolean containsAllIterable(Iterable<?> source)

Description copied from interface: RichIterable

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

Specified by:

containsAllIterable in interface RichIterable<V>

containsAll

public boolean containsAll(Collection<?> source)

Description copied from interface: RichIterable

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

Specified by:

containsAll in interface RichIterable<V>

See Also:

• Collection.containsAll(Collection)

containsNoneIterable

public boolean containsNoneIterable(Iterable<?> source)

Description copied from interface: RichIterable

Returns true if none of the elements in source are contained in this collection.

Specified by:

containsNoneIterable in interface RichIterable<V>

containsNone

public boolean containsNone(Collection<?> source)

Description copied from interface: RichIterable

Returns true if none of the elements in source are contained in this collection.

Specified by:

containsNone in interface RichIterable<V>

containsAnyIterable

public boolean containsAnyIterable(Iterable<?> source)

Description copied from interface: RichIterable

Returns true if any of the elements in source is contained in this collection.

Specified by:

containsAnyIterable in interface RichIterable<V>

containsAny

public boolean containsAny(Collection<?> source)

Description copied from interface: RichIterable

Returns true if any of the elements in source is contained in this collection.

Specified by:

containsAny in interface RichIterable<V>

containsAllArguments

public boolean containsAllArguments(Object... elements)

Description copied from interface: RichIterable

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

Specified by:

containsAllArguments in interface RichIterable<V>

select

public MutableBag<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"));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getCity().equals("London");
         }
     });
 

Specified by:

select in interface MutablePrimitiveObjectMap<V>

Specified by:

select in interface PrimitiveObjectMap<V>

Specified by:

select in interface RichIterable<V>

select

public <R extends Collection<V>> R select(Predicate<? super V> predicate,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 MutableList<Person> selected =
     people.select(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> selected =
     people.select(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
 

Specified by:

select in interface RichIterable<V>

Parameters:

predicate - a Predicate to use as the select criteria

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

Returns:

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

See Also:

• RichIterable.select(Predicate)

selectWith

public <P> MutableBag<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));
 

Example using an anonymous inner class:

 RichIterable<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge()>= age;
         }
     }, Integer.valueOf(18));
 

Specified by:

selectWith in interface MutablePrimitiveObjectMap<V>

Specified by:

selectWith in interface PrimitiveObjectMap<V>

Specified by:

selectWith in interface RichIterable<V>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

• RichIterable.select(Predicate)

selectWith

public <P,
R extends Collection<V>> R selectWith(Predicate2<? super V,? super P> predicate,
 P parameter,
 R targetCollection)

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

 MutableList<Person> selected =
     people.selectWith((Person person, Integer age) -> person.getAge()>= age, Integer.valueOf(18), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> selected =
     people.selectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge()>= age;
         }
     }, Integer.valueOf(18), Lists.mutable.empty());
 

Specified by:

selectWith in interface RichIterable<V>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

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

Returns:

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

See Also:

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

partition

public PartitionMutableBag<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"));
 

Example using an anonymous inner class:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partition(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.getAddress().getState().getName().equals("New York");
         }
     });
 

Specified by:

partition in interface MutablePrimitiveObjectMap<V>

Specified by:

partition in interface PrimitiveObjectMap<V>

Specified by:

partition in interface RichIterable<V>

partitionWith

public <P> PartitionMutableBag<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");
 

Example using an anonymous inner class:

 PartitionIterable<Person> newYorkersAndNonNewYorkers =
     people.partitionWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String state)
         {
             return person.getAddress().getState().getName().equals(state);
         }
     }, "New York");
 

Specified by:

partitionWith in interface MutablePrimitiveObjectMap<V>

Specified by:

partitionWith in interface PrimitiveObjectMap<V>

Specified by:

partitionWith in interface RichIterable<V>

selectInstancesOf

public <S> MutableBag<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 MutablePrimitiveObjectMap<V>

Specified by:

selectInstancesOf in interface PrimitiveObjectMap<V>

Specified by:

selectInstancesOf in interface RichIterable<V>

zipWithIndex

@Deprecated
public MutableSet<Pair<V,Integer>> zipWithIndex()

Deprecated.

in 7.0. Use OrderedIterable.zipWithIndex() instead.

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface MutablePrimitiveObjectMap<V>

Specified by:

zipWithIndex in interface PrimitiveObjectMap<V>

Specified by:

zipWithIndex in interface RichIterable<V>

Returns:

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

See Also:

• RichIterable.zip(Iterable)

zipWithIndex

public <R extends Collection<Pair<V,
Integer>>> R zipWithIndex(R target)

Description copied from interface: RichIterable

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

Specified by:

zipWithIndex in interface RichIterable<V>

chunk

public RichIterable<RichIterable<V>> chunk(int size)

Description copied from interface: RichIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface RichIterable<V>

Parameters:

size - the number of elements per chunk

Returns:

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

aggregateInPlaceBy

public <K,
VV> MutableMap<K,VV> aggregateInPlaceBy(Function<? super V,? extends K> 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 MutablePrimitiveObjectMap<V>

Specified by:

aggregateInPlaceBy in interface RichIterable<V>

aggregateBy

public <K,
VV> MutableMap<K,VV> aggregateBy(Function<? super V,? extends K> 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 MutablePrimitiveObjectMap<V>

Specified by:

aggregateBy in interface RichIterable<V>

reject

public MutableBag<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"));
 

Example using an anonymous inner class:

 RichIterable<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     });
 

Specified by:

reject in interface MutablePrimitiveObjectMap<V>

Specified by:

reject in interface PrimitiveObjectMap<V>

Specified by:

reject in interface RichIterable<V>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

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

reject

public <R extends Collection<V>> R reject(Predicate<? super V> predicate,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 MutableList<Person> rejected =
     people.reject(person -> person.person.getLastName().equals("Smith"), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.reject(new Predicate<Person>()
     {
         public boolean accept(Person person)
         {
             return person.person.getLastName().equals("Smith");
         }
     }, Lists.mutable.empty());
 

Specified by:

reject in interface RichIterable<V>

Parameters:

predicate - a Predicate to use as the reject criteria

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

Returns:

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

rejectWith

public <P> MutableBag<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));
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18));
 

Specified by:

rejectWith in interface MutablePrimitiveObjectMap<V>

Specified by:

rejectWith in interface PrimitiveObjectMap<V>

Specified by:

rejectWith in interface RichIterable<V>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

• RichIterable.select(Predicate)

rejectWith

public <P,
R extends Collection<V>> R rejectWith(Predicate2<? super V,? super P> predicate,
 P parameter,
 R targetCollection)

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

 MutableList<Person> rejected =
     people.rejectWith((Person person, Integer age) -> person.getAge() < age, Integer.valueOf(18), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<Person> rejected =
     people.rejectWith(new Predicate2<Person, Integer>()
     {
         public boolean accept(Person person, Integer age)
         {
             return person.getAge() < age;
         }
     }, Integer.valueOf(18), Lists.mutable.empty());
 

Specified by:

rejectWith in interface RichIterable<V>

Parameters:

predicate - a Predicate2 to use as the reject criteria

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

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

Returns:

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

See Also:

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

clear

public void clear()

Specified by:

clear in interface MutablePrimitiveObjectMap<V>

collect

public <VV> MutableBag<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());
 

Example using an anonymous inner class:

 RichIterable<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     });
 

Specified by:

collect in interface MutablePrimitiveObjectMap<V>

Specified by:

collect in interface PrimitiveObjectMap<V>

Specified by:

collect in interface RichIterable<V>

collectBoolean

public MutableBooleanBag 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());
 

Example using an anonymous inner class:

 BooleanIterable licenses =
     people.collectBoolean(new BooleanFunction<Person>()
     {
         public boolean booleanValueOf(Person person)
         {
             return person.hasDrivingLicense();
         }
     });
 

Specified by:

collectBoolean in interface MutablePrimitiveObjectMap<V>

Specified by:

collectBoolean in interface PrimitiveObjectMap<V>

Specified by:

collectBoolean in interface RichIterable<V>

collectBoolean

public <R extends MutableBooleanCollection> R collectBoolean(BooleanFunction<? super V> booleanFunction,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 BooleanArrayList licenses =
     people.collectBoolean(person -> person.hasDrivingLicense(), new BooleanArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectBoolean in interface RichIterable<V>

Parameters:

booleanFunction - a BooleanFunction to use as the collect transformation function

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

Returns:

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

collectByte

public MutableByteBag 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());
 

Example using an anonymous inner class:

 ByteIterable bytes =
     people.collectByte(new ByteFunction<Person>()
     {
         public byte byteValueOf(Person person)
         {
             return person.getCode();
         }
     });
 

Specified by:

collectByte in interface MutablePrimitiveObjectMap<V>

Specified by:

collectByte in interface PrimitiveObjectMap<V>

Specified by:

collectByte in interface RichIterable<V>

collectByte

public <R extends MutableByteCollection> R collectByte(ByteFunction<? super V> byteFunction,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 ByteArrayList bytes =
     people.collectByte(person -> person.getCode(), new ByteArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectByte in interface RichIterable<V>

Parameters:

byteFunction - a ByteFunction to use as the collect transformation function

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

Returns:

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

collectChar

public MutableCharBag 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());
 

Example using an anonymous inner class:

 CharIterable chars =
     people.collectChar(new CharFunction<Person>()
     {
         public char charValueOf(Person person)
         {
             return person.getMiddleInitial();
         }
     });
 

Specified by:

collectChar in interface MutablePrimitiveObjectMap<V>

Specified by:

collectChar in interface PrimitiveObjectMap<V>

Specified by:

collectChar in interface RichIterable<V>

collectChar

public <R extends MutableCharCollection> R collectChar(CharFunction<? super V> charFunction,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 CharArrayList chars =
     people.collectChar(person -> person.getMiddleInitial(), new CharArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectChar in interface RichIterable<V>

Parameters:

charFunction - a CharFunction to use as the collect transformation function

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

Returns:

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

collectDouble

public MutableDoubleBag 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());
 

Example using an anonymous inner class:

 DoubleIterable doubles =
     people.collectDouble(new DoubleFunction<Person>()
     {
         public double doubleValueOf(Person person)
         {
             return person.getMilesFromNorthPole();
         }
     });
 

Specified by:

collectDouble in interface MutablePrimitiveObjectMap<V>

Specified by:

collectDouble in interface PrimitiveObjectMap<V>

Specified by:

collectDouble in interface RichIterable<V>

collectDouble

public <R extends MutableDoubleCollection> R collectDouble(DoubleFunction<? super V> doubleFunction,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 DoubleArrayList doubles =
     people.collectDouble(person -> person.getMilesFromNorthPole(), new DoubleArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectDouble in interface RichIterable<V>

Parameters:

doubleFunction - a DoubleFunction to use as the collect transformation function

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

Returns:

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

collectFloat

public MutableFloatBag 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());
 

Example using an anonymous inner class:

 FloatIterable floats =
     people.collectFloat(new FloatFunction<Person>()
     {
         public float floatValueOf(Person person)
         {
             return person.getHeightInInches();
         }
     });
 

Specified by:

collectFloat in interface MutablePrimitiveObjectMap<V>

Specified by:

collectFloat in interface PrimitiveObjectMap<V>

Specified by:

collectFloat in interface RichIterable<V>

collectFloat

public <R extends MutableFloatCollection> R collectFloat(FloatFunction<? super V> floatFunction,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 FloatArrayList floats =
     people.collectFloat(person -> person.getHeightInInches(), new FloatArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectFloat in interface RichIterable<V>

Parameters:

floatFunction - a FloatFunction to use as the collect transformation function

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

Returns:

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

collectInt

public MutableIntBag 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());
 

Example using an anonymous inner class:

 IntIterable ints =
     people.collectInt(new IntFunction<Person>()
     {
         public int intValueOf(Person person)
         {
             return person.getAge();
         }
     });
 

Specified by:

collectInt in interface MutablePrimitiveObjectMap<V>

Specified by:

collectInt in interface PrimitiveObjectMap<V>

Specified by:

collectInt in interface RichIterable<V>

collectInt

public <R extends MutableIntCollection> R collectInt(IntFunction<? super V> intFunction,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 IntArrayList ints =
     people.collectInt(person -> person.getAge(), new IntArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectInt in interface RichIterable<V>

Parameters:

intFunction - a IntFunction to use as the collect transformation function

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

Returns:

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

collectLong

public MutableLongBag 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());
 

Example using an anonymous inner class:

 LongIterable longs =
     people.collectLong(new LongFunction<Person>()
     {
         public long longValueOf(Person person)
         {
             return person.getGuid();
         }
     });
 

Specified by:

collectLong in interface MutablePrimitiveObjectMap<V>

Specified by:

collectLong in interface PrimitiveObjectMap<V>

Specified by:

collectLong in interface RichIterable<V>

collectLong

public <R extends MutableLongCollection> R collectLong(LongFunction<? super V> longFunction,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 LongArrayList longs =
     people.collectLong(person -> person.getGuid(), new LongArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectLong in interface RichIterable<V>

Parameters:

longFunction - a LongFunction to use as the collect transformation function

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

Returns:

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

collectShort

public MutableShortBag 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());
 

Example using an anonymous inner class:

 ShortIterable shorts =
     people.collectShort(new ShortFunction<Person>()
     {
         public short shortValueOf(Person person)
         {
             return person.getNumberOfJunkMailItemsReceivedPerMonth();
         }
     });
 

Specified by:

collectShort in interface MutablePrimitiveObjectMap<V>

Specified by:

collectShort in interface PrimitiveObjectMap<V>

Specified by:

collectShort in interface RichIterable<V>

collectShort

public <R extends MutableShortCollection> R collectShort(ShortFunction<? super V> shortFunction,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 ShortArrayList shorts =
     people.collectShort(person -> person.getNumberOfJunkMailItemsReceivedPerMonth, new ShortArrayList());
 

Example using an anonymous inner class:

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

Specified by:

collectShort in interface RichIterable<V>

Parameters:

shortFunction - a ShortFunction to use as the collect transformation function

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

Returns:

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

collectWith

public <P,
VV> MutableBag<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));
 

Example using an anonymous inner class:

 Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(Integer each, Integer parameter)
         {
             return each + parameter;
         }
     };
 RichIterable<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1));
 

Specified by:

collectWith in interface MutablePrimitiveObjectMap<V>

Specified by:

collectWith in interface PrimitiveObjectMap<V>

Specified by:

collectWith in interface RichIterable<V>

Parameters:

function - A Function2 to use as the collect transformation function

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

Returns:

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

See Also:

• RichIterable.collect(Function)

collectWith

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Example using an anonymous inner class:

 Function2<Integer, Integer, Integer> addParameterFunction =
     new Function2<Integer, Integer, Integer>()
     {
         public Integer value(final Integer each, final Integer parameter)
         {
             return each + parameter;
         }
     };
 MutableSet<Integer> integers =
     Lists.mutable.with(1, 2, 3).collectWith(addParameterFunction, Integer.valueOf(1), Sets.mutable.empty());
 

Specified by:

collectWith in interface RichIterable<V>

Parameters:

function - a Function2 to use as the collect transformation function

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

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

Returns:

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

collect

public <VV,
R extends Collection<VV>> R collect(Function<? super V,? extends VV> function,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 MutableList<String> names =
     people.collect(person -> person.getFirstName() + " " + person.getLastName(), Lists.mutable.empty());
 

Example using an anonymous inner class:

 MutableList<String> names =
     people.collect(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getFirstName() + " " + person.getLastName();
         }
     }, Lists.mutable.empty());
 

Specified by:

collect in interface RichIterable<V>

Parameters:

function - a Function to use as the collect transformation function

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

Returns:

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

See Also:

• RichIterable.collect(Function)

collectIf

public <VV> MutableBag<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 MutablePrimitiveObjectMap<V>

Specified by:

collectIf in interface PrimitiveObjectMap<V>

Specified by:

collectIf in interface RichIterable<V>

collectIf

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

Description copied from interface: RichIterable

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

Specified by:

collectIf in interface RichIterable<V>

Parameters:

predicate - a Predicate to use as the select criteria

function - a Function to use as the collect transformation function

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

Returns:

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

See Also:

• RichIterable.collectIf(Predicate, Function)

flatCollect

public <VV> MutableBag<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 MutablePrimitiveObjectMap<V>

Specified by:

flatCollect in interface PrimitiveObjectMap<V>

Specified by:

flatCollect in interface RichIterable<V>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

flatCollect

public <VV,
R extends Collection<VV>> R flatCollect(Function<? super V,? extends Iterable<VV>> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollect in interface RichIterable<V>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

• RichIterable.flatCollect(Function)

flatCollectByte

public <R extends MutableByteCollection> R flatCollectByte(Function<? super V,? extends ByteIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectByte in interface RichIterable<V>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

• RichIterable.flatCollect(Function)

flatCollectChar

public <R extends MutableCharCollection> R flatCollectChar(Function<? super V,? extends CharIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectChar in interface RichIterable<V>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

• RichIterable.flatCollect(Function)

flatCollectInt

public <R extends MutableIntCollection> R flatCollectInt(Function<? super V,? extends IntIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectInt in interface RichIterable<V>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

• RichIterable.flatCollect(Function)

flatCollectShort

public <R extends MutableShortCollection> R flatCollectShort(Function<? super V,? extends ShortIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectShort in interface RichIterable<V>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

• RichIterable.flatCollect(Function)

flatCollectDouble

public <R extends MutableDoubleCollection> R flatCollectDouble(Function<? super V,? extends DoubleIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectDouble in interface RichIterable<V>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

• RichIterable.flatCollect(Function)

flatCollectFloat

public <R extends MutableFloatCollection> R flatCollectFloat(Function<? super V,? extends FloatIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectFloat in interface RichIterable<V>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

• RichIterable.flatCollect(Function)

flatCollectLong

public <R extends MutableLongCollection> R flatCollectLong(Function<? super V,? extends LongIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectLong in interface RichIterable<V>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

• RichIterable.flatCollect(Function)

flatCollectBoolean

public <R extends MutableBooleanCollection> R flatCollectBoolean(Function<? super V,? extends BooleanIterable> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

flatCollectBoolean in interface RichIterable<V>

Parameters:

function - The Function to apply

target - The collection into which results should be added.

Returns:

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

See Also:

• RichIterable.flatCollect(Function)

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"));
 

Example using an anonymous inner class:

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

Specified by:

detect in interface RichIterable<V>

detectWith

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

Description copied from interface: RichIterable

Returns the first element that evaluates to true for the specified predicate2 and parameter, or null if none evaluate to true.

Example using a Java 8 lambda expression:

 Person person =
     people.detectWith((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Example using an anonymous inner class:

 Person person =
     people.detectWith(new Predicate2<Person, String>()
     {
         public boolean accept(Person person, String fullName)
         {
             return person.getFullName().equals(fullName);
         }
     }, "John Smith");
 

Specified by:

detectWith in interface RichIterable<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<V>

detectWithOptional

public <P> Optional<V> detectWithOptional(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.

Example using a Java 8 lambda expression:

 Optional<Person> person =
     people.detectWithOptional((person, fullName) -> person.getFullName().equals(fullName), "John Smith");
 

Specified by:

detectWithOptional in interface RichIterable<V>

detectIfNone

public V detectIfNone(Predicate<? super V> predicate,
 Function0<? extends V> function)

Description copied from interface: RichIterable

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

Specified by:

detectIfNone in interface RichIterable<V>

detectWithIfNone

public <P> V detectWithIfNone(Predicate2<? super V,? super P> predicate,
 P parameter,
 Function0<? extends V> function)

Description copied from interface: RichIterable

Returns the first element of the iterable that evaluates to true for the specified predicate2 and parameter, or returns the value of evaluating the specified function.

Specified by:

detectWithIfNone in interface RichIterable<V>

count

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

 int count =
     people.count(person -> person.getAddress().getState().getName().equals("New York"));
 

Example using an anonymous inner class:

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

Specified by:

count in interface RichIterable<V>

countWith

public <P> int countWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

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

Specified by:

countWith in interface RichIterable<V>

anySatisfy

public boolean anySatisfy(Predicate<? super V> predicate)

Description copied from interface: RichIterable

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

Specified by:

anySatisfy in interface RichIterable<V>

anySatisfyWith

public <P> boolean anySatisfyWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

Specified by:

anySatisfyWith in interface RichIterable<V>

allSatisfy

public boolean allSatisfy(Predicate<? super V> predicate)

Description copied from interface: RichIterable

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

Specified by:

allSatisfy in interface RichIterable<V>

allSatisfyWith

public <P> boolean allSatisfyWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

Specified by:

allSatisfyWith in interface RichIterable<V>

noneSatisfy

public boolean noneSatisfy(Predicate<? super V> predicate)

Description copied from interface: RichIterable

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

Specified by:

noneSatisfy in interface RichIterable<V>

noneSatisfyWith

public <P> boolean noneSatisfyWith(Predicate2<? super V,? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

Specified by:

noneSatisfyWith in interface RichIterable<V>

injectInto

public <IV> IV injectInto(IV injectedValue,
 Function2<? super IV,? super V,? extends IV> function)

Description copied from interface: RichIterable

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

Specified by:

injectInto in interface RichIterable<V>

injectInto

public int injectInto(int injectedValue,
 IntObjectToIntFunction<? super V> function)

Description copied from interface: RichIterable

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

Specified by:

injectInto in interface RichIterable<V>

injectInto

public long injectInto(long injectedValue,
 LongObjectToLongFunction<? super V> function)

Description copied from interface: RichIterable

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

Specified by:

injectInto in interface RichIterable<V>

injectInto

public float injectInto(float injectedValue,
 FloatObjectToFloatFunction<? super V> function)

Description copied from interface: RichIterable

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

Specified by:

injectInto in interface RichIterable<V>

injectInto

public double injectInto(double injectedValue,
 DoubleObjectToDoubleFunction<? super V> function)

Description copied from interface: RichIterable

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

Specified by:

injectInto in interface RichIterable<V>

into

public <R extends Collection<V>> R into(R target)

Description copied from interface: RichIterable

Adds all the elements in this iterable to the specific target Collection.

Specified by:

into in interface RichIterable<V>

toList

public MutableList<V> toList()

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation.

Specified by:

toList in interface RichIterable<V>

toSortedList

public MutableList<V> toSortedList()

Description copied from interface: RichIterable

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

Specified by:

toSortedList in interface RichIterable<V>

toSortedList

public MutableList<V> toSortedList(Comparator<? super V> comparator)

Description copied from interface: RichIterable

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

Specified by:

toSortedList in interface RichIterable<V>

toSortedListBy

public <VV extends Comparable<? super VV>>
MutableList<V> toSortedListBy(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

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

Specified by:

toSortedListBy in interface RichIterable<V>

toSet

public MutableSet<V> toSet()

Description copied from interface: RichIterable

Converts the collection to a MutableSet implementation.

Specified by:

toSet in interface RichIterable<V>

toSortedSet

public MutableSortedSet<V> toSortedSet()

Description copied from interface: RichIterable

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

Specified by:

toSortedSet in interface RichIterable<V>

toSortedSet

public MutableSortedSet<V> toSortedSet(Comparator<? super V> comparator)

Description copied from interface: RichIterable

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

Specified by:

toSortedSet in interface RichIterable<V>

toSortedSetBy

public <VV extends Comparable<? super VV>>
MutableSortedSet<V> toSortedSetBy(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

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

Specified by:

toSortedSetBy in interface RichIterable<V>

toBag

public MutableBag<V> toBag()

Description copied from interface: RichIterable

Converts the collection to the default MutableBag implementation.

Specified by:

toBag in interface RichIterable<V>

toSortedBag

public MutableSortedBag<V> toSortedBag()

Description copied from interface: RichIterable

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

Specified by:

toSortedBag in interface RichIterable<V>

toSortedBag

public MutableSortedBag<V> toSortedBag(Comparator<? super V> comparator)

Description copied from interface: RichIterable

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

Specified by:

toSortedBag in interface RichIterable<V>

toSortedBagBy

public <VV extends Comparable<? super VV>>
MutableSortedBag<V> toSortedBagBy(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

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

Specified by:

toSortedBagBy in interface RichIterable<V>

toMap

public <NK,
NV> MutableMap<NK,NV> toMap(Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction)

Description copied from interface: RichIterable

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

Specified by:

toMap in interface RichIterable<V>

toMap

public <NK,
NV,
R extends Map<NK,
NV>> R toMap(Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction,
 R target)

Description copied from interface: RichIterable

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

Specified by:

toMap in interface RichIterable<V>

toSortedMap

public <NK,
NV> MutableSortedMap<NK,NV> toSortedMap(Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction)

Description copied from interface: RichIterable

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

Specified by:

toSortedMap in interface RichIterable<V>

toSortedMap

public <NK,
NV> MutableSortedMap<NK,NV> toSortedMap(Comparator<? super NK> comparator,
 Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction)

Description copied from interface: RichIterable

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

Specified by:

toSortedMap in interface RichIterable<V>

toSortedMapBy

public <KK extends Comparable<? super KK>,
NK,
NV>
MutableSortedMap<NK,NV> toSortedMapBy(Function<? super NK,KK> sortBy,
 Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction)

Description copied from interface: RichIterable

Converts the collection to a MutableSortedMap implementation using the specified key and value functions and sorts it based on the natural order of the attribute returned by sortBy function.

Specified by:

toSortedMapBy in interface RichIterable<V>

toBiMap

public <NK,
NV> MutableBiMap<NK,NV> toBiMap(Function<? super V,? extends NK> keyFunction,
 Function<? super V,? extends NV> valueFunction)

Description copied from interface: RichIterable

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

Specified by:

toBiMap in interface RichIterable<V>

toImmutableList

public ImmutableList<V> toImmutableList()

Description copied from interface: RichIterable

Converts the RichIterable to the default ImmutableList implementation.

Specified by:

toImmutableList in interface RichIterable<V>

toImmutableSet

public ImmutableSet<V> toImmutableSet()

Description copied from interface: RichIterable

Converts the RichIterable to the default ImmutableSet implementation.

Specified by:

toImmutableSet in interface RichIterable<V>

toImmutableBag

public ImmutableBag<V> toImmutableBag()

Description copied from interface: RichIterable

Converts the RichIterable to the default ImmutableBag implementation.

Specified by:

toImmutableBag in interface RichIterable<V>

toImmutableSortedList

public ImmutableList<V> toImmutableSortedList()

Description copied from interface: RichIterable

Converts the RichIterable to the default sorted ImmutableList implementation.

Specified by:

toImmutableSortedList in interface RichIterable<V>

toImmutableSortedList

public ImmutableList<V> toImmutableSortedList(Comparator<? super V> comparator)

Description copied from interface: RichIterable

Converts the collection to an ImmutableList implementation and sorts it using the specified comparator.

Specified by:

toImmutableSortedList in interface RichIterable<V>

toImmutableSortedListBy

public <VV extends Comparable<? super VV>>
ImmutableList<V> toImmutableSortedListBy(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

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

Specified by:

toImmutableSortedListBy in interface RichIterable<V>

toImmutableSortedSet

public ImmutableSortedSet<V> toImmutableSortedSet()

Description copied from interface: RichIterable

Converts the RichIterable to the default ImmutableSortedSet implementation.

Specified by:

toImmutableSortedSet in interface RichIterable<V>

toImmutableSortedSet

public ImmutableSortedSet<V> toImmutableSortedSet(Comparator<? super V> comparator)

Description copied from interface: RichIterable

Converts the collection to an ImmutableSortedSet implementation and sorts it using the specified comparator.

Specified by:

toImmutableSortedSet in interface RichIterable<V>

toImmutableSortedSetBy

public <VV extends Comparable<? super VV>>
ImmutableSortedSet<V> toImmutableSortedSetBy(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

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

Specified by:

toImmutableSortedSetBy in interface RichIterable<V>

toImmutableSortedBag

public ImmutableSortedBag<V> toImmutableSortedBag()

Description copied from interface: RichIterable

Converts the RichIterable to the default ImmutableSortedBag implementation.

Specified by:

toImmutableSortedBag in interface RichIterable<V>

toImmutableSortedBag

public ImmutableSortedBag<V> toImmutableSortedBag(Comparator<? super V> comparator)

Description copied from interface: RichIterable

Converts the collection to an ImmutableSortedBag implementation and sorts it using the specified comparator.

Specified by:

toImmutableSortedBag in interface RichIterable<V>

toImmutableSortedBagBy

public <VV extends Comparable<? super VV>>
ImmutableSortedBag<V> toImmutableSortedBagBy(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

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

Specified by:

toImmutableSortedBagBy in interface RichIterable<V>

asLazy

public LazyIterable<V> asLazy()

Description copied from interface: RichIterable

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

Specified by:

asLazy in interface RichIterable<V>

toArray

public Object[] toArray()

Description copied from interface: RichIterable

Converts this iterable to an array.

Specified by:

toArray in interface RichIterable<V>

See Also:

• Collection.toArray()

toArray

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

Description copied from interface: RichIterable

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

Specified by:

toArray in interface RichIterable<V>

See Also:

• Collection.toArray(Object[])

min

public V min(Comparator<? super V> comparator)

Description copied from interface: RichIterable

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

Specified by:

min in interface RichIterable<V>

max

public V max(Comparator<? super V> comparator)

Description copied from interface: RichIterable

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

Specified by:

max in interface RichIterable<V>

min

public V min()

Description copied from interface: RichIterable

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

Specified by:

min in interface RichIterable<V>

max

public V max()

Description copied from interface: RichIterable

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

Specified by:

max in interface RichIterable<V>

maxBy

public <VV extends Comparable<? super VV>> V maxBy(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

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

Specified by:

maxBy in interface RichIterable<V>

minBy

public <VV extends Comparable<? super VV>> V minBy(Function<? super V,? extends VV> function)

Description copied from interface: RichIterable

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

Specified by:

minBy in interface RichIterable<V>

sumOfInt

public long sumOfInt(IntFunction<? super V> function)

Description copied from interface: RichIterable

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

Specified by:

sumOfInt in interface RichIterable<V>

sumOfFloat

public double sumOfFloat(FloatFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.

Specified by:

sumOfFloat in interface RichIterable<V>

sumOfLong

public long sumOfLong(LongFunction<? super V> function)

Description copied from interface: RichIterable

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

Specified by:

sumOfLong in interface RichIterable<V>

sumOfDouble

public double sumOfDouble(DoubleFunction<? super V> function)

Description copied from interface: RichIterable

Returns the final double result of evaluating function for each element of the iterable and adding the results together. It uses Kahan summation algorithm to reduce numerical error.

Specified by:

sumOfDouble in interface RichIterable<V>

sumByInt

public <V1> MutableObjectLongMap<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 MutablePrimitiveObjectMap<V>

Specified by:

sumByInt in interface RichIterable<V>

sumByFloat

public <V1> MutableObjectDoubleMap<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 MutablePrimitiveObjectMap<V>

Specified by:

sumByFloat in interface RichIterable<V>

sumByLong

public <V1> MutableObjectLongMap<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 MutablePrimitiveObjectMap<V>

Specified by:

sumByLong in interface RichIterable<V>

sumByDouble

public <V1> MutableObjectDoubleMap<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 MutablePrimitiveObjectMap<V>

Specified by:

sumByDouble in interface RichIterable<V>

keySet

public MutableLongSet keySet()

Description copied from interface: LongObjectMap

Returns a set containing all the keys in this map. The set is backed by the map, so any modifications to the returned set will affect this map.

Specified by:

keySet in interface LongObjectMap<V>

Returns:

a mutable set containing the keys in this map

values

public Collection<V> values()

Specified by:

values in interface PrimitiveObjectMap<V>

keysView

public LazyLongIterable keysView()

Description copied from interface: LongObjectMap

Returns a view of the keys in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the keys returned by the iterable.

Specified by:

keysView in interface LongObjectMap<V>

Returns:

a view of the keys in this map

keyValuesView

public RichIterable<LongObjectPair<V>> keyValuesView()

Description copied from interface: LongObjectMap

Returns a view of the key/value pairs in this map. This iterable is backed by the map, so any modifications to the underlying map will be reflected in the pairs returned by the iterable.

Specified by:

keyValuesView in interface LongObjectMap<V>

Returns:

a view of the keys in this map

flipUniqueValues

public MutableObjectLongMap<V> flipUniqueValues()

Description copied from interface: LongObjectMap

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

Specified by:

flipUniqueValues in interface LongObjectMap<V>

Specified by:

flipUniqueValues in interface MutableLongObjectMap<V>

equals

public boolean equals(Object obj)

Description copied from interface: PrimitiveObjectMap

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

Specified by:

equals in interface PrimitiveObjectMap<V>

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: PrimitiveObjectMap

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

Specified by:

hashCode in interface PrimitiveObjectMap<V>

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: PrimitiveObjectMap

Returns a string with the keys and values of this map separated by commas with spaces and enclosed in curly braces. Each key and value is separated by an equals sign.

 Assert.assertEquals(
     "{1=1, 2=2, 3=3}",
     IntObjectMaps.mutable.empty().withKeyValue(1, 1).withKeyValue(2, 2).withKeyValue(3, 3).toString());
 

Specified by:

toString in interface PrimitiveObjectMap<V>

Specified by:

toString in interface RichIterable<V>

Overrides:

toString in class Object

Returns:

a string representation of this PrimitiveObjectMap

See Also:

• AbstractMap.toString()

makeString

public String makeString()

Description copied from interface: RichIterable

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

Specified by:

makeString in interface RichIterable<V>

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: RichIterable

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

Specified by:

makeString in interface RichIterable<V>

Returns:

a string representation of this collection.

makeString

public String makeString(String start,
 String separator,
 String end)

Description copied from interface: RichIterable

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Specified by:

makeString in interface RichIterable<V>

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: RichIterable

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

Specified by:

appendString in interface RichIterable<V>

appendString

public void appendString(Appendable appendable,
 String separator)

Description copied from interface: RichIterable

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

Specified by:

appendString in interface RichIterable<V>

appendString

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

Description copied from interface: RichIterable

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

Specified by:

appendString in interface RichIterable<V>

groupBy

public <VV> MutableBagMultimap<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);
 

Example using an anonymous inner class:

 Multimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     });
 

Specified by:

groupBy in interface MutablePrimitiveObjectMap<V>

Specified by:

groupBy in interface PrimitiveObjectMap<V>

Specified by:

groupBy in interface RichIterable<V>

groupBy

public <VV,
R extends MutableMultimap<VV,
V>> R groupBy(Function<? super V,? extends VV> function,
 R target)

Description copied from interface: RichIterable

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

Example using a Java 8 method reference:

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

Example using an anonymous inner class:

 FastListMultimap<String, Person> peopleByLastName =
     people.groupBy(new Function<Person, String>()
     {
         public String valueOf(Person person)
         {
             return person.getLastName();
         }
     }, new FastListMultimap<String, Person>());
 

Specified by:

groupBy in interface RichIterable<V>

groupByEach

public <VV> MutableBagMultimap<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 MutablePrimitiveObjectMap<V>

Specified by:

groupByEach in interface PrimitiveObjectMap<V>

Specified by:

groupByEach in interface RichIterable<V>

groupByEach

public <VV,
R extends MutableMultimap<VV,
V>> R groupByEach(Function<? super V,? extends Iterable<VV>> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

groupByEach in interface RichIterable<V>

groupByUniqueKey

public <VV> MutableMap<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 MutablePrimitiveObjectMap<V>

Specified by:

groupByUniqueKey in interface PrimitiveObjectMap<V>

Specified by:

groupByUniqueKey in interface RichIterable<V>

See Also:

• RichIterable.groupBy(Function)

groupByUniqueKey

public <VV,
R extends MutableMapIterable<VV,
V>> R groupByUniqueKey(Function<? super V,? extends VV> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

groupByUniqueKey in interface RichIterable<V>

See Also:

• RichIterable.groupByUniqueKey(Function)

zip

@Deprecated
public <S> MutableBag<Pair<V,S>> zip(Iterable<S> that)

Deprecated.

in 7.0. Use OrderedIterable.zip(Iterable) instead.

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 MutablePrimitiveObjectMap<V>

Specified by:

zip in interface PrimitiveObjectMap<V>

Specified by:

zip in interface RichIterable<V>

Type Parameters:

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

Parameters:

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

Returns:

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

zip

public <S,
R extends Collection<Pair<V,
S>>> R zip(Iterable<S> that,
 R target)

Description copied from interface: RichIterable

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

Specified by:

zip in interface RichIterable<V>

withKeyValue

public MutableLongObjectMap<V> withKeyValue(long key,
 V value)

Description copied from interface: MutableLongObjectMap

Associates a value with the specified key. If a value is already associated with the key in this map, it will be replaced with value.

Specified by:

withKeyValue in interface MutableLongObjectMap<V>

Parameters:

key - the key

value - the value to associate with value

Returns:

this map

See Also:

• MutableLongObjectMap.put(long, V)

withoutKey

public MutableLongObjectMap<V> withoutKey(long key)

Description copied from interface: MutableLongObjectMap

Removes the mapping associated with the key, if one exists, from this map.

Specified by:

withoutKey in interface MutableLongObjectMap<V>

Parameters:

key - the key to remove

Returns:

this map

See Also:

• MutableLongObjectMap.remove(long)

withoutAllKeys

public MutableLongObjectMap<V> withoutAllKeys(LongIterable keys)

Description copied from interface: MutableLongObjectMap

Removes the mappings associated with all the keys, if they exist, from this map.

Specified by:

withoutAllKeys in interface MutableLongObjectMap<V>

Parameters:

keys - the keys to remove

Returns:

this map

See Also:

• MutableLongObjectMap.remove(long)

asUnmodifiable

public MutableLongObjectMap<V> asUnmodifiable()

Description copied from interface: MutableLongObjectMap

Returns an unmodifiable view of this map, delegating all read-only operations to this map and throwing an UnsupportedOperationException for all mutating operations. This avoids the overhead of copying the map when calling LongObjectMap.toImmutable() while still providing immutability.

Specified by:

asUnmodifiable in interface MutableLongObjectMap<V>

Returns:

an unmodifiable view of this map

asSynchronized

public MutableLongObjectMap<V> asSynchronized()

Description copied from interface: MutableLongObjectMap

Returns a synchronized view of this map, delegating all operations to this map but ensuring only one caller has access to the map at a time.

Specified by:

asSynchronized in interface MutableLongObjectMap<V>

Returns:

a synchronized view of this map

toImmutable

public ImmutableLongObjectMap<V> toImmutable()

Description copied from interface: LongObjectMap

Returns a copy of this map that is immutable (if this map is mutable) or itself if it is already immutable.

Specified by:

toImmutable in interface LongObjectMap<V>

Returns:

an immutable map that is equivalent to this one

forEach

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

Description copied from interface: InternalIterable

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda:

 people.forEach(Procedures.cast(person -> LOGGER.info(person.getName())));
 

Example using an anonymous inner class:

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

NOTE: This method started to conflict with Iterable.forEach(java.util.function.Consumer) since Java 1.8. It is recommended to use RichIterable.each(Procedure) instead to avoid casting to Procedure.

Specified by:

forEach in interface InternalIterable<V>

Specified by:

forEach in interface RichIterable<V>

See Also:

• RichIterable.each(Procedure)
• Iterable.forEach(java.util.function.Consumer)

each

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

Description copied from interface: RichIterable

The procedure is executed for each element in the iterable.

Example using a Java 8 lambda expression:

 people.each(person -> LOGGER.info(person.getName()));
 

Example using an anonymous inner class:

 people.each(new Procedure<Person>()
 {
     public void value(Person person)
     {
         LOGGER.info(person.getName());
     }
 });
 

This method is a variant of InternalIterable.forEach(Procedure) that has a signature conflict with Iterable.forEach(java.util.function.Consumer).

Specified by:

each in interface RichIterable<V>

See Also:

• InternalIterable.forEach(Procedure)
• Iterable.forEach(java.util.function.Consumer)

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

iterator

public Iterator<V> iterator()

Must be called in a synchronized block.

Specified by:

iterator in interface Iterable<V>