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

Class AbstractImmutableBagIterable<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>

All Implemented Interfaces:

java.lang.Iterable<T>, Bag<T>, ImmutableBagIterable<T>, ImmutableCollection<T>, InternalIterable<T>, RichIterable<T>

Direct Known Subclasses:

AbstractImmutableBag

public abstract class AbstractImmutableBagIterable<T>
extends AbstractBag<T>
implements ImmutableBagIterable<T>

Constructor Summary

Constructors

Constructor	Description
AbstractImmutableBagIterable()

Method Summary

Modifier and Type	Method	Description
boolean	add(T t)
boolean	addAll(java.util.Collection<? extends T> collection)
<K,V> ImmutableMap<K,V>	aggregateBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Function2<? super V,? super T,? extends V> nonMutatingAggregator)	Applies an aggregate function over the iterable grouping results into a map based on the specific groupBy function.
<K,V> ImmutableMap<K,V>	aggregateInPlaceBy(Function<? super T,? extends K> groupBy, Function0<? extends V> zeroValueFactory, Procedure2<? super V,? super T> mutatingAggregator)	Applies an aggregate procedure over the iterable grouping results into a Map based on the specific groupBy function.
java.util.Collection<T>	castToCollection()	This can be overridden in most implementations to just return this.
void	clear()
<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,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.
java.util.stream.Stream<T>	parallelStream()
boolean	remove(java.lang.Object o)
boolean	removeAll(java.util.Collection<?> collection)
boolean	retainAll(java.util.Collection<?> collection)
java.util.Spliterator<T>	spliterator()
java.util.stream.Stream<T>	stream()
<V> ImmutableObjectDoubleMap<V>	sumByDouble(Function<? super T,? extends V> groupBy, DoubleFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> ImmutableObjectDoubleMap<V>	sumByFloat(Function<? super T,? extends V> groupBy, FloatFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> ImmutableObjectLongMap<V>	sumByInt(Function<? super T,? extends V> groupBy, IntFunction<? super T> function)	Groups and sums the values using the two specified functions.
<V> ImmutableObjectLongMap<V>	sumByLong(Function<? super T,? extends V> groupBy, LongFunction<? super T> function)	Groups and sums the values using the two specified functions.

Methods inherited from class org.eclipse.collections.impl.bag.AbstractBag

collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, count, flatCollect, groupBy, groupByEach, injectInto, injectInto, injectInto, injectInto, injectInto, injectIntoWith, reject, rejectWith, select, selectWith, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toBag, toList, toSet, toSortedBag, toSortedBag, toSortedList, toSortedSet, toSortedSet, toStringOfItemToCount

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

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, asLazy, contains, containsAll, containsAllArguments, containsAllIterable, countWith, detect, detectOptional, detectWith, detectWithIfNone, detectWithOptional, forEach, forEachWith, forEachWithIndex, groupByUniqueKey, into, isEmpty, max, max, maxBy, min, min, minBy, noneSatisfy, noneSatisfyWith, toArray, toArray, toMap, toSortedBagBy, toSortedListBy, toSortedMap, toSortedMap, toSortedSetBy, toString, zip, zipWithIndex

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

bottomOccurrences, collectWithOccurrences, equals, forEachWithOccurrences, hashCode, occurrencesOf, reduceInPlace, reduceInPlace, sizeDistinct, summarizeDouble, summarizeFloat, summarizeInt, summarizeLong, toImmutable, topOccurrences, toStringOfItemToCount

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, iterator, removeIf, size, toArray, toArray

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

groupBy, groupByEach, partition, partitionWith, reject, rejectWith, select, selectByOccurrences, selectInstancesOf, selectWith, tap, toMapOfItemToCount, zipWithIndex

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

collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, flatCollect, groupByUniqueKey, newWith, newWithAll, newWithout, newWithoutAll, zip

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

forEach, forEach, forEachWith, forEachWithIndex

Methods inherited from interface java.lang.Iterable

iterator

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

allSatisfy, allSatisfyWith, anySatisfy, anySatisfyWith, appendString, appendString, appendString, asLazy, chunk, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectIf, collectInt, collectLong, collectShort, collectWith, contains, containsAll, containsAllArguments, containsAllIterable, count, countBy, countByWith, countWith, detect, detectIfNone, detectOptional, detectWith, detectWithIfNone, detectWithOptional, each, flatCollect, getFirst, getLast, getOnly, groupBy, groupByEach, groupByUniqueKey, injectInto, injectInto, injectInto, injectInto, injectInto, into, isEmpty, makeString, makeString, makeString, max, max, maxBy, maxByOptional, maxOptional, maxOptional, min, min, minBy, minByOptional, minOptional, minOptional, noneSatisfy, noneSatisfyWith, notEmpty, reduce, reject, rejectWith, select, selectWith, size, sumOfDouble, sumOfFloat, sumOfInt, sumOfLong, toArray, toArray, toBag, toList, toMap, toSet, toSortedBag, toSortedBag, toSortedBagBy, toSortedList, toSortedList, toSortedListBy, toSortedMap, toSortedMap, toSortedSet, toSortedSet, toSortedSetBy, toString, zip, zipWithIndex

Constructor Detail

AbstractImmutableBagIterable

public AbstractImmutableBagIterable()

Method Detail

aggregateInPlaceBy

public <K,V> ImmutableMap<K,V> aggregateInPlaceBy(Function<? super T,? extends K> groupBy,
                                                  Function0<? extends V> zeroValueFactory,
                                                  Procedure2<? super V,? super T> mutatingAggregator)

Description copied from interface: RichIterable

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

Specified by:

aggregateInPlaceBy in interface ImmutableCollection<T>

Specified by:

aggregateInPlaceBy in interface RichIterable<T>

aggregateBy

public <K,V> ImmutableMap<K,V> aggregateBy(Function<? super T,? extends K> groupBy,
                                           Function0<? extends V> zeroValueFactory,
                                           Function2<? super V,? super T,? extends V> nonMutatingAggregator)

Description copied from interface: RichIterable

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

Specified by:

aggregateBy in interface ImmutableCollection<T>

Specified by:

aggregateBy in interface RichIterable<T>

sumByInt

public <V> ImmutableObjectLongMap<V> sumByInt(Function<? super T,? extends V> groupBy,
                                              IntFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByInt in interface ImmutableCollection<T>

Specified by:

sumByInt in interface RichIterable<T>

sumByFloat

public <V> ImmutableObjectDoubleMap<V> sumByFloat(Function<? super T,? extends V> groupBy,
                                                  FloatFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByFloat in interface ImmutableCollection<T>

Specified by:

sumByFloat in interface RichIterable<T>

sumByLong

public <V> ImmutableObjectLongMap<V> sumByLong(Function<? super T,? extends V> groupBy,
                                               LongFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByLong in interface ImmutableCollection<T>

Specified by:

sumByLong in interface RichIterable<T>

sumByDouble

public <V> ImmutableObjectDoubleMap<V> sumByDouble(Function<? super T,? extends V> groupBy,
                                                   DoubleFunction<? super T> function)

Description copied from interface: RichIterable

Groups and sums the values using the two specified functions.

Specified by:

sumByDouble in interface ImmutableCollection<T>

Specified by:

sumByDouble in interface RichIterable<T>

add

public boolean add(T t)

remove

public boolean remove(java.lang.Object o)

addAll

public boolean addAll(java.util.Collection<? extends T> collection)

removeAll

public boolean removeAll(java.util.Collection<?> collection)

retainAll

public boolean retainAll(java.util.Collection<?> collection)

clear

public void clear()

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

Overrides:

countBy in class AbstractRichIterable<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 RichIterable<T>

Overrides:

countByWith in class AbstractRichIterable<T>

Since:

9.0

stream

public java.util.stream.Stream<T> stream()

Specified by:

stream in interface ImmutableCollection<T>

Since:

9.0

parallelStream

public java.util.stream.Stream<T> parallelStream()

Specified by:

parallelStream in interface ImmutableCollection<T>

Since:

9.0

spliterator

public java.util.Spliterator<T> spliterator()

Specified by:

spliterator in interface ImmutableCollection<T>

Specified by:

spliterator in interface java.lang.Iterable<T>

Since:

9.0

castToCollection

public java.util.Collection<T> castToCollection()

Description copied from interface: ImmutableCollection

This can be overridden in most implementations to just return this.

Specified by:

castToCollection in interface ImmutableCollection<T>

Since:

9.0