Class ImmutableEmptyBag<T>

java.lang.Object

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

org.eclipse.collections.impl.bag.AbstractBag<T>

org.eclipse.collections.impl.bag.immutable.AbstractImmutableBagIterable<T>

org.eclipse.collections.impl.bag.immutable.AbstractImmutableBag<T>

org.eclipse.collections.impl.bag.immutable.ImmutableEmptyBag<T>

All Implemented Interfaces:

Serializable, Iterable<T>, Collection<T>, Bag<T>, ImmutableBag<T>, ImmutableBagIterable<T>, UnsortedBag<T>, ImmutableCollection<T>, InternalIterable<T>, RichIterable<T>

final class ImmutableEmptyBag<T>
extends AbstractImmutableBag<T>
implements Serializable

This is a zero element ImmutableBag which is created by calling the Bags.immutable.empty().

Since:

1.0

Field Summary

Fields

Modifier and Type	Field	Description
private static final PartitionImmutableBag<Object>	IMMUTABLE_EMPTY_PARTITION
(package private) static final ImmutableBag<?>	INSTANCE
private static final LazyIterable<?>	LAZY_ITERABLE
private static final long	serialVersionUID
private static final Object[]	TO_ARRAY

Constructor Summary

Constructors

Constructor	Description
ImmutableEmptyBag()

Method Summary

