Class AbstractBiMap<K,V>
- java.lang.Object
-
- org.eclipse.collections.impl.bimap.AbstractBiMap<K,V>
-
- All Implemented Interfaces:
java.lang.Iterable<V>
,BiMap<K,V>
,InternalIterable<V>
,MapIterable<K,V>
,RichIterable<V>
- Direct Known Subclasses:
AbstractImmutableBiMap
,AbstractMutableBiMap
public abstract class AbstractBiMap<K,V> extends java.lang.Object implements BiMap<K,V>
-
-
Constructor Summary
Constructors Constructor Description AbstractBiMap()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods Modifier and Type Method Description 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(java.lang.Appendable appendable)
Prints a string representation of this collection onto the givenAppendable
.void
appendString(java.lang.Appendable appendable, java.lang.String separator)
Prints a string representation of this collection onto the givenAppendable
.void
appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end)
Prints a string representation of this collection onto the givenAppendable
.LazyIterable<V>
asLazy()
Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).RichIterable<RichIterable<V>>
chunk(int size)
Partitions elements in fixed size chunks.<VV,R extends java.util.Collection<VV>>
Rcollect(Function<? super V,? extends VV> function, R target)
Same asRichIterable.collect(Function)
, except that the results are gathered into the specifiedtarget
collection.<R extends MutableBooleanCollection>
RcollectBoolean(BooleanFunction<? super V> booleanFunction, R target)
Same asRichIterable.collectBoolean(BooleanFunction)
, except that the results are gathered into the specifiedtarget
collection.<R extends MutableByteCollection>
RcollectByte(ByteFunction<? super V> byteFunction, R target)
Same asRichIterable.collectByte(ByteFunction)
, except that the results are gathered into the specifiedtarget
collection.<R extends MutableCharCollection>
RcollectChar(CharFunction<? super V> charFunction, R target)
Same asRichIterable.collectChar(CharFunction)
, except that the results are gathered into the specifiedtarget
collection.<R extends MutableDoubleCollection>
RcollectDouble(DoubleFunction<? super V> doubleFunction, R target)
Same asRichIterable.collectDouble(DoubleFunction)
, except that the results are gathered into the specifiedtarget
collection.<R extends MutableFloatCollection>
RcollectFloat(FloatFunction<? super V> floatFunction, R target)
Same asRichIterable.collectFloat(FloatFunction)
, except that the results are gathered into the specifiedtarget
collection.<VV,R extends java.util.Collection<VV>>
RcollectIf(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.<R extends MutableIntCollection>
RcollectInt(IntFunction<? super V> intFunction, R target)
Same asRichIterable.collectInt(IntFunction)
, except that the results are gathered into the specifiedtarget
collection.<R extends MutableLongCollection>
RcollectLong(LongFunction<? super V> longFunction, R target)
Same asRichIterable.collectLong(LongFunction)
, except that the results are gathered into the specifiedtarget
collection.<R extends MutableShortCollection>
RcollectShort(ShortFunction<? super V> shortFunction, R target)
Same asRichIterable.collectShort(ShortFunction)
, except that the results are gathered into the specifiedtarget
collection.<P,VV,R extends java.util.Collection<VV>>
RcollectWith(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(java.lang.Object object)
Returns true if the iterable has an element which responds true to element.equals(object).boolean
containsAll(java.util.Collection<?> source)
Returns true if all elements in source are contained in this collection.boolean
containsAllArguments(java.lang.Object... elements)
Returns true if all elements in the specified var arg array are contained in this collection.boolean
containsAllIterable(java.lang.Iterable<?> source)
Returns true if all elements in source are contained in this collection.boolean
containsKey(java.lang.Object key)
boolean
containsValue(java.lang.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.Pair<K,V>
detect(Predicate2<? super K,? super V> predicate)
Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments.V
detectIfNone(Predicate<? super V> predicate, Function0<? extends V> function)
Returns the first element of the iterable for which the predicate evaluates to true.java.util.Optional<V>
detectOptional(Predicate<? super V> predicate)
Returns the first element of the iterable for which the predicate evaluates to true as an Optional.java.util.Optional<Pair<K,V>>
detectOptional(Predicate2<? super K,? super V> predicate)
Return the first key and value of the map as an Optional for which the predicate evaluates to true when they are given as arguments.<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> java.util.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(java.lang.Object obj)
Follows the same general contract asMap.equals(Object)
.<VV,R extends java.util.Collection<VV>>
RflatCollect(Function<? super V,? extends java.lang.Iterable<VV>> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableBooleanCollection>
RflatCollectBoolean(Function<? super V,? extends BooleanIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableByteCollection>
RflatCollectByte(Function<? super V,? extends ByteIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableCharCollection>
RflatCollectChar(Function<? super V,? extends CharIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableDoubleCollection>
RflatCollectDouble(Function<? super V,? extends DoubleIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableFloatCollection>
RflatCollectFloat(Function<? super V,? extends FloatIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableIntCollection>
RflatCollectInt(Function<? super V,? extends IntIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableLongCollection>
RflatCollectLong(Function<? super V,? extends LongIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.<R extends MutableShortCollection>
RflatCollectShort(Function<? super V,? extends ShortIterable> function, R target)
Same as flatCollect, only the results are collected into the target collection.void
forEachKey(Procedure<? super K> procedure)
Calls theprocedure
with each key of the map.void
forEachKeyValue(Procedure2<? super K,? super V> procedure)
Calls theprocedure
with each key-value pair of the map.void
forEachValue(Procedure<? super V> procedure)
Calls the procedure with each value of the map.<P> void
forEachWith(Procedure2<? super V,? super P> procedure, P parameter)
The procedure2 is evaluated for each element in the iterable with the specified parameter provided as the second argument.void
forEachWithIndex(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(java.lang.Object key)
protected abstract MapIterable<K,V>
getDelegate()
V
getFirst()
Returns the first element of an iterable.V
getIfAbsent(K key, Function0<? extends V> function)
Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified Function0.V
getIfAbsentValue(K key, V value)
Return the value in the Map that corresponds to the specified key, or if there is no value at the key, returnvalue
.<P> V
getIfAbsentWith(K key, Function<? super P,? extends V> function, P parameter)
Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified function and parameter.protected abstract MapIterable<V,K>
getInverse()
V
getLast()
Returns the last element of an iterable.V
getOnly()
Returns the element if the iterable has exactly one element.V
getOrDefault(java.lang.Object key, V defaultValue)
<VV,R extends MutableMultimap<VV,V>>
RgroupBy(Function<? super V,? extends VV> function, R target)
Same asRichIterable.groupBy(Function)
, except that the results are gathered into the specifiedtarget
multimap.<VV,R extends MutableMultimap<VV,V>>
RgroupByEach(Function<? super V,? extends java.lang.Iterable<VV>> function, R target)
Same asRichIterable.groupByEach(Function)
, except that the results are gathered into the specifiedtarget
multimap.<VV,R extends MutableMapIterable<VV,V>>
RgroupByUniqueKey(Function<? super V,? extends VV> function, R target)
Same asRichIterable.groupByUniqueKey(Function)
, except that the results are gathered into the specifiedtarget
map.int
hashCode()
Follows the same general contract asMap.hashCode()
.<A> A
ifPresentApply(K key, Function<? super V,? extends A> function)
If there is a value in the Map that corresponds to the specified key return the result of applying the specified Function on the value, otherwise return null.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 java.util.Collection<V>>
Rinto(R target)
Adds all the elements in this iterable to the specific target Collection.boolean
isEmpty()
Returns true if this iterable has zero items.RichIterable<K>
keysView()
Returns an unmodifiable lazy iterable wrapped around the keySet for the map.RichIterable<Pair<K,V>>
keyValuesView()
Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.java.lang.String
makeString()
Returns a string representation of this collection by delegating toRichIterable.makeString(String)
and defaulting the separator parameter to the characters", "
(comma and space).java.lang.String
makeString(java.lang.String separator)
Returns a string representation of this collection by delegating toRichIterable.makeString(String, String, String)
and defaulting the start and end parameters to""
(the empty String).java.lang.String
makeString(java.lang.String start, java.lang.String separator, java.lang.String end)
Returns a string representation of this collection 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(java.util.Comparator<? super V> comparator)
Returns the maximum element out of this container based on the comparator.<VV extends java.lang.Comparable<? super VV>>
VmaxBy(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(java.util.Comparator<? super V> comparator)
Returns the minimum element out of this container based on the comparator.<VV extends java.lang.Comparable<? super VV>>
VminBy(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()<R extends java.util.Collection<V>>
Rreject(Predicate<? super V> predicate, R target)
Same as the reject method with one parameter but uses the specified target collection for the results.<P,R extends java.util.Collection<V>>
RrejectWith(Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)
Similar toRichIterable.reject(Predicate, Collection)
, except with an evaluation parameter for the second generic argument inPredicate2
.<R extends java.util.Collection<V>>
Rselect(Predicate<? super V> predicate, R target)
Same as the select method with one parameter but uses the specified target collection for the results.<P,R extends java.util.Collection<V>>
RselectWith(Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)
Similar toRichIterable.select(Predicate, Collection)
, except with an evaluation parameter for the second generic argument inPredicate2
.int
size()
Returns the number of items in this iterable.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.java.lang.Object[]
toArray()
Converts this iterable to an array.<T> T[]
toArray(T[] a)
Converts this iterable to an array using the specified target array, assuming the target array is as long or longer than the iterable.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.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 java.util.Map<NK,NV>>
RtoMap(Function<? super V,? extends NK> keyFunction, Function<? super V,? extends NV> valueFunction, R target)
Same asRichIterable.toMap(Function, Function)
, except that the results are gathered into the specifiedtarget
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(java.util.Comparator<? super V> comparator)
Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.MutableList<V>
toSortedList()
Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.MutableList<V>
toSortedList(java.util.Comparator<? super V> comparator)
Converts the collection to a MutableList implementation and sorts it using the specified comparator.<NK,NV>
MutableSortedMap<NK,NV>toSortedMap(java.util.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.MutableSortedSet<V>
toSortedSet()
Converts the collection to a MutableSortedSet implementation and sorts it using the natural order of the elements.MutableSortedSet<V>
toSortedSet(java.util.Comparator<? super V> comparator)
Converts the collection to a MutableSortedSet implementation and sorts it using the specified comparator.java.lang.String
toString()
Returns a string with the keys and values of this map separated by commas with spaces and enclosed in curly braces.RichIterable<V>
valuesView()
Returns an unmodifiable lazy iterable wrapped around the values for the map.<S,R extends java.util.Collection<Pair<V,S>>>
Rzip(java.lang.Iterable<S> that, R target)
Deprecated.in 8.0.<R extends java.util.Collection<Pair<V,java.lang.Integer>>>
RzipWithIndex(R target)
Deprecated.in 8.0.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.collections.api.bimap.BiMap
collect, collectValues, flip, flipUniqueValues, groupBy, groupByEach, groupByUniqueKey, inverse, partition, partitionWith, reject, reject, rejectWith, select, select, selectInstancesOf, selectWith, tap, toImmutable, zip, zipWithIndex
-
Methods inherited from interface org.eclipse.collections.api.InternalIterable
forEach
-
Methods inherited from interface org.eclipse.collections.api.map.MapIterable
aggregateBy, injectIntoKeyValue, parallelStream, spliterator, stream
-
Methods inherited from interface org.eclipse.collections.api.RichIterable
aggregateBy, aggregateBy, aggregateInPlaceBy, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, countBy, countBy, countByEach, countByEach, countByWith, countByWith, flatCollect, flatCollectWith, flatCollectWith, forEach, getAny, groupByAndCollect, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, makeString, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, reduce, reduceInPlace, reduceInPlace, sumByDouble, sumByFloat, sumByInt, sumByLong, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, toImmutableBag, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toSortedBagBy, toSortedListBy, toSortedMapBy, toSortedSetBy
-
-
-
-
Method Detail
-
getDelegate
protected abstract MapIterable<K,V> getDelegate()
-
getInverse
protected abstract MapIterable<V,K> getInverse()
-
equals
public boolean equals(java.lang.Object obj)
Description copied from interface:MapIterable
Follows the same general contract asMap.equals(Object)
.- Specified by:
equals
in interfaceMapIterable<K,V>
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
Description copied from interface:MapIterable
Follows the same general contract asMap.hashCode()
.- Specified by:
hashCode
in interfaceMapIterable<K,V>
- Overrides:
hashCode
in classjava.lang.Object
-
size
public int size()
Description copied from interface:RichIterable
Returns the number of items in this iterable.- Specified by:
size
in interfaceRichIterable<K>
-
get
public V get(java.lang.Object key)
- Specified by:
get
in interfaceMapIterable<K,V>
- See Also:
Map.get(Object)
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
getOnly
public V getOnly()
Description copied from interface:RichIterable
Returns the element if the iterable has exactly one element. Otherwise, throwIllegalStateException
.- Specified by:
getOnly
in interfaceRichIterable<K>
- Returns:
- an element of an iterable.
-
getIfAbsent
public V getIfAbsent(K key, Function0<? extends V> function)
Description copied from interface:MapIterable
Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified Function0.- Specified by:
getIfAbsent
in interfaceMapIterable<K,V>
-
getOrDefault
public V getOrDefault(java.lang.Object key, V defaultValue)
- Specified by:
getOrDefault
in interfaceMapIterable<K,V>
-
getIfAbsentValue
public V getIfAbsentValue(K key, V value)
Description copied from interface:MapIterable
Return the value in the Map that corresponds to the specified key, or if there is no value at the key, returnvalue
.- Specified by:
getIfAbsentValue
in interfaceMapIterable<K,V>
-
getIfAbsentWith
public <P> V getIfAbsentWith(K key, Function<? super P,? extends V> function, P parameter)
Description copied from interface:MapIterable
Return the value in the Map that corresponds to the specified key, or if there is no value at the key, return the result of evaluating the specified function and parameter.- Specified by:
getIfAbsentWith
in interfaceMapIterable<K,V>
-
ifPresentApply
public <A> A ifPresentApply(K key, Function<? super V,? extends A> function)
Description copied from interface:MapIterable
If there is a value in the Map that corresponds to the specified key return the result of applying the specified Function on the value, otherwise return null.- Specified by:
ifPresentApply
in interfaceMapIterable<K,V>
-
isEmpty
public boolean isEmpty()
Description copied from interface:RichIterable
Returns true if this iterable has zero items.- Specified by:
isEmpty
in interfaceRichIterable<K>
-
notEmpty
public boolean notEmpty()
Description copied from interface:RichIterable
The English equivalent of !this.isEmpty()- Specified by:
notEmpty
in interfaceRichIterable<K>
-
contains
public boolean contains(java.lang.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 interfaceRichIterable<K>
-
containsKey
public boolean containsKey(java.lang.Object key)
- Specified by:
containsKey
in interfaceMapIterable<K,V>
- See Also:
Map.containsKey(Object)
-
containsValue
public boolean containsValue(java.lang.Object value)
- Specified by:
containsValue
in interfaceMapIterable<K,V>
- See Also:
Map.containsValue(Object)
-
containsAllIterable
public boolean containsAllIterable(java.lang.Iterable<?> source)
Description copied from interface:RichIterable
Returns true if all elements in source are contained in this collection.- Specified by:
containsAllIterable
in interfaceRichIterable<K>
-
containsAll
public boolean containsAll(java.util.Collection<?> source)
Description copied from interface:RichIterable
Returns true if all elements in source are contained in this collection.- Specified by:
containsAll
in interfaceRichIterable<K>
- See Also:
Collection.containsAll(Collection)
-
containsAllArguments
public boolean containsAllArguments(java.lang.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 interfaceRichIterable<K>
-
keysView
public RichIterable<K> keysView()
Description copied from interface:MapIterable
Returns an unmodifiable lazy iterable wrapped around the keySet for the map.- Specified by:
keysView
in interfaceMapIterable<K,V>
-
valuesView
public RichIterable<V> valuesView()
Description copied from interface:MapIterable
Returns an unmodifiable lazy iterable wrapped around the values for the map.- Specified by:
valuesView
in interfaceMapIterable<K,V>
-
keyValuesView
public RichIterable<Pair<K,V>> keyValuesView()
Description copied from interface:MapIterable
Returns an unmodifiable lazy iterable of key/value pairs wrapped around the entrySet for the map.- Specified by:
keyValuesView
in interfaceMapIterable<K,V>
-
into
public <R extends java.util.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 interfaceRichIterable<K>
-
toList
public MutableList<V> toList()
Description copied from interface:RichIterable
Converts the collection to a MutableList implementation.- Specified by:
toList
in interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
toSortedList
public MutableList<V> toSortedList(java.util.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 interfaceRichIterable<K>
-
toSet
public MutableSet<V> toSet()
Description copied from interface:RichIterable
Converts the collection to a MutableSet implementation.- Specified by:
toSet
in interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
toSortedSet
public MutableSortedSet<V> toSortedSet(java.util.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 interfaceRichIterable<K>
-
toBag
public MutableBag<V> toBag()
Description copied from interface:RichIterable
Converts the collection to the default MutableBag implementation.- Specified by:
toBag
in interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
toSortedBag
public MutableSortedBag<V> toSortedBag(java.util.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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
toMap
public <NK,NV,R extends java.util.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 asRichIterable.toMap(Function, Function)
, except that the results are gathered into the specifiedtarget
map.- Specified by:
toMap
in interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
toSortedMap
public <NK,NV> MutableSortedMap<NK,NV> toSortedMap(java.util.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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
toArray
public java.lang.Object[] toArray()
Description copied from interface:RichIterable
Converts this iterable to an array.- Specified by:
toArray
in interfaceRichIterable<K>
- 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 interfaceRichIterable<K>
- See Also:
Collection.toArray(Object[])
-
toString
public java.lang.String toString()
Description copied from interface:MapIterable
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}", Maps.mutable.with(1, 1, 2, 2, 3, 3).toString());
- Specified by:
toString
in interfaceMapIterable<K,V>
- Specified by:
toString
in interfaceRichIterable<K>
- Overrides:
toString
in classjava.lang.Object
- Returns:
- a string representation of this MapIterable
- See Also:
AbstractMap.toString()
-
makeString
public java.lang.String makeString()
Description copied from interface:RichIterable
Returns a string representation of this collection by delegating toRichIterable.makeString(String)
and defaulting the separator parameter to the characters", "
(comma and space).- Specified by:
makeString
in interfaceRichIterable<K>
- Returns:
- a string representation of this collection.
-
makeString
public java.lang.String makeString(java.lang.String separator)
Description copied from interface:RichIterable
Returns a string representation of this collection by delegating toRichIterable.makeString(String, String, String)
and defaulting the start and end parameters to""
(the empty String).- Specified by:
makeString
in interfaceRichIterable<K>
- Returns:
- a string representation of this collection.
-
makeString
public java.lang.String makeString(java.lang.String start, java.lang.String separator, java.lang.String end)
Description copied from interface: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 interfaceRichIterable<K>
- Returns:
- a string representation of this collection.
-
appendString
public void appendString(java.lang.Appendable appendable)
Description copied from interface:RichIterable
Prints a string representation of this collection onto the givenAppendable
. Prints the string returned byRichIterable.makeString()
.- Specified by:
appendString
in interfaceRichIterable<K>
-
appendString
public void appendString(java.lang.Appendable appendable, java.lang.String separator)
Description copied from interface:RichIterable
Prints a string representation of this collection onto the givenAppendable
. Prints the string returned byRichIterable.makeString(String)
.- Specified by:
appendString
in interfaceRichIterable<K>
-
appendString
public void appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.String end)
Description copied from interface:RichIterable
Prints a string representation of this collection onto the givenAppendable
. Prints the string returned byRichIterable.makeString(String, String, String)
.- Specified by:
appendString
in interfaceRichIterable<K>
-
forEachValue
public void forEachValue(Procedure<? super V> procedure)
Description copied from interface:MapIterable
Calls the procedure with each value of the map.Set<String> result = UnifiedSet.newSet(); MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three", 4, "Four"); map.forEachValue(new CollectionAddProcedure<String>(result)); Verify.assertSetsEqual(UnifiedSet.newSetWith("One", "Two", "Three", "Four"), result);
- Specified by:
forEachValue
in interfaceMapIterable<K,V>
-
forEachKey
public void forEachKey(Procedure<? super K> procedure)
Description copied from interface:MapIterable
Calls theprocedure
with each key of the map.final Collection<Integer> result = new ArrayList<Integer>(); MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "1", 2, "2", 3, "3"); map.forEachKey(new CollectionAddProcedure<Integer>(result)); Verify.assertContainsAll(result, 1, 2, 3);
- Specified by:
forEachKey
in interfaceMapIterable<K,V>
-
forEachKeyValue
public void forEachKeyValue(Procedure2<? super K,? super V> procedure)
Description copied from interface:MapIterable
Calls theprocedure
with each key-value pair of the map.final Collection<String> collection = new ArrayList<String>(); MutableMap<Integer, String> map = this.newMapWithKeysValues(1, "One", 2, "Two", 3, "Three"); map.forEachKeyValue((Integer key, String value) -> collection.add(String.valueOf(key) + value)); Verify.assertContainsAll(collection, "1One", "2Two", "3Three");
- Specified by:
forEachKeyValue
in interfaceMapIterable<K,V>
-
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 ofInternalIterable.forEach(Procedure)
that has a signature conflict withIterable.forEach(java.util.function.Consumer)
.- Specified by:
each
in interfaceRichIterable<K>
- 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 interfaceInternalIterable<K>
-
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 interfaceInternalIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
min
public V min(java.util.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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
minBy
public <VV extends java.lang.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 interfaceRichIterable<K>
-
max
public V max(java.util.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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
maxBy
public <VV extends java.lang.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 interfaceRichIterable<K>
-
detect
public Pair<K,V> detect(Predicate2<? super K,? super V> predicate)
Description copied from interface:MapIterable
Return the first key and value of the map for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate. The result is null if predicate does not evaluate to true for any key/value combination.Pair<City, Person> detected = peopleByCity.detect((City city, Person person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
detect
in interfaceMapIterable<K,V>
-
detect
public V detect(Predicate<? super V> predicate)
Description copied from interface:RichIterable
Returns the first element of the iterable for which the predicate evaluates to true or null in the case where no element returns true. This method is commonly called find.Example using a Java 8 lambda expression:
Person person = people.detect(person -> person.getFirstName().equals("John") && person.getLastName().equals("Smith"));
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
detectOptional
public java.util.Optional<Pair<K,V>> detectOptional(Predicate2<? super K,? super V> predicate)
Description copied from interface:MapIterable
Return the first key and value of the map as an Optional for which the predicate evaluates to true when they are given as arguments. The predicate will only be evaluated until such pair is found or until all the keys and values of the map have been used as arguments. That is, there may be keys and values of the map that are never used as arguments to the predicate.Optional<Pair<City, Person>> detected = peopleByCity.detectOptional((city, person) -> city.getName().equals("Anytown") && person.getLastName().equals("Smith"));
- Specified by:
detectOptional
in interfaceMapIterable<K,V>
-
detectOptional
public java.util.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 interfaceRichIterable<K>
-
detectWithOptional
public <P> java.util.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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
collect
public <VV,R extends java.util.Collection<VV>> R collect(Function<? super V,? extends VV> function, R target)
Description copied from interface:RichIterable
Same asRichIterable.collect(Function)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
- Parameters:
function
- aFunction
to use as the collect transformation functiontarget
- the Collection to append to for all elements in thisRichIterable
that meet select criteriafunction
- Returns:
target
, which contains appended elements as a result of the collect transformation- See Also:
RichIterable.collect(Function)
-
collectBoolean
public <R extends MutableBooleanCollection> R collectBoolean(BooleanFunction<? super V> booleanFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectBoolean(BooleanFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
- Parameters:
booleanFunction
- aBooleanFunction
to use as the collect transformation functiontarget
- the MutableBooleanCollection to append to for all elements in thisRichIterable
- Returns:
target
, which contains appended elements as a result of the collect transformation
-
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 interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectByte
public <R extends MutableByteCollection> R collectByte(ByteFunction<? super V> byteFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectByte(ByteFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
- Parameters:
byteFunction
- aByteFunction
to use as the collect transformation functiontarget
- the MutableByteCollection to append to for all elements in thisRichIterable
- Returns:
target
, which contains appended elements as a result of the collect transformation
-
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 interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectChar
public <R extends MutableCharCollection> R collectChar(CharFunction<? super V> charFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectChar(CharFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
- Parameters:
charFunction
- aCharFunction
to use as the collect transformation functiontarget
- the MutableCharCollection to append to for all elements in thisRichIterable
- Returns:
target
, which contains appended elements as a result of the collect transformation
-
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 interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectDouble
public <R extends MutableDoubleCollection> R collectDouble(DoubleFunction<? super V> doubleFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectDouble(DoubleFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
- Parameters:
doubleFunction
- aDoubleFunction
to use as the collect transformation functiontarget
- the MutableDoubleCollection to append to for all elements in thisRichIterable
- Returns:
target
, which contains appended elements as a result of the collect transformation
-
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 interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectFloat
public <R extends MutableFloatCollection> R collectFloat(FloatFunction<? super V> floatFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectFloat(FloatFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
- Parameters:
floatFunction
- aFloatFunction
to use as the collect transformation functiontarget
- the MutableFloatCollection to append to for all elements in thisRichIterable
- Returns:
target
, which contains appended elements as a result of the collect transformation
-
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 interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectInt
public <R extends MutableIntCollection> R collectInt(IntFunction<? super V> intFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectInt(IntFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
- Parameters:
intFunction
- aIntFunction
to use as the collect transformation functiontarget
- the MutableIntCollection to append to for all elements in thisRichIterable
- Returns:
target
, which contains appended elements as a result of the collect transformation
-
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 interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectLong
public <R extends MutableLongCollection> R collectLong(LongFunction<? super V> longFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectLong(LongFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
- Parameters:
longFunction
- aLongFunction
to use as the collect transformation functiontarget
- the MutableLongCollection to append to for all elements in thisRichIterable
- Returns:
target
, which contains appended elements as a result of the collect transformation
-
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 interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectShort
public <R extends MutableShortCollection> R collectShort(ShortFunction<? super V> shortFunction, R target)
Description copied from interface:RichIterable
Same asRichIterable.collectShort(ShortFunction)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
- Parameters:
shortFunction
- aShortFunction
to use as the collect transformation functiontarget
- the MutableShortCollection to append to for all elements in thisRichIterable
- Returns:
target
, which contains appended elements as a result of the collect transformation
-
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 interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
collectWith
public <P,VV,R extends java.util.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 interfaceRichIterable<K>
- Parameters:
function
- aFunction2
to use as the collect transformation functionparameter
- a parameter to pass in for evaluation of the second argumentP
infunction
targetCollection
- the Collection to append to for all elements in thisRichIterable
that meet select criteriafunction
- Returns:
targetCollection
, which contains appended elements as a result of the collect transformation
-
collectIf
public <VV,R extends java.util.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 interfaceRichIterable<K>
- Parameters:
predicate
- aPredicate
to use as the select criteriafunction
- aFunction
to use as the collect transformation functiontarget
- the Collection to append to for all elements in thisRichIterable
that meet the collect criteriapredicate
- Returns:
targetCollection
, which contains appended elements as a result of the collect criteria and transformation- See Also:
RichIterable.collectIf(Predicate, Function)
-
flatCollect
public <VV,R extends java.util.Collection<VV>> R flatCollect(Function<? super V,? extends java.lang.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 interfaceRichIterable<K>
- Parameters:
function
- TheFunction
to applytarget
- The collection into which results should be added.- Returns:
target
, which will contain a flattened collection of results produced by applying the givenfunction
- See Also:
RichIterable.flatCollect(Function)
-
select
public <R extends java.util.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 interfaceRichIterable<K>
- Parameters:
predicate
- aPredicate
to use as the select criteriatarget
- the Collection to append to for all elements in thisRichIterable
that meet select criteriapredicate
- Returns:
target
, which contains appended elements as a result of the select criteria- See Also:
RichIterable.select(Predicate)
-
selectWith
public <P,R extends java.util.Collection<V>> R selectWith(Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)
Description copied from interface:RichIterable
Similar toRichIterable.select(Predicate, Collection)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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 interfaceRichIterable<K>
- Parameters:
predicate
- aPredicate2
to use as the select criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
targetCollection
- the Collection to append to for all elements in thisRichIterable
that meet select criteriapredicate
- Returns:
targetCollection
, which contains appended elements as a result of the select criteria- See Also:
RichIterable.select(Predicate)
,RichIterable.select(Predicate, Collection)
-
reject
public <R extends java.util.Collection<V>> R reject(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 interfaceRichIterable<K>
- Parameters:
predicate
- aPredicate
to use as the reject criteriatarget
- the Collection to append to for all elements in thisRichIterable
that causePredicate#accept(Object)
method to evaluate to false- Returns:
target
, which contains appended elements as a result of the reject criteria
-
rejectWith
public <P,R extends java.util.Collection<V>> R rejectWith(Predicate2<? super V,? super P> predicate, P parameter, R targetCollection)
Description copied from interface:RichIterable
Similar toRichIterable.reject(Predicate, Collection)
, except with an evaluation parameter for the second generic argument inPredicate2
.E.g. return a
Collection
of Person elements where the person has an age greater than or equal to 18 yearsExample 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 interfaceRichIterable<K>
- Parameters:
predicate
- aPredicate2
to use as the reject criteriaparameter
- a parameter to pass in for evaluation of the second argumentP
inpredicate
targetCollection
- the Collection to append to for all elements in thisRichIterable
that causePredicate#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)
-
zip
@Deprecated public <S,R extends java.util.Collection<Pair<V,S>>> R zip(java.lang.Iterable<S> that, R target)
Deprecated.in 8.0. UseOrderedIterable.zip(Iterable, Collection)
instead.Description copied from interface:RichIterable
Same asRichIterable.zip(Iterable)
but usestarget
for output.- Specified by:
zip
in interfaceRichIterable<K>
-
zipWithIndex
@Deprecated public <R extends java.util.Collection<Pair<V,java.lang.Integer>>> R zipWithIndex(R target)
Deprecated.in 8.0. UseOrderedIterable.zipWithIndex(Collection)
instead.Description copied from interface:RichIterable
Same asRichIterable.zipWithIndex()
but usestarget
for output.- Specified by:
zipWithIndex
in interfaceRichIterable<K>
-
chunk
public RichIterable<RichIterable<V>> chunk(int size)
Description copied from interface:RichIterable
Partitions elements in fixed size chunks.- Specified by:
chunk
in interfaceRichIterable<K>
- Parameters:
size
- the number of elements per chunk- Returns:
- A
RichIterable
containingRichIterable
s of sizesize
, except the last will be truncated if the elements don't divide evenly.
-
groupBy
public <VV,R extends MutableMultimap<VV,V>> R groupBy(Function<? super V,? extends VV> function, R target)
Description copied from interface:RichIterable
Same asRichIterable.groupBy(Function)
, except that the results are gathered into the specifiedtarget
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 interfaceRichIterable<K>
-
groupByEach
public <VV,R extends MutableMultimap<VV,V>> R groupByEach(Function<? super V,? extends java.lang.Iterable<VV>> function, R target)
Description copied from interface:RichIterable
Same asRichIterable.groupByEach(Function)
, except that the results are gathered into the specifiedtarget
multimap.- Specified by:
groupByEach
in interfaceRichIterable<K>
-
groupByUniqueKey
public <VV,R extends MutableMapIterable<VV,V>> R groupByUniqueKey(Function<? super V,? extends VV> function, R target)
Description copied from interface:RichIterable
Same asRichIterable.groupByUniqueKey(Function)
, except that the results are gathered into the specifiedtarget
map.- Specified by:
groupByUniqueKey
in interfaceRichIterable<K>
- See Also:
RichIterable.groupByUniqueKey(Function)
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
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 interfaceRichIterable<K>
-
-