Package org.eclipse.collections.impl.bag.sorted.immutable

Class ImmutableEmptySortedBag<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.sorted.immutable.AbstractImmutableSortedBag<T>

org.eclipse.collections.impl.bag.sorted.immutable.ImmutableEmptySortedBag<T>

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SortedBag<T>>, java.lang.Iterable<T>, java.util.Collection<T>, Bag<T>, ImmutableBagIterable<T>, ImmutableSortedBag<T>, SortedBag<T>, ImmutableCollection<T>, InternalIterable<T>, OrderedIterable<T>, ReversibleIterable<T>, SortedIterable<T>, RichIterable<T>

class ImmutableEmptySortedBag<T>
extends AbstractImmutableSortedBag<T>
implements java.io.Serializable

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Comparator<? super T>	comparator
(package private) static ImmutableSortedBag<?>	INSTANCE
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImmutableEmptySortedBag()
(package private)	ImmutableEmptySortedBag(java.util.Comparator<? super T> comparator)

Method Summary

Modifier and Type	Method	Description
boolean	allSatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns true if the predicate evaluates to true for all elements of the Bag.
boolean	anySatisfyWithOccurrences(ObjectIntPredicate<? super T> predicate)	Returns true if the predicate evaluates to true for any element of the Bag.
RichIterable<RichIterable<T>>	chunk(int size)	Partitions elements in fixed size chunks.
<V> ImmutableList<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.
<V> ImmutableList<V>	collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)	Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.
<V,R extends java.util.Collection<V>> R	collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function, R target)	Adds elements to the target Collection using results obtained by applying the specified function to each element and its corresponding index.
<V> ImmutableList<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.
java.util.Comparator<? super T>	comparator()	Returns the comparator used to order the elements in this bag, or null if this bag uses the natural ordering of its elements.
int	compareTo(SortedBag<T> o)
boolean	contains(java.lang.Object object)	Returns true if the iterable has an element which responds true to element.equals(object).
<S> boolean	corresponds(OrderedIterable<S> other, Predicate2<? super T,? super S> predicate)	Returns true if both OrderedIterables have the same length and predicate returns true for all corresponding elements e1 of this OrderedIterable and e2 of other.
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 java.lang.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 java.lang.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.
int	detectIndex(Predicate<? super T> predicate)	Returns the index of the first element of the OrderedIterable for which the predicate evaluates to true.
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
ImmutableSortedSet<T>	distinct()	Returns a new SortedIterable containing the distinct elements in this iterable.
RichIterable<T>	distinctView()	Returns an unmodifiable view on the distinct elements with the same complexity as the Bag implementation.
ImmutableSortedBag<T>	drop(int count)	Returns an iterable after skipping the first count elements or an empty iterable if the count is greater than the length of the iterable.
ImmutableSortedBag<T>	dropWhile(Predicate<? super T> predicate)	Returns the final elements that do not satisfy the Predicate.
void	each(Procedure<? super T> procedure)	The procedure is executed for each element in the iterable.
boolean	equals(java.lang.Object other)	Two bags b1 and b2 are equal if m1.toMapOfItemToCount().equals(m2.toMapOfItemToCount()).
void	forEach(int startIndex, int endIndex, Procedure<? super T> procedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
<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(int fromIndex, int toIndex, ObjectIntProcedure<? super T> objectIntProcedure)	Iterates over the section of the iterable covered by the specified inclusive indexes.
void	forEachWithOccurrences(ObjectIntProcedure<? super T> procedure)	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> ImmutableSortedBagMultimap<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> ImmutableSortedBagMultimap<V,T>	groupByEach(Function<? super T,? extends java.lang.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().
java.util.Iterator<T>	iterator()
T	max()	Returns the maximum element out of this container based on the natural order.
T	max(java.util.Comparator<? super T> comparator)	Returns the maximum element out of this container based on the comparator.
<V extends java.lang.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(java.util.Comparator<? super T> comparator)	Returns the minimum element out of this container based on the comparator.
<V extends java.lang.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.
ImmutableSortedBag<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.
ImmutableSortedBag<T>	newWithAll(java.lang.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.
ImmutableSortedBag<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.
ImmutableSortedBag<T>	newWithoutAll(java.lang.Iterable<? extends T> elements)	This method is similar to the withoutAll method in MutableCollection with the difference that a new copy of this collection with the elements removed will be returned.
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.
int	occurrencesOf(java.lang.Object item)	The occurrences of a distinct item in the bag.
PartitionImmutableSortedBag<T>	partitionWhile(Predicate<? super T> predicate)	Returns a Partition of the initial elements that satisfy the Predicate and the remaining elements.
ImmutableSortedBag<T>	reject(Predicate<? super T> predicate)	Returns all elements of the source collection that return false when evaluating of the predicate.
<P> ImmutableSortedBag<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.
ImmutableSortedBag<T>	select(Predicate<? super T> predicate)	Returns all elements of the source collection that return true when evaluating the predicate.
ImmutableSortedBag<T>	selectByOccurrences(IntPredicate predicate)	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
<S> ImmutableSortedBag<S>	selectInstancesOf(java.lang.Class<S> clazz)	Returns all elements of the source collection that are instances of the Class clazz.
ImmutableSortedSet<T>	selectUnique()	Returns a set containing all elements of the bag that have exactly one occurrence.
<P> ImmutableSortedBag<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.
ImmutableSortedBag<T>	take(int count)	Returns the first count elements of the iterable or all the elements in the iterable if count is greater than the length of the iterable.
ImmutableSortedBag<T>	takeWhile(Predicate<? super T> predicate)	Returns the initial elements that satisfy the Predicate.
ImmutableSortedBag<T>	tap(Procedure<? super T> procedure)	Executes the Procedure for each element in the iterable and returns this.
MutableSortedMap<T,java.lang.Integer>	toMapOfItemToCount()	Converts the Bag to a Map of the Item type to its count as an Integer.
MutableStack<T>	toStack()	Converts the OrderedIterable to a mutable MutableStack implementation.
ImmutableSortedSet<Pair<T,java.lang.Integer>>	zipWithIndex()	Zips this RichIterable with its indices.

Methods inherited from class org.eclipse.collections.impl.bag.sorted.immutable.AbstractImmutableSortedBag

bottomOccurrences, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, detectLastIndex, flatCollect, partition, partitionWith, toImmutable, topOccurrences, toReversed, writeReplace, zip, zip

Methods inherited from class org.eclipse.collections.impl.bag.immutable.AbstractImmutableBagIterable

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

Methods inherited from class org.eclipse.collections.impl.bag.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, injectInto, injectIntoWith, occurrencesSortingBy, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toListWithOccurrences, toSet, toSortedBag, toSortedBag, toSortedList, toSortedSet, toSortedSet, toStringOfItemToCount

Methods inherited from class org.eclipse.collections.impl.AbstractRichIterable

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, asLazy, containsAll, containsAllArguments, containsAllIterable, countWith, detect, detectOptional, detectWith, detectWithIfNone, detectWithOptional, forEach, forEachWithIndex, groupByUniqueKey, into, isEmpty, noneSatisfy, noneSatisfyWith, toBiMap, toMap, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedMapBy, toSortedSetBy, toString, zipWithIndex

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.collections.api.bag.Bag

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

Methods inherited from interface java.util.Collection

containsAll, isEmpty, removeIf, toArray

Methods inherited from interface org.eclipse.collections.api.collection.ImmutableCollection

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

Methods inherited from interface org.eclipse.collections.api.bag.sorted.ImmutableSortedBag

flatCollectWith, selectDuplicates, toImmutableSortedBag

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

forEach

Methods inherited from interface org.eclipse.collections.api.ordered.OrderedIterable

forEachWithIndex, getFirstOptional, getLastOptional, indexOf, rejectWithIndex, selectWithIndex, zipWithIndex

Methods inherited from interface org.eclipse.collections.api.ordered.ReversibleIterable

asReversed, reverseForEach, reverseForEachWithIndex

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

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

Field Detail

INSTANCE

static final ImmutableSortedBag<?> INSTANCE

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

comparator

private final java.util.Comparator<? super T> comparator

Constructor Detail

ImmutableEmptySortedBag

private ImmutableEmptySortedBag()

ImmutableEmptySortedBag

ImmutableEmptySortedBag(java.util.Comparator<? super T> comparator)

Method Detail

newWith

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

Specified by:

newWith in interface ImmutableSortedBag<T>

newWithAll

public ImmutableSortedBag<T> newWithAll(java.lang.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 ImmutableCollection<T>

Specified by:

newWithAll in interface ImmutableSortedBag<T>

newWithout

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

Specified by:

newWithout in interface ImmutableSortedBag<T>

newWithoutAll

public ImmutableSortedBag<T> newWithoutAll(java.lang.Iterable<? extends T> elements)

Description copied from interface: ImmutableCollection

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

Specified by:

newWithoutAll in interface ImmutableCollection<T>

Specified by:

newWithoutAll in interface ImmutableSortedBag<T>

Overrides:

newWithoutAll in class AbstractImmutableSortedBag<T>

equals

public boolean equals(java.lang.Object other)

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 java.util.Collection<T>

Overrides:

equals in class java.lang.Object

See Also:

Map.equals(Object)

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 java.util.Collection<T>

Overrides:

hashCode in class java.lang.Object

See Also:

Map.hashCode()

forEachWithOccurrences

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

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>

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>

size

public int size()

Description copied from interface: RichIterable

Returns the number of items in this iterable.

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface RichIterable<T>

collect

public <V> ImmutableList<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 ImmutableCollection<T>

Specified by:

collect in interface ImmutableSortedBag<T>

Specified by:

collect in interface OrderedIterable<T>

Specified by:

collect in interface ReversibleIterable<T>

Specified by:

collect in interface RichIterable<T>

Specified by:

collect in interface SortedBag<T>

Overrides:

collect in class AbstractImmutableSortedBag<T>

select

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

Specified by:

select in interface ImmutableCollection<T>

Specified by:

select in interface ImmutableSortedBag<T>

Specified by:

select in interface OrderedIterable<T>

Specified by:

select in interface ReversibleIterable<T>

Specified by:

select in interface RichIterable<T>

Specified by:

select in interface SortedBag<T>

Specified by:

select in interface SortedIterable<T>

Overrides:

select in class AbstractImmutableSortedBag<T>

reject

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

Specified by:

reject in interface ImmutableCollection<T>

Specified by:

reject in interface ImmutableSortedBag<T>

Specified by:

reject in interface OrderedIterable<T>

Specified by:

reject in interface ReversibleIterable<T>

Specified by:

reject in interface RichIterable<T>

Specified by:

reject in interface SortedBag<T>

Specified by:

reject in interface SortedIterable<T>

Overrides:

reject in class AbstractImmutableSortedBag<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

selectWith

public <P> ImmutableSortedBag<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 ImmutableBagIterable<T>

Specified by:

selectWith in interface ImmutableCollection<T>

Specified by:

selectWith in interface ImmutableSortedBag<T>

Specified by:

selectWith in interface OrderedIterable<T>

Specified by:

selectWith in interface ReversibleIterable<T>

Specified by:

selectWith in interface RichIterable<T>

Specified by:

selectWith in interface SortedBag<T>

Specified by:

selectWith in interface SortedIterable<T>

Overrides:

selectWith in class AbstractImmutableSortedBag<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)

rejectWith

public <P> ImmutableSortedBag<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 ImmutableBagIterable<T>

Specified by:

rejectWith in interface ImmutableCollection<T>

Specified by:

rejectWith in interface ImmutableSortedBag<T>

Specified by:

rejectWith in interface OrderedIterable<T>

Specified by:

rejectWith in interface ReversibleIterable<T>

Specified by:

rejectWith in interface RichIterable<T>

Specified by:

rejectWith in interface SortedBag<T>

Specified by:

rejectWith in interface SortedIterable<T>

Overrides:

rejectWith in class AbstractImmutableSortedBag<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)

selectInstancesOf

public <S> ImmutableSortedBag<S> selectInstancesOf(java.lang.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 ImmutableBagIterable<T>

Specified by:

selectInstancesOf in interface ImmutableCollection<T>

Specified by:

selectInstancesOf in interface ImmutableSortedBag<T>

Specified by:

selectInstancesOf in interface OrderedIterable<T>

Specified by:

selectInstancesOf in interface ReversibleIterable<T>

Specified by:

selectInstancesOf in interface RichIterable<T>

Specified by:

selectInstancesOf in interface SortedBag<T>

Specified by:

selectInstancesOf in interface SortedIterable<T>

Overrides:

selectInstancesOf in class AbstractImmutableSortedBag<T>

groupBy

public <V> ImmutableSortedBagMultimap<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 ImmutableBagIterable<T>

Specified by:

groupBy in interface ImmutableCollection<T>

Specified by:

groupBy in interface ImmutableSortedBag<T>

Specified by:

groupBy in interface OrderedIterable<T>

Specified by:

groupBy in interface ReversibleIterable<T>

Specified by:

groupBy in interface RichIterable<T>

Specified by:

groupBy in interface SortedBag<T>

Specified by:

groupBy in interface SortedIterable<T>

Overrides:

groupBy in class AbstractImmutableSortedBag<T>

groupByEach

public <V> ImmutableSortedBagMultimap<V,T> groupByEach(Function<? super T,? extends java.lang.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 ImmutableBagIterable<T>

Specified by:

groupByEach in interface ImmutableCollection<T>

Specified by:

groupByEach in interface ImmutableSortedBag<T>

Specified by:

groupByEach in interface OrderedIterable<T>

Specified by:

groupByEach in interface ReversibleIterable<T>

Specified by:

groupByEach in interface RichIterable<T>

Specified by:

groupByEach in interface SortedBag<T>

Specified by:

groupByEach in interface SortedIterable<T>

Overrides:

groupByEach in class AbstractImmutableSortedBag<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 AbstractImmutableSortedBag<T>

See Also:

RichIterable.groupBy(Function)

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 interface java.util.Collection<T>

Specified by:

contains in interface RichIterable<T>

Overrides:

contains in class AbstractRichIterable<T>

tap

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

Specified by:

tap in interface ImmutableCollection<T>

Specified by:

tap in interface ImmutableSortedBag<T>

Specified by:

tap in interface OrderedIterable<T>

Specified by:

tap in interface ReversibleIterable<T>

Specified by:

tap in interface RichIterable<T>

Specified by:

tap in interface SortedBag<T>

Specified by:

tap in interface SortedIterable<T>

Overrides:

tap in class AbstractImmutableSortedBag<T>

See Also:

RichIterable.each(Procedure), RichIterable.forEach(Procedure)

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

Specified by:

countBy in interface ImmutableSortedBag<T>

Specified by:

countBy in interface RichIterable<T>

Overrides:

countBy in class AbstractImmutableSortedBag<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 ImmutableCollection<T>

Specified by:

countByWith in interface ImmutableSortedBag<T>

Specified by:

countByWith in interface RichIterable<T>

Overrides:

countByWith in class AbstractImmutableSortedBag<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 java.lang.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 ImmutableCollection<T>

Specified by:

countByEach in interface ImmutableSortedBag<T>

Specified by:

countByEach in interface RichIterable<T>

Overrides:

countByEach in class AbstractImmutableSortedBag<T>

Since:

10.0.0

countByEach

public <V,R extends MutableBagIterable<V>> R countByEach(Function<? super T,? extends java.lang.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

selectByOccurrences

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

Specified by:

selectByOccurrences in interface ImmutableSortedBag<T>

Specified by:

selectByOccurrences in interface SortedBag<T>

Overrides:

selectByOccurrences in class AbstractImmutableSortedBag<T>

corresponds

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

Description copied from interface: OrderedIterable

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

Specified by:

corresponds in interface OrderedIterable<T>

forEach

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

Description copied from interface: OrderedIterable

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

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

This code would output ted and mary's names.

Specified by:

forEach in interface OrderedIterable<T>

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(int fromIndex,
                             int toIndex,
                             ObjectIntProcedure<? super T> objectIntProcedure)

Description copied from interface: OrderedIterable

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

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

This code would output ted and mary's names.

Specified by:

forEachWithIndex in interface OrderedIterable<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>

occurrencesOf

public int occurrencesOf(java.lang.Object item)

Description copied from interface: Bag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface Bag<T>

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.lang.Iterable<T>

min

public T min(java.util.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(java.util.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 OrderedIterable<T>

Specified by:

min in interface RichIterable<T>

Specified by:

min in interface SortedBag<T>

Specified by:

min in interface SortedIterable<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 OrderedIterable<T>

Specified by:

max in interface RichIterable<T>

Specified by:

max in interface SortedBag<T>

Specified by:

max in interface SortedIterable<T>

Overrides:

max in class AbstractRichIterable<T>

minBy

public <V extends java.lang.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 java.lang.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>

comparator

public java.util.Comparator<? super T> comparator()

Description copied from interface: SortedBag

Returns the comparator used to order the elements in this bag, or null if this bag uses the natural ordering of its elements.

Specified by:

comparator in interface SortedBag<T>

Specified by:

comparator in interface SortedIterable<T>

zipWithIndex

public ImmutableSortedSet<Pair<T,java.lang.Integer>> zipWithIndex()

Description copied from interface: RichIterable

Zips this RichIterable with its indices.

Specified by:

zipWithIndex in interface Bag<T>

Specified by:

zipWithIndex in interface ImmutableBagIterable<T>

Specified by:

zipWithIndex in interface ImmutableCollection<T>

Specified by:

zipWithIndex in interface ImmutableSortedBag<T>

Specified by:

zipWithIndex in interface OrderedIterable<T>

Specified by:

zipWithIndex in interface ReversibleIterable<T>

Specified by:

zipWithIndex in interface RichIterable<T>

Specified by:

zipWithIndex in interface SortedBag<T>

Specified by:

zipWithIndex in interface SortedIterable<T>

Overrides:

zipWithIndex in class AbstractImmutableSortedBag<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)

collectWithIndex

public <V> ImmutableList<V> collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function)

Description copied from interface: OrderedIterable

Returns a new OrderedIterable using results obtained by applying the specified function to each element and its corresponding index.

Specified by:

collectWithIndex in interface ImmutableSortedBag<T>

Specified by:

collectWithIndex in interface OrderedIterable<T>

Specified by:

collectWithIndex in interface ReversibleIterable<T>

Specified by:

collectWithIndex in interface SortedBag<T>

Since:

9.1.

collectWithIndex

public <V,R extends java.util.Collection<V>> R collectWithIndex(ObjectIntToObjectFunction<? super T,? extends V> function,
                                                                      R target)

Description copied from interface: OrderedIterable

Adds elements to the target Collection using results obtained by applying the specified function to each element and its corresponding index.

Specified by:

collectWithIndex in interface OrderedIterable<T>

Since:

9.1.

collectWithOccurrences

public <V> ImmutableList<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 ImmutableBagIterable<T>

Specified by:

collectWithOccurrences in interface ImmutableSortedBag<T>

Specified by:

collectWithOccurrences in interface SortedBag<T>

Overrides:

collectWithOccurrences in class AbstractImmutableSortedBag<T>

partitionWhile

public PartitionImmutableSortedBag<T> partitionWhile(Predicate<? super T> predicate)

Description copied from interface: SortedIterable

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

Specified by:

partitionWhile in interface OrderedIterable<T>

Specified by:

partitionWhile in interface ReversibleIterable<T>

Specified by:

partitionWhile in interface SortedBag<T>

Specified by:

partitionWhile in interface SortedIterable<T>

distinct

public ImmutableSortedSet<T> distinct()

Description copied from interface: SortedIterable

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

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

Specified by:

distinct in interface ImmutableSortedBag<T>

Specified by:

distinct in interface OrderedIterable<T>

Specified by:

distinct in interface ReversibleIterable<T>

Specified by:

distinct in interface SortedBag<T>

Specified by:

distinct in interface SortedIterable<T>

Returns:

SortedIterable of distinct elements

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

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

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.

takeWhile

public ImmutableSortedBag<T> takeWhile(Predicate<? super T> predicate)

Description copied from interface: SortedIterable

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

Specified by:

takeWhile in interface ImmutableSortedBag<T>

Specified by:

takeWhile in interface OrderedIterable<T>

Specified by:

takeWhile in interface ReversibleIterable<T>

Specified by:

takeWhile in interface SortedBag<T>

Specified by:

takeWhile in interface SortedIterable<T>

dropWhile

public ImmutableSortedBag<T> dropWhile(Predicate<? super T> predicate)

Description copied from interface: SortedIterable

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

Specified by:

dropWhile in interface ImmutableSortedBag<T>

Specified by:

dropWhile in interface OrderedIterable<T>

Specified by:

dropWhile in interface ReversibleIterable<T>

Specified by:

dropWhile in interface SortedBag<T>

Specified by:

dropWhile in interface SortedIterable<T>

detectIndex

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

Description copied from interface: OrderedIterable

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

Specified by:

detectIndex in interface OrderedIterable<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>

toStack

public MutableStack<T> toStack()

Description copied from interface: OrderedIterable

Converts the OrderedIterable to a mutable MutableStack implementation.

Specified by:

toStack in interface OrderedIterable<T>

compareTo

public int compareTo(SortedBag<T> o)

Specified by:

compareTo in interface java.lang.Comparable<T>

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 AbstractImmutableSortedBag<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.

toMapOfItemToCount

public MutableSortedMap<T,java.lang.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>

Specified by:

toMapOfItemToCount in interface ImmutableSortedBag<T>

Specified by:

toMapOfItemToCount in interface SortedBag<T>

take

public ImmutableSortedBag<T> take(int count)

Description copied from interface: ReversibleIterable

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

Specified by:

take in interface ImmutableSortedBag<T>

Specified by:

take in interface ReversibleIterable<T>

Specified by:

take in interface SortedBag<T>

Parameters:

count - the number of items to take.

drop

public ImmutableSortedBag<T> drop(int count)

Description copied from interface: ReversibleIterable

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

Specified by:

drop in interface ImmutableSortedBag<T>

Specified by:

drop in interface ReversibleIterable<T>

Specified by:

drop in interface SortedBag<T>

Parameters:

count - the number of items to drop.

selectUnique

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

Specified by:

selectUnique in interface ImmutableSortedBag<T>

Specified by:

selectUnique in interface SortedBag<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.