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

Interface CharBag

All Superinterfaces:

CharIterable, PrimitiveIterable

All Known Subinterfaces:

ImmutableCharBag, MutableCharBag

All Known Implementing Classes:

CharHashBag, SynchronizedCharBag, UnmodifiableCharBag

public interface CharBag
extends CharIterable

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

Since:

3.0.

Method Summary

Modifier and Type	Method	Description
ListIterable<CharIntPair>	bottomOccurrences(int count)	Returns the count least frequently occurring items.
<V> Bag<V>	collect(CharToObjectFunction<? extends V> function)	Returns a new collection with the results of applying the specified function on each element of the source collection.
boolean	equals(Object o)	Follows the same general contract as Bag.equals(Object).
void	forEachWithOccurrences(CharIntProcedure 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(char item)	The occurrences of a distinct item in the bag.
CharBag	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
CharBag	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
CharBag	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.
ImmutableCharBag	toImmutable()	Returns an immutable copy of this bag.
ListIterable<CharIntPair>	topOccurrences(int count)	Returns the count most frequently occurring items.

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

allSatisfy, anySatisfy, asLazy, average, charIterator, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, contains, containsAll, containsAll, count, detectIfNone, each, flatCollect, forEach, injectInto, max, maxIfEmpty, median, min, minIfEmpty, noneSatisfy, reject, select, sum, summaryStatistics, toArray, toBag, toList, toSet, toSortedArray, toSortedList

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

CharBag selectByOccurrences(IntPredicate predicate)

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

Since:

8.0

topOccurrences

ListIterable<CharIntPair> 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<CharIntPair> 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(char item)

The occurrences of a distinct item in the bag.

forEachWithOccurrences

void forEachWithOccurrences(CharIntProcedure procedure)

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

select

CharBag select(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

select in interface CharIterable

reject

CharBag reject(CharPredicate predicate)

Description copied from interface: CharIterable

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

Specified by:

reject in interface CharIterable

collect

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

Description copied from interface: CharIterable

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 CharIterable

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

ImmutableCharBag toImmutable()

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