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 and Description
ListIterable<BooleanIntPair>	bottomOccurrences(int count) Returns the count least frequently occurring items.
<V> Bag<V>	collect(BooleanToObjectFunction<? extends V> function)
boolean	equals(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)
BooleanBag	select(BooleanPredicate 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.
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, contains, containsAll, containsAll, count, detectIfNone, each, forEach, injectInto, noneSatisfy, 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.

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)

Specified by:

select in interface BooleanIterable

reject

BooleanBag reject(BooleanPredicate predicate)

Specified by:

reject in interface BooleanIterable

collect

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

Specified by:

collect in interface BooleanIterable

equals

boolean equals(Object o)

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

Overrides:

equals in class Object

hashCode

int hashCode()

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

Overrides:

hashCode in class Object

toImmutable

ImmutableBooleanBag toImmutable()

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