Top Description Methods
org.eclipse.collections.api.bag.primitive

public Interface CharBag

extends CharIterable
Known Direct Subinterfaces
org.eclipse.collections.api.bag.primitive.ImmutableCharBag, org.eclipse.collections.api.bag.primitive.MutableCharBag
Imports
java.util.StringJoiner, org.eclipse.collections.api.CharIterable, org.eclipse.collections.api.bag.Bag, org.eclipse.collections.api.block.function.primitive.CharToObjectFunction, org.eclipse.collections.api.block.predicate.primitive.IntPredicate, .CharPredicate, org.eclipse.collections.api.block.procedure.primitive.CharProcedure, .CharIntProcedure, org.eclipse.collections.api.list.ListIterable, org.eclipse.collections.api.tuple.primitive.CharIntPair, org.eclipse.collections.api.set.primitive.CharSet

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

Method Summary

Modifier and TypeMethod and Description
public ListIterable<CharIntPair>
bottomOccurrences(int count)

Returns the count least frequently occurring items.

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

Redeclares org.eclipse.collections.api.CharIterable.collect.

Returns a new collection with the results of applying the specified function on each element of the source collection.

public boolean
equals(Object o)

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

public void
forEachWithOccurrences(CharIntProcedure procedure)

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

public int
hashCode()

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

public int
occurrencesOf(char item)

The occurrences of a distinct item in the bag.

public CharBag
reject(CharPredicate predicate)

Redeclares org.eclipse.collections.api.CharIterable.reject.

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

public CharBag
select(CharPredicate predicate)

Redeclares org.eclipse.collections.api.CharIterable.select.

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

public CharBag
selectByOccurrences(IntPredicate predicate)

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

public default CharBag
selectDuplicates()

Returns all elements of the bag that have more than one occurrence.

public CharSet
selectUnique()

Returns all elements of the bag that have exactly one occurrence.

public int
sizeDistinct()

The size of the Bag when counting only distinct elements.

public default CharBag
public ImmutableCharBag
toImmutable()

Returns an immutable copy of this bag.

public ListIterable<CharIntPair>
topOccurrences(int count)

Returns the count most frequently occurring items.

public default String
Inherited from org.eclipse.collections.api.CharIterable:
allSatisfyanySatisfyasLazyaverageaverageIfEmptycharIteratorchunkcollectcollectBooleancollectBytecollectCharcollectDoublecollectFloatcollectIntcollectLongcollectShortcontainscontainsAllcontainsAllcontainsAnycontainsAnycontainsNonecontainsNonecountdetectIfNoneeachflatCollectforEachinjectIntoinjectIntoBooleaninjectIntoByteinjectIntoCharinjectIntoDoubleinjectIntoFloatinjectIntoIntinjectIntoLonginjectIntoShortmaxmaxIfEmptymedianmedianIfEmptyminminIfEmptynoneSatisfyreducereduceIfEmptyrejectselectsumsummaryStatisticstoArraytoArraytoBagtoListtoSettoSortedArraytoSortedListtoSortedListtoSortedListBytoSortedListBy

Method Detail

bottomOccurrencesback to summary
public 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
collectback to summary
public <V> Bag<V> collect(CharToObjectFunction<? extends V> function)

Redeclares org.eclipse.collections.api.CharIterable.collect.

Doc from org.eclipse.collections.api.CharIterable.collect.

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.

Annotations
@Override
equalsback to summary
public boolean equals(Object o)

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

Annotations
@Override
forEachWithOccurrencesback to summary
public void forEachWithOccurrences(CharIntProcedure procedure)

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

hashCodeback to summary
public int hashCode()

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

Annotations
@Override
occurrencesOfback to summary
public int occurrencesOf(char item)

The occurrences of a distinct item in the bag.

rejectback to summary
public CharBag reject(CharPredicate predicate)

Redeclares org.eclipse.collections.api.CharIterable.reject.

Doc from org.eclipse.collections.api.CharIterable.reject.

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

Annotations
@Override
selectback to summary
public CharBag select(CharPredicate predicate)

Redeclares org.eclipse.collections.api.CharIterable.select.

Doc from org.eclipse.collections.api.CharIterable.select.

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

Annotations
@Override
selectByOccurrencesback to summary
public CharBag selectByOccurrences(IntPredicate predicate)

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

Since
8.0
selectDuplicatesback to summary
public default CharBag selectDuplicates()

Returns all elements of the bag that have more than one occurrence.

Since
9.2
selectUniqueback to summary
public CharSet selectUnique()

Returns all elements of the bag that have exactly one occurrence.

Since
9.2
sizeDistinctback to summary
public int sizeDistinct()

The size of the Bag when counting only distinct elements.

tapback to summary
public default CharBag tap(CharProcedure procedure)

Overrides default org.eclipse.collections.api.CharIterable.tap.

Annotations
@Override
Since
9.0.
toImmutableback to summary
public ImmutableCharBag toImmutable()

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

topOccurrencesback to summary
public 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
toStringOfItemToCountback to summary
public default String toStringOfItemToCount()
Since
9.2