Modifier and Type	Method	Description
boolean	allSatisfy(Predicate<? super T> 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 T, ? super P> predicate, P parameter)	Returns true if the predicate evaluates to true for every element of the collection, or returns false.
boolean	allSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns true if the predicate evaluates to true for all elements of the Bag.
boolean	anySatisfy(Predicate<? super T> predicate)	Returns true if the predicate evaluates to true for any element of the iterable.
<P> boolean	anySatisfyWith(Predicate2<? super T, ? super P> predicate, P parameter)	Returns true if the predicate evaluates to true for any element of the collection, or return false.
boolean	anySatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns true if the predicate evaluates to true for any element of the Bag.
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<T>	asLazy()	Returns a lazy (deferred) iterable, most likely implemented by calling LazyIterate.adapt(this).
RichIterable<RichIterable<T>>	chunk(int size)	Partitions elements in fixed size chunks.
<V> ImmutableBag<V>	collect(Function<? super T, ? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
ImmutableBooleanBag	collectBoolean(BooleanFunction<? super T> booleanFunction)	Returns a new primitive boolean iterable with the results of applying the specified function on each element of the source collection.
ImmutableByteBag	collectByte(ByteFunction<? super T> byteFunction)	Returns a new primitive byte iterable with the results of applying the specified function on each element of the source collection.
ImmutableCharBag	collectChar(CharFunction<? super T> charFunction)	Returns a new primitive char iterable with the results of applying the specified function on each element of the source collection.
ImmutableDoubleBag	collectDouble(DoubleFunction<? super T> doubleFunction)	Returns a new primitive double iterable with the results of applying the specified function on each element of the source collection.
ImmutableFloatBag	collectFloat(FloatFunction<? super T> floatFunction)	Returns a new primitive float iterable with the results of applying the specified function on each element of the source collection.
<V> ImmutableBag<V>	collectIf(Predicate<? super T> predicate, Function<? super T, ? extends V> 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.
ImmutableIntBag	collectInt(IntFunction<? super T> intFunction)	Returns a new primitive int iterable with the results of applying the specified function on each element of the source collection.
ImmutableLongBag	collectLong(LongFunction<? super T> longFunction)	Returns a new primitive long iterable with the results of applying the specified function on each element of the source collection.
ImmutableShortBag	collectShort(ShortFunction<? super T> shortFunction)	Returns a new primitive short iterable with the results of applying the specified function on each element of the source collection.
<P,V> ImmutableBag<V>	collectWith(Function2<? super T, ? super P, ? extends V> function, P parameter)	Same as RichIterable.collect(Function) with a Function2 and specified parameter which is passed to the block.
<V> ImmutableBag<V>	collectWithOccurrences(ObjectIntToObjectFunction<? super T, ? extends V> function)	Iterates over the unique elements and their occurrences and collects the results of applying the specified function.
<V, R extends Collection<V>> R	collectWithOccurrences(ObjectIntToObjectFunction<? super T, ? extends V> function, R target)	Iterates over the unique elements and their occurrences and collects the results of applying the specified function into the target collection.
boolean	contains(Object object)	Returns true if the iterable has an element which responds true to element.equals(object).
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.
int	count(Predicate<? super T> predicate)	Return the total number of elements that answer true to the specified predicate.
<V> ImmutableBag<V>	countBy(Function<? super T, ? extends V> function)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
<V, R extends MutableBagIterable<V>> R	countBy(Function<? super T, ? extends V> function, R target)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
<V> ImmutableBag<V>	countByEach(Function<? super T, ? extends Iterable<V>> function)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
<V, R extends MutableBagIterable<V>> R	countByEach(Function<? super T, ? extends Iterable<V>> function, R target)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection.
<V,P> ImmutableBag<V>	countByWith(Function2<? super T, ? super P, ? extends V> function, P parameter)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
<V, P, R extends MutableBagIterable<V>> R	countByWith(Function2<? super T, ? super P, ? extends V> function, P parameter, R target)	This method will count the number of occurrences of each value calculated by applying the function to each element of the collection with the specified parameter as the second argument.
<P> int	countWith(Predicate2<? super T, ? super P> predicate, P parameter)	Returns the total number of elements that evaluate to true for the specified predicate.
T	detect(Predicate<? super T> 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.
T	detectIfNone(Predicate<? super T> predicate, Function0<? extends T> function)	Returns the first element of the iterable for which the predicate evaluates to true.
Optional<T>	detectOptional(Predicate<? super T> predicate)	Returns the first element of the iterable for which the predicate evaluates to true as an Optional.
<P> T	detectWith(Predicate2<? super T, ? 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> T	detectWithIfNone(Predicate2<? super T, ? super P> predicate, P parameter, Function0<? extends T> 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.
T	detectWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns an element of the Bag that satisfies the predicate or null if such an element does not exist
<P> Optional<T>	detectWithOptional(Predicate2<? super T, ? super P> predicate, P parameter)	Returns the first element that evaluates to true for the specified predicate2 and parameter as an Optional.
RichIterable<T>	distinctView()	Returns an unmodifiable view on the distinct elements with the same complexity as the Bag implementation.
void	each(Procedure<? super T> procedure)	The procedure is executed for each element in the iterable.
boolean	equals(Object obj)	Two bags b1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).
<V> ImmutableBag<V>	flatCollect(Function<? super T, ? extends Iterable<V>> function)	flatCollect is a special case of RichIterable.collect(Function).
<P> void	forEachWith(Procedure2<? super T, ? 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 T> objectIntProcedure)	Iterates over the iterable passing each element and the current relative int index to the specified instance of ObjectIntProcedure.
void	forEachWithOccurrences(ObjectIntProcedure<? super T> objectIntProcedure)	For each distinct item, with the number of occurrences, execute the specified procedure.
T	getFirst()	Returns the first element of an iterable.
T	getLast()	Returns the last element of an iterable.
T	getOnly()	Returns the element if the iterable has exactly one element.
<V> ImmutableBagMultimap<V,T>	groupBy(Function<? super T, ? extends V> 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.
<V> ImmutableBagMultimap<V,T>	groupByEach(Function<? super T, ? extends Iterable<V>> function)	Similar to RichIterable.groupBy(Function), except the result of evaluating function will return a collection of keys for each value.
<V> ImmutableMap<V,T>	groupByUniqueKey(Function<? super T, ? extends V> function)	For each element of the iterable, the function is evaluated, and the results of these evaluations are collected into a new map, where the transformed value is the key.
int	hashCode()	Returns the hash code for this Bag, defined as this.Bag.toMapOfItemToCount().hashCode().
<IV> IV	injectInto(IV injectedValue, Function2<? super IV, ? super T, ? extends IV> function)	Returns the final result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
boolean	isEmpty()	Returns true if this iterable has zero items.
Iterator<T>	iterator()
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.
T	max()	Returns the maximum element out of this container based on the natural order.
T	max(Comparator<? super T> comparator)	Returns the maximum element out of this container based on the comparator.
<V extends Comparable<? super V>> T	maxBy(Function<? super T, ? extends V> function)	Returns the maximum elements out of this container based on the natural order of the attribute returned by Function.
T	min()	Returns the minimum element out of this container based on the natural order.
T	min(Comparator<? super T> comparator)	Returns the minimum element out of this container based on the comparator.
<V extends Comparable<? super V>> T	minBy(Function<? super T, ? extends V> function)	Returns the minimum elements out of this container based on the natural order of the attribute returned by Function.
ImmutableBag<T>	newWith(T element)	This method is similar to the with method in MutableCollection with the difference that a new copy of this collection with the element appended will be returned.
ImmutableBag<T>	newWithAll(Iterable<? extends T> elements)	This method is similar to the withAll method in MutableCollection with the difference that a new copy of this collection with the elements appended will be returned.
ImmutableBag<T>	newWithout(T element)	This method is similar to the without method in MutableCollection with the difference that a new copy of this collection with the element removed will be returned.
boolean	noneSatisfy(Predicate<? super T> 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 T, ? super P> predicate, P parameter)	Returns true if the predicate evaluates to false for every element of the collection, or return false.
boolean	noneSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns true if the Bag is empty or if the predicate evaluates to false for all elements of the Bag.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
int	occurrencesOf(Object item)	The occurrences of a distinct item in the bag.
PartitionImmutableBag<T>	partition(Predicate<? super T> predicate)	Filters a collection into a PartitionedIterable based on the evaluation of the predicate.
<P> PartitionImmutableBag<T>	partitionWith(Predicate2<? super T, ? super P> predicate, P parameter)	Filters a collection into a PartitionIterable based on the evaluation of the predicate.
ImmutableBag<T>	reject(Predicate<? super T> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
<P> ImmutableBag<T>	rejectWith(Predicate2<? super T, ? super P> predicate, P parameter)	Similar to RichIterable.reject(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
ImmutableBag<T>	select(Predicate<? super T> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
ImmutableBag<T>	selectByOccurrences(IntPredicate predicate)	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
<S> ImmutableBag<S>	selectInstancesOf(Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
ImmutableSet<T>	selectUnique()	Returns a set containing all elements of the bag that have exactly one occurrence.
<P> ImmutableBag<T>	selectWith(Predicate2<? super T, ? super P> predicate, P parameter)	Similar to RichIterable.select(Predicate), except with an evaluation parameter for the second generic argument in Predicate2.
int	size()	Returns the number of items in this iterable.
int	sizeDistinct()	The size of the Bag when counting only distinct elements.
ImmutableBag<T>	tap(Procedure<? super T> 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<T>	toBag()	Converts the collection to the default MutableBag implementation.
MutableList<T>	toList()	Converts the collection to a MutableList implementation.
<NK,NV> MutableMap<NK,NV>	toMap(Function<? super T, ? extends NK> keyFunction, Function<? super T, ? 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 T, ? extends NK> keyFunction, Function<? super T, ? extends NV> valueFunction, R target)	Same as RichIterable.toMap(Function, Function), except that the results are gathered into the specified target map.
MutableMap<T,Integer>	toMapOfItemToCount()	Converts the Bag to a Map of the Item type to its count as an Integer.
MutableSet<T>	toSet()	Converts the collection to a MutableSet implementation.
MutableSortedBag<T>	toSortedBag()	Converts the collection to a MutableSortedBag implementation and sorts it using the natural order of the elements.
MutableSortedBag<T>	toSortedBag(Comparator<? super T> comparator)	Converts the collection to the MutableSortedBag implementation and sorts it using the specified comparator.
MutableList<T>	toSortedList()	Converts the collection to a MutableList implementation and sorts it using the natural order of the elements.
MutableList<T>	toSortedList(Comparator<? super T> comparator)	Converts the collection to a MutableList implementation and sorts it using the specified comparator.
<NK,NV> MutableSortedMap<NK,NV>	toSortedMap(Comparator<? super NK> comparator, Function<? super T, ? extends NK> keyFunction, Function<? super T, ? 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 T, ? extends NK> keyFunction, Function<? super T, ? extends NV> valueFunction)	Converts the collection to a MutableSortedMap implementation using the specified key and value functions sorted by the key elements' natural ordering.
String	toString()	Returns a string with the elements of the iterable separated by commas with spaces and enclosed in square brackets.
private Object	writeReplace()
<S> ImmutableBag<Pair<T,S>>	zip(Iterable<S> that)	Deprecated. in 6.0.
ImmutableSet<Pair<T,Integer>>	zipWithIndex()	Deprecated. in 6.0.

Methods inherited from class AbstractImmutableBag

bottomOccurrences, newWithoutAll, toImmutable, topOccurrences

Methods inherited from class AbstractImmutableBagIterable

add, addAll, castToCollection, clear, parallelStream, remove, removeAll, removeAllFrom, retainAll, shortCircuit, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from class AbstractBag

collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectIntoWith, occurrencesSortingBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toListWithOccurrences, toSortedSet, toSortedSet, toStringOfItemToCount

Methods inherited from class AbstractRichIterable

containsAll, forEach, groupByUniqueKey, into, toBiMap, toSortedBagBy, toSortedListBy, toSortedMapBy, toSortedSetBy, zip, zipWithIndex

Methods inherited from class Object

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

Methods inherited from interface Bag

aggregateBy, reduceBy, reduceInPlace, reduceInPlace, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, toStringOfItemToCount

Methods inherited from interface Collection

containsAll, removeIf, toArray

Methods inherited from interface ImmutableBag

flatCollectWith, selectDuplicates, toImmutableBag

Methods inherited from interface ImmutableBagIterable

selectDuplicates

Methods inherited from interface ImmutableCollection

aggregateBy, aggregateInPlaceBy, castToCollection, flatCollectWith, parallelStream, reduceBy, spliterator, stream, sumByDouble, sumByFloat, sumByInt, sumByLong

Methods inherited from interface InternalIterable

forEach

Methods inherited from interface RichIterable

collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, containsAll, containsAny, containsAnyIterable, containsBy, containsNone, containsNoneIterable, flatCollect, flatCollectBoolean, flatCollectByte, flatCollectChar, flatCollectDouble, flatCollectFloat, flatCollectInt, flatCollectLong, flatCollectShort, flatCollectWith, forEach, getAny, groupBy, groupByAndCollect, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, into, makeString, maxByOptional, maxOptional, maxOptional, minByOptional, minOptional, minOptional, reduce, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBiMap, toImmutableBiMap, toImmutableList, toImmutableMap, toImmutableSet, toImmutableSortedBag, toImmutableSortedBag, toImmutableSortedBagBy, toImmutableSortedList, toImmutableSortedList, toImmutableSortedListBy, toImmutableSortedSet, toImmutableSortedSet, toImmutableSortedSetBy, toSortedBagBy, toSortedListBy, toSortedMapBy, toSortedSet, toSortedSet, toSortedSetBy, zip, zipWithIndex

Field Details

INSTANCE

static final ImmutableBag<?> INSTANCE

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

LAZY_ITERABLE

private static final LazyIterable<?> LAZY_ITERABLE

TO_ARRAY

private static final Object[] TO_ARRAY

IMMUTABLE_EMPTY_PARTITION

private static final PartitionImmutableBag<Object> IMMUTABLE_EMPTY_PARTITION

Constructor Details

ImmutableEmptyBag

ImmutableEmptyBag()

Method Details

equals

public boolean equals(Object obj)

Description copied from interface: Bag

Two bags b1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).

Specified by:

equals in interface Bag<T>

Specified by:

equals in interface Collection<T>

Overrides:

equals in class Object

See Also:

• Map.equals(Object)

sizeDistinct

public int sizeDistinct()

Description copied from interface: Bag

The size of the Bag when counting only distinct elements.

Specified by:

sizeDistinct in interface Bag<T>

occurrencesOf

public int occurrencesOf(Object item)

Description copied from interface: Bag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface Bag<T>

forEachWithOccurrences

public void forEachWithOccurrences(ObjectIntProcedure<? super T> objectIntProcedure)

Description copied from interface: Bag

For each distinct item, with the number of occurrences, execute the specified procedure.

Specified by:

forEachWithOccurrences in interface Bag<T>

anySatisfyWithOccurrences

public boolean anySatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)

Description copied from interface: Bag

Returns true if the predicate evaluates to true for any element of the Bag. Returns false if the Bag is empty or if no element returns true for the predicate.

Specified by:

anySatisfyWithOccurrences in interface Bag<T>

allSatisfyWithOccurrences

public boolean allSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)

Description copied from interface: Bag

Returns true if the predicate evaluates to true for all elements of the Bag. Returns false if the Bag is empty or if not all elements return true for the predicate.

Specified by:

allSatisfyWithOccurrences in interface Bag<T>

noneSatisfyWithOccurrences

public boolean noneSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)

Description copied from interface: Bag

Returns true if the Bag is empty or if the predicate evaluates to false for all elements of the Bag. Returns false if the predicate evaluates to true for at least one element of the Bag.

Specified by:

noneSatisfyWithOccurrences in interface Bag<T>

detectWithOccurrences

public T detectWithOccurrences(ObjectIntPredicate<? super T> predicate)

Description copied from interface: Bag

Returns an element of the Bag that satisfies the predicate or null if such an element does not exist

Specified by:

detectWithOccurrences in interface Bag<T>

collectWithOccurrences

public <V> ImmutableBag<V> collectWithOccurrences(ObjectIntToObjectFunction<? super T, ? extends V> function)

Description copied from interface: Bag

Iterates over the unique elements and their occurrences and collects the results of applying the specified function.

Specified by:

collectWithOccurrences in interface Bag<T>

Specified by:

collectWithOccurrences in interface ImmutableBag<T>

Specified by:

collectWithOccurrences in interface ImmutableBagIterable<T>

Specified by:

collectWithOccurrences in interface UnsortedBag<T>

Overrides:

collectWithOccurrences in class AbstractImmutableBag<T>

collectWithOccurrences

public <V, R extends Collection<V>> R collectWithOccurrences(ObjectIntToObjectFunction<? super T, ? extends V> function,
 R target)

Description copied from interface: Bag

Iterates over the unique elements and their occurrences and collects the results of applying the specified function into the target collection.

Specified by:

collectWithOccurrences in interface Bag<T>

Since:

9.1.

toMapOfItemToCount

public MutableMap<T,Integer> toMapOfItemToCount()

Description copied from interface: Bag

Converts the Bag to a Map of the Item type to its count as an Integer.

Specified by:

toMapOfItemToCount in interface Bag<T>

Specified by:

toMapOfItemToCount in interface ImmutableBagIterable<T>

hashCode

public int hashCode()

Description copied from interface: Bag

Returns the hash code for this Bag, defined as this.Bag.toMapOfItemToCount().hashCode().

Specified by:

hashCode in interface Bag<T>

Specified by:

hashCode in interface Collection<T>

Overrides:

hashCode in class Object

See Also:

• Map.hashCode()

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface Collection<T>

Specified by:

size in interface RichIterable<T>

isEmpty

public boolean isEmpty()

Description copied from interface: RichIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface RichIterable<T>

Overrides:

isEmpty in class AbstractRichIterable<T>

notEmpty

public boolean notEmpty()

Description copied from interface: RichIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface RichIterable<T>

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 Collection<T>

Specified by:

contains in interface RichIterable<T>

Overrides:

contains in class AbstractRichIterable<T>

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

Overrides:

containsAllIterable in class AbstractRichIterable<T>

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

Overrides:

containsAllArguments in class AbstractRichIterable<T>

tap

public ImmutableBag<T> tap(Procedure<? super T> procedure)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

tap in interface Bag<T>

Specified by:

tap in interface ImmutableBag<T>

Specified by:

tap in interface ImmutableBagIterable<T>

Specified by:

tap in interface ImmutableCollection<T>

Specified by:

tap in interface RichIterable<T>

Specified by:

tap in interface UnsortedBag<T>

Overrides:

tap in class AbstractImmutableBag<T>

See Also:

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

each

public void each(Procedure<? super T> 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()));

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

See Also:

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

forEachWithIndex

public void forEachWithIndex(ObjectIntProcedure<? super T> 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<T>

Overrides:

forEachWithIndex in class AbstractRichIterable<T>

forEachWith

public <P> void forEachWith(Procedure2<? super T, ? 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<T>

Overrides:

forEachWith in class AbstractRichIterable<T>

getFirst

public T 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<T>

getLast

public T 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<T>

getOnly

public T 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<T>

Returns:

an element of an iterable.

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface Iterable<T>

newWith

public ImmutableBag<T> newWith(T element)

Description copied from interface: ImmutableCollection

This method is similar to the with method in MutableCollection with the difference that a new copy of this collection with the element appended will be returned.

Specified by:

newWith in interface ImmutableBag<T>

Specified by:

newWith in interface ImmutableCollection<T>

newWithout

public ImmutableBag<T> newWithout(T element)

Description copied from interface: ImmutableCollection

This method is similar to the without method in MutableCollection with the difference that a new copy of this collection with the element removed will be returned.

Specified by:

newWithout in interface ImmutableBag<T>

Specified by:

newWithout in interface ImmutableCollection<T>

newWithAll

public ImmutableBag<T> newWithAll(Iterable<? extends T> elements)

Description copied from interface: ImmutableCollection

This method is similar to the withAll method in MutableCollection with the difference that a new copy of this collection with the elements appended will be returned.

Specified by:

newWithAll in interface ImmutableBag<T>

Specified by:

newWithAll in interface ImmutableCollection<T>

selectByOccurrences

public ImmutableBag<T> selectByOccurrences(IntPredicate predicate)

Description copied from interface: Bag

Returns all elements of the bag that have a number of occurrences that satisfy the predicate.

Specified by:

selectByOccurrences in interface Bag<T>

Specified by:

selectByOccurrences in interface ImmutableBag<T>

Specified by:

selectByOccurrences in interface ImmutableBagIterable<T>

Specified by:

selectByOccurrences in interface UnsortedBag<T>

select

public ImmutableBag<T> select(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

select in interface Bag<T>

Specified by:

select in interface ImmutableBag<T>

Specified by:

select in interface ImmutableBagIterable<T>

Specified by:

select in interface ImmutableCollection<T>

Specified by:

select in interface RichIterable<T>

Specified by:

select in interface UnsortedBag<T>

selectWith

public <P> ImmutableBag<T> selectWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

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

Specified by:

selectWith in interface Bag<T>

Specified by:

selectWith in interface ImmutableBag<T>

Specified by:

selectWith in interface ImmutableBagIterable<T>

Specified by:

selectWith in interface ImmutableCollection<T>

Specified by:

selectWith in interface RichIterable<T>

Specified by:

selectWith in interface UnsortedBag<T>

Overrides:

selectWith in class AbstractImmutableBag<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

• RichIterable.select(Predicate)

reject

public ImmutableBag<T> reject(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

reject in interface Bag<T>

Specified by:

reject in interface ImmutableBag<T>

Specified by:

reject in interface ImmutableBagIterable<T>

Specified by:

reject in interface ImmutableCollection<T>

Specified by:

reject in interface RichIterable<T>

Specified by:

reject in interface UnsortedBag<T>

Parameters:

predicate - a Predicate to use as the reject criteria

Returns:

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

rejectWith

public <P> ImmutableBag<T> rejectWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

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

Example using a Java 8 lambda expression:

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

Specified by:

rejectWith in interface Bag<T>

Specified by:

rejectWith in interface ImmutableBag<T>

Specified by:

rejectWith in interface ImmutableBagIterable<T>

Specified by:

rejectWith in interface ImmutableCollection<T>

Specified by:

rejectWith in interface RichIterable<T>

Specified by:

rejectWith in interface UnsortedBag<T>

Overrides:

rejectWith in class AbstractImmutableBag<T>

Parameters:

predicate - a Predicate2 to use as the select criteria

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

See Also:

• RichIterable.select(Predicate)

partition

public PartitionImmutableBag<T> partition(Predicate<? super T> predicate)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

partition in interface Bag<T>

Specified by:

partition in interface ImmutableBag<T>

Specified by:

partition in interface ImmutableBagIterable<T>

Specified by:

partition in interface ImmutableCollection<T>

Specified by:

partition in interface RichIterable<T>

Specified by:

partition in interface UnsortedBag<T>

Overrides:

partition in class AbstractImmutableBag<T>

partitionWith

public <P> PartitionImmutableBag<T> partitionWith(Predicate2<? super T, ? super P> predicate,
 P parameter)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

partitionWith in interface Bag<T>

Specified by:

partitionWith in interface ImmutableBag<T>

Specified by:

partitionWith in interface ImmutableBagIterable<T>

Specified by:

partitionWith in interface ImmutableCollection<T>

Specified by:

partitionWith in interface RichIterable<T>

Overrides:

partitionWith in class AbstractImmutableBag<T>

selectInstancesOf

public <S> ImmutableBag<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 Bag<T>

Specified by:

selectInstancesOf in interface ImmutableBag<T>

Specified by:

selectInstancesOf in interface ImmutableBagIterable<T>

Specified by:

selectInstancesOf in interface ImmutableCollection<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

Specified by:

selectInstancesOf in interface UnsortedBag<T>

collect

public <V> ImmutableBag<V> collect(Function<? super T, ? extends V> function)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collect in interface ImmutableBag<T>

Specified by:

collect in interface ImmutableCollection<T>

Specified by:

collect in interface RichIterable<T>

Specified by:

collect in interface UnsortedBag<T>

collectBoolean

public ImmutableBooleanBag collectBoolean(BooleanFunction<? super T> booleanFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectBoolean in interface ImmutableBag<T>

Specified by:

collectBoolean in interface ImmutableCollection<T>

Specified by:

collectBoolean in interface RichIterable<T>

Specified by:

collectBoolean in interface UnsortedBag<T>

Overrides:

collectBoolean in class AbstractImmutableBag<T>

collectByte

public ImmutableByteBag collectByte(ByteFunction<? super T> byteFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectByte in interface ImmutableBag<T>

Specified by:

collectByte in interface ImmutableCollection<T>

Specified by:

collectByte in interface RichIterable<T>

Specified by:

collectByte in interface UnsortedBag<T>

Overrides:

collectByte in class AbstractImmutableBag<T>

collectChar

public ImmutableCharBag collectChar(CharFunction<? super T> charFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectChar in interface ImmutableBag<T>

Specified by:

collectChar in interface ImmutableCollection<T>

Specified by:

collectChar in interface RichIterable<T>

Specified by:

collectChar in interface UnsortedBag<T>

Overrides:

collectChar in class AbstractImmutableBag<T>

collectDouble

public ImmutableDoubleBag collectDouble(DoubleFunction<? super T> doubleFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectDouble in interface ImmutableBag<T>

Specified by:

collectDouble in interface ImmutableCollection<T>

Specified by:

collectDouble in interface RichIterable<T>

Specified by:

collectDouble in interface UnsortedBag<T>

Overrides:

collectDouble in class AbstractImmutableBag<T>

collectFloat

public ImmutableFloatBag collectFloat(FloatFunction<? super T> floatFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectFloat in interface ImmutableBag<T>

Specified by:

collectFloat in interface ImmutableCollection<T>

Specified by:

collectFloat in interface RichIterable<T>

Specified by:

collectFloat in interface UnsortedBag<T>

Overrides:

collectFloat in class AbstractImmutableBag<T>

collectInt

public ImmutableIntBag collectInt(IntFunction<? super T> intFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectInt in interface ImmutableBag<T>

Specified by:

collectInt in interface ImmutableCollection<T>

Specified by:

collectInt in interface RichIterable<T>

Specified by:

collectInt in interface UnsortedBag<T>

Overrides:

collectInt in class AbstractImmutableBag<T>

collectLong

public ImmutableLongBag collectLong(LongFunction<? super T> longFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectLong in interface ImmutableBag<T>

Specified by:

collectLong in interface ImmutableCollection<T>

Specified by:

collectLong in interface RichIterable<T>

Specified by:

collectLong in interface UnsortedBag<T>

Overrides:

collectLong in class AbstractImmutableBag<T>

collectShort

public ImmutableShortBag collectShort(ShortFunction<? super T> shortFunction)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectShort in interface ImmutableBag<T>

Specified by:

collectShort in interface ImmutableCollection<T>

Specified by:

collectShort in interface RichIterable<T>

Specified by:

collectShort in interface UnsortedBag<T>

Overrides:

collectShort in class AbstractImmutableBag<T>

collectWith

public <P,V> ImmutableBag<V> collectWith(Function2<? super T, ? super P, ? extends V> function,
 P parameter)

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

collectWith in interface ImmutableBag<T>

Specified by:

collectWith in interface ImmutableCollection<T>

Specified by:

collectWith in interface RichIterable<T>

Specified by:

collectWith in interface UnsortedBag<T>

Overrides:

collectWith in class AbstractImmutableBag<T>

Parameters:

function - A Function2 to use as the collect transformation function

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

Returns:

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

See Also:

• RichIterable.collect(Function)

collectIf

public <V> ImmutableBag<V> collectIf(Predicate<? super T> predicate,
 Function<? super T, ? extends V> 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 ImmutableBag<T>

Specified by:

collectIf in interface ImmutableCollection<T>

Specified by:

collectIf in interface RichIterable<T>

Specified by:

collectIf in interface UnsortedBag<T>

flatCollect

public <V> ImmutableBag<V> flatCollect(Function<? super T, ? extends Iterable<V>> 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 ImmutableBag<T>

Specified by:

flatCollect in interface ImmutableCollection<T>

Specified by:

flatCollect in interface RichIterable<T>

Specified by:

flatCollect in interface UnsortedBag<T>

Parameters:

function - The Function to apply

Returns:

a new flattened collection produced by applying the given function

countBy

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

Description copied from interface: RichIterable

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

Specified by:

countBy in interface ImmutableBag<T>

Specified by:

countBy in interface ImmutableCollection<T>

Specified by:

countBy in interface RichIterable<T>

Overrides:

countBy in class AbstractImmutableBag<T>

Since:

9.0

countBy

public <V, R extends MutableBagIterable<V>> R countBy(Function<? super T, ? extends V> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

countBy in interface RichIterable<T>

Since:

9.0

countByWith

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

Description copied from interface: RichIterable

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

Specified by:

countByWith in interface ImmutableBag<T>

Specified by:

countByWith in interface ImmutableCollection<T>

Specified by:

countByWith in interface RichIterable<T>

Overrides:

countByWith in class AbstractImmutableBag<T>

Since:

9.0

countByWith

public <V, P, R extends MutableBagIterable<V>> R countByWith(Function2<? super T, ? super P, ? extends V> function,
 P parameter,
 R target)

Description copied from interface: RichIterable

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

Specified by:

countByWith in interface RichIterable<T>

Since:

9.0

countByEach

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

Description copied from interface: RichIterable

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

Specified by:

countByEach in interface ImmutableBag<T>

Specified by:

countByEach in interface ImmutableCollection<T>

Specified by:

countByEach in interface RichIterable<T>

Overrides:

countByEach in class AbstractImmutableBag<T>

Since:

10.0.0

countByEach

public <V, R extends MutableBagIterable<V>> R countByEach(Function<? super T, ? extends Iterable<V>> function,
 R target)

Description copied from interface: RichIterable

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

Specified by:

countByEach in interface RichIterable<T>

Since:

10.0.0

groupBy

public <V> ImmutableBagMultimap<V,T> groupBy(Function<? super T, ? extends V> function)

Description copied from interface: RichIterable

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

Example using a Java 8 method reference:

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

Specified by:

groupBy in interface Bag<T>

Specified by:

groupBy in interface ImmutableBag<T>

Specified by:

groupBy in interface ImmutableBagIterable<T>

Specified by:

groupBy in interface ImmutableCollection<T>

Specified by:

groupBy in interface RichIterable<T>

Specified by:

groupBy in interface UnsortedBag<T>

groupByEach

public <V> ImmutableBagMultimap<V,T> groupByEach(Function<? super T, ? extends Iterable<V>> 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 Bag<T>

Specified by:

groupByEach in interface ImmutableBag<T>

Specified by:

groupByEach in interface ImmutableBagIterable<T>

Specified by:

groupByEach in interface ImmutableCollection<T>

Specified by:

groupByEach in interface RichIterable<T>

Specified by:

groupByEach in interface UnsortedBag<T>

groupByUniqueKey

public <V> ImmutableMap<V,T> groupByUniqueKey(Function<? super T, ? extends V> 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 ImmutableCollection<T>

Specified by:

groupByUniqueKey in interface RichIterable<T>

Overrides:

groupByUniqueKey in class AbstractImmutableBag<T>

See Also:

• RichIterable.groupBy(Function)

detect

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

Description copied from interface: RichIterable

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

Example using a Java 8 lambda expression:

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

Specified by:

detect in interface RichIterable<T>

Overrides:

detect in class AbstractRichIterable<T>

detectWith

public <P> T detectWith(Predicate2<? super T, ? 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");

Specified by:

detectWith in interface RichIterable<T>

Overrides:

detectWith in class AbstractRichIterable<T>

detectOptional

public Optional<T> detectOptional(Predicate<? super T> 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<T>

Overrides:

detectOptional in class AbstractRichIterable<T>

detectWithOptional

public <P> Optional<T> detectWithOptional(Predicate2<? super T, ? 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<T>

Overrides:

detectWithOptional in class AbstractRichIterable<T>

detectIfNone

public T detectIfNone(Predicate<? super T> predicate,
 Function0<? extends T> 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<T>

detectWithIfNone

public <P> T detectWithIfNone(Predicate2<? super T, ? super P> predicate,
 P parameter,
 Function0<? extends T> 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<T>

Overrides:

detectWithIfNone in class AbstractRichIterable<T>

count

public int count(Predicate<? super T> 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"));

Specified by:

count in interface RichIterable<T>

Overrides:

count in class AbstractBag<T>

countWith

public <P> int countWith(Predicate2<? super T, ? 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<T>

Overrides:

countWith in class AbstractRichIterable<T>

anySatisfy

public boolean anySatisfy(Predicate<? super T> 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<T>

Overrides:

anySatisfy in class AbstractRichIterable<T>

allSatisfy

public boolean allSatisfy(Predicate<? super T> 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<T>

Overrides:

allSatisfy in class AbstractRichIterable<T>

noneSatisfy

public boolean noneSatisfy(Predicate<? super T> 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<T>

Overrides:

noneSatisfy in class AbstractRichIterable<T>

anySatisfyWith

public <P> boolean anySatisfyWith(Predicate2<? super T, ? 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<T>

Overrides:

anySatisfyWith in class AbstractRichIterable<T>

allSatisfyWith

public <P> boolean allSatisfyWith(Predicate2<? super T, ? 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<T>

Overrides:

allSatisfyWith in class AbstractRichIterable<T>

noneSatisfyWith

public <P> boolean noneSatisfyWith(Predicate2<? super T, ? 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<T>

Overrides:

noneSatisfyWith in class AbstractRichIterable<T>

injectInto

public <IV> IV injectInto(IV injectedValue,
 Function2<? super IV, ? super T, ? 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<T>

Overrides:

injectInto in class AbstractBag<T>

toList

public MutableList<T> toList()

Description copied from interface: RichIterable

Converts the collection to a MutableList implementation.

Specified by:

toList in interface RichIterable<T>

Overrides:

toList in class AbstractBag<T>

toSortedList

public MutableList<T> 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<T>

toSortedList

public MutableList<T> toSortedList(Comparator<? super T> 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<T>

Overrides:

toSortedList in class AbstractBag<T>

toSet

public MutableSet<T> toSet()

Description copied from interface: RichIterable

Converts the collection to a MutableSet implementation.

Specified by:

toSet in interface RichIterable<T>

Overrides:

toSet in class AbstractBag<T>

toBag

public MutableBag<T> toBag()

Description copied from interface: RichIterable

Converts the collection to the default MutableBag implementation.

Specified by:

toBag in interface RichIterable<T>

Overrides:

toBag in class AbstractBag<T>

toSortedBag

public MutableSortedBag<T> 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<T>

Overrides:

toSortedBag in class AbstractBag<T>

toSortedBag

public MutableSortedBag<T> toSortedBag(Comparator<? super T> 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<T>

Overrides:

toSortedBag in class AbstractBag<T>

toMap

public <NK,NV> MutableMap<NK,NV> toMap(Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? 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<T>

Overrides:

toMap in class AbstractRichIterable<T>

toMap

public <NK, NV, R extends Map<NK,NV>> R toMap(Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? 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<T>

toSortedMap

public <NK,NV> MutableSortedMap<NK,NV> toSortedMap(Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? 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<T>

Overrides:

toSortedMap in class AbstractRichIterable<T>

toSortedMap

public <NK,NV> MutableSortedMap<NK,NV> toSortedMap(Comparator<? super NK> comparator,
 Function<? super T, ? extends NK> keyFunction,
 Function<? super T, ? 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<T>

Overrides:

toSortedMap in class AbstractRichIterable<T>

asLazy

public LazyIterable<T> 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<T>

Overrides:

asLazy in class AbstractRichIterable<T>

toArray

public Object[] toArray()

Description copied from interface: RichIterable

Converts this iterable to an array.

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface RichIterable<T>

Overrides:

toArray in class AbstractBag<T>

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 Collection<T>

Specified by:

toArray in interface RichIterable<T>

Overrides:

toArray in class AbstractBag<T>

See Also:

• Collection.toArray(Object[])

min

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

Description copied from interface: RichIterable

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

Specified by:

min in interface RichIterable<T>

Overrides:

min in class AbstractRichIterable<T>

max

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

Description copied from interface: RichIterable

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

Specified by:

max in interface RichIterable<T>

Overrides:

max in class AbstractRichIterable<T>

min

public T 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<T>

Overrides:

min in class AbstractRichIterable<T>

max

public T 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<T>

Overrides:

max in class AbstractRichIterable<T>

minBy

public <V extends Comparable<? super V>> T minBy(Function<? super T, ? extends V> 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<T>

Overrides:

minBy in class AbstractRichIterable<T>

maxBy

public <V extends Comparable<? super V>> T maxBy(Function<? super T, ? extends V> 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<T>

Overrides:

maxBy in class AbstractRichIterable<T>

toString

public String toString()

Description copied from class: AbstractRichIterable

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

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

Specified by:

toString in interface RichIterable<T>

Overrides:

toString in class AbstractRichIterable<T>

Returns:

a string representation of this collection.

See Also:

• AbstractCollection.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<T>

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

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

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

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

Overrides:

appendString in class AbstractRichIterable<T>

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

Overrides:

appendString in class AbstractRichIterable<T>

zip

@Deprecated
public <S> ImmutableBag<Pair<T,S>> zip(Iterable<S> that)

Deprecated.

in 6.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 ImmutableBag<T>

Specified by:

zip in interface ImmutableCollection<T>

Specified by:

zip in interface RichIterable<T>

Specified by:

zip in interface UnsortedBag<T>

Type Parameters:

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

Parameters:

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

Returns:

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

zipWithIndex

@Deprecated
public ImmutableSet<Pair<T,Integer>> zipWithIndex()

Deprecated.

in 6.0. Use OrderedIterable.zipWithIndex() instead.

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface Bag<T>

Specified by:

zipWithIndex in interface ImmutableBag<T>

Specified by:

zipWithIndex in interface ImmutableBagIterable<T>

Specified by:

zipWithIndex in interface ImmutableCollection<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Specified by:

zipWithIndex in interface UnsortedBag<T>

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)

chunk

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

Description copied from interface: RichIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface RichIterable<T>

Overrides:

chunk in class AbstractImmutableBag<T>

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.

writeReplace

private Object writeReplace()

selectUnique

public ImmutableSet<T> selectUnique()

Description copied from interface: Bag

Returns a set containing all elements of the bag that have exactly one occurrence.

Specified by:

selectUnique in interface Bag<T>

Specified by:

selectUnique in interface ImmutableBag<T>

Specified by:

selectUnique in interface ImmutableBagIterable<T>

Specified by:

selectUnique in interface UnsortedBag<T>

distinctView

public RichIterable<T> distinctView()

Description copied from interface: Bag

Returns an unmodifiable view on the distinct elements with the same complexity as the Bag implementation.

Specified by:

distinctView in interface Bag<T>

Returns:

an unmodifiable view on the distinct elements of the Bag.