Package org.eclipse.collections.api.bag.primitive

Interface BooleanBag

All Superinterfaces:

BooleanIterable, PrimitiveIterable

All Known Subinterfaces:

ImmutableBooleanBag, MutableBooleanBag

All Known Implementing Classes:

BooleanHashBag, SynchronizedBooleanBag, UnmodifiableBooleanBag

public interface BooleanBag
extends BooleanIterable

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

Since:

3.0.

Method Summary

Modifier and Type	Method	Description
ListIterable<BooleanIntPair>	bottomOccurrences(int count)	Returns the count least frequently occurring items.
<V> Bag<V>	collect(BooleanToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
boolean	equals(java.lang.Object o)	Follows the same general contract as Bag.equals(Object).
void	forEachWithOccurrences(BooleanIntProcedure procedure)	For each distinct item, with the number of occurrences, execute the specified procedure.
int	hashCode()	Follows the same general contract as Bag.hashCode().
int	occurrencesOf(boolean item)	The occurrences of a distinct item in the bag.
BooleanBag	reject(BooleanPredicate predicate)	Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.
BooleanBag	select(BooleanPredicate predicate)	Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.
BooleanBag	selectByOccurrences(IntPredicate predicate)	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
int	sizeDistinct()	The size of the Bag when counting only distinct elements.
default BooleanBag	tap(BooleanProcedure procedure)
ImmutableBooleanBag	toImmutable()	Returns an immutable copy of this bag.
ListIterable<BooleanIntPair>	topOccurrences(int count)	Returns the count most frequently occurring items.

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

allSatisfy, anySatisfy, asLazy, booleanIterator, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, count, detectIfNone, each, flatCollect, forEach, injectInto, noneSatisfy, reject, select, toArray, toBag, toList, toSet

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

appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size, toString

Method Detail

sizeDistinct

int sizeDistinct()

The size of the Bag when counting only distinct elements.

tap

default BooleanBag tap(BooleanProcedure procedure)

Specified by:

tap in interface BooleanIterable

Since:

9.0.

selectByOccurrences

BooleanBag selectByOccurrences(IntPredicate predicate)

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

Since:

8.0

topOccurrences

ListIterable<BooleanIntPair> topOccurrences(int count)

Returns the count most frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned.

Since:

8.0

bottomOccurrences

ListIterable<BooleanIntPair> bottomOccurrences(int count)

Returns the count least frequently occurring items. In the event of a tie, all of the items with the number of occurrences that match the occurrences of the last item will be returned.

Since:

8.0

occurrencesOf

int occurrencesOf(boolean item)

The occurrences of a distinct item in the bag.

forEachWithOccurrences

void forEachWithOccurrences(BooleanIntProcedure procedure)

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

select

BooleanBag select(BooleanPredicate predicate)

Description copied from interface: BooleanIterable

Returns a new BooleanIterable with all of the elements in the BooleanIterable that return true for the specified predicate.

Specified by:

select in interface BooleanIterable

reject

BooleanBag reject(BooleanPredicate predicate)

Description copied from interface: BooleanIterable

Returns a new BooleanIterable with all of the elements in the BooleanIterable that return false for the specified predicate.

Specified by:

reject in interface BooleanIterable

collect

<V> Bag<V> collect(BooleanToObjectFunction<? extends V> function)

Description copied from interface: BooleanIterable

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.

Specified by:

collect in interface BooleanIterable

equals

boolean equals(java.lang.Object o)

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

Overrides:

equals in class java.lang.Object

hashCode

int hashCode()

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

Overrides:

hashCode in class java.lang.Object

toImmutable

ImmutableBooleanBag toImmutable()

Returns an immutable copy of this bag. If the bag is immutable, it returns itself.