Package org.eclipse.collections.impl.bag.mutable.primitive

Class UnmodifiableCharBag

java.lang.Object

org.eclipse.collections.impl.collection.mutable.primitive.AbstractUnmodifiableCharCollection

org.eclipse.collections.impl.bag.mutable.primitive.UnmodifiableCharBag

All Implemented Interfaces:

Serializable, CharBag, MutableCharBag, CharIterable, MutableCharCollection, PrimitiveIterable

public class UnmodifiableCharBag
extends AbstractUnmodifiableCharCollection
implements MutableCharBag

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

Since:

3.1.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
UnmodifiableCharBag(MutableCharBag bag)

Method Summary

Modifier and Type	Method	Description
void	addOccurrences(char item, int occurrences)
MutableCharBag	asSynchronized()
MutableCharBag	asUnmodifiable()
MutableList<CharIntPair>	bottomOccurrences(int count)	Returns the count least frequently occurring items.
<V> MutableBag<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 otherBag)	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().
MutableCharBag	newEmpty()	Creates a new empty mutable version of the same Bag type.
int	occurrencesOf(char item)	The occurrences of a distinct item in the bag.
MutableCharBag	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
boolean	removeOccurrences(char item, int occurrences)
MutableCharBag	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
MutableCharBag	selectByOccurrences(IntPredicate predicate)	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
MutableCharSet	selectUnique()	Returns all elements of the bag that have exactly one occurrence.
int	sizeDistinct()	The size of the Bag when counting only distinct elements.
ImmutableCharBag	toImmutable()	Returns an immutable copy of this bag.
MutableList<CharIntPair>	topOccurrences(int count)	Returns the count most frequently occurring items.
UnmodifiableCharBag	with(char element)
UnmodifiableCharBag	withAll(CharIterable elements)
UnmodifiableCharBag	without(char element)
UnmodifiableCharBag	withoutAll(CharIterable elements)

Methods inherited from class org.eclipse.collections.impl.collection.mutable.primitive.AbstractUnmodifiableCharCollection

add, addAll, addAll, allSatisfy, anySatisfy, appendString, appendString, appendString, asLazy, average, charIterator, chunk, clear, contains, containsAll, containsAll, count, detectIfNone, each, forEach, injectInto, isEmpty, makeString, makeString, makeString, max, maxIfEmpty, median, min, minIfEmpty, noneSatisfy, notEmpty, reduce, reduceIfEmpty, remove, removeAll, removeAll, removeIf, retainAll, retainAll, size, sum, toArray, toBag, toList, toSet, toSortedArray, toSortedList, toString

Methods inherited from interface org.eclipse.collections.api.bag.primitive.CharBag

toStringOfItemToCount

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

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

Methods inherited from interface org.eclipse.collections.api.bag.primitive.MutableCharBag

selectDuplicates, tap

Methods inherited from interface org.eclipse.collections.api.collection.primitive.MutableCharCollection

add, addAll, addAll, charIterator, clear, remove, removeAll, removeAll, removeIf, retainAll, retainAll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

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

Constructor Detail

UnmodifiableCharBag

public UnmodifiableCharBag(MutableCharBag bag)

Method Detail

with

public UnmodifiableCharBag with(char element)

Specified by:

with in interface MutableCharBag

Specified by:

with in interface MutableCharCollection

Overrides:

with in class AbstractUnmodifiableCharCollection

without

public UnmodifiableCharBag without(char element)

Specified by:

without in interface MutableCharBag

Specified by:

without in interface MutableCharCollection

Overrides:

without in class AbstractUnmodifiableCharCollection

withAll

public UnmodifiableCharBag withAll(CharIterable elements)

Specified by:

withAll in interface MutableCharBag

Specified by:

withAll in interface MutableCharCollection

Overrides:

withAll in class AbstractUnmodifiableCharCollection

withoutAll

public UnmodifiableCharBag withoutAll(CharIterable elements)

Specified by:

withoutAll in interface MutableCharBag

Specified by:

withoutAll in interface MutableCharCollection

Overrides:

withoutAll in class AbstractUnmodifiableCharCollection

addOccurrences

public void addOccurrences(char item,
                           int occurrences)

Specified by:

addOccurrences in interface MutableCharBag

removeOccurrences

public boolean removeOccurrences(char item,
                                 int occurrences)

Specified by:

removeOccurrences in interface MutableCharBag

sizeDistinct

public int sizeDistinct()

Description copied from interface: CharBag

The size of the Bag when counting only distinct elements.

Specified by:

sizeDistinct in interface CharBag

occurrencesOf

public int occurrencesOf(char item)

Description copied from interface: CharBag

The occurrences of a distinct item in the bag.

Specified by:

occurrencesOf in interface CharBag

forEachWithOccurrences

public void forEachWithOccurrences(CharIntProcedure procedure)

Description copied from interface: CharBag

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

Specified by:

forEachWithOccurrences in interface CharBag

selectByOccurrences

public MutableCharBag selectByOccurrences(IntPredicate predicate)

Description copied from interface: MutableCharBag

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

Specified by:

selectByOccurrences in interface CharBag

Specified by:

selectByOccurrences in interface MutableCharBag

selectUnique

public MutableCharSet selectUnique()

Description copied from interface: MutableCharBag

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

Specified by:

selectUnique in interface CharBag

Specified by:

selectUnique in interface MutableCharBag

topOccurrences

public MutableList<CharIntPair> topOccurrences(int count)

Description copied from interface: MutableCharBag

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.

Specified by:

topOccurrences in interface CharBag

Specified by:

topOccurrences in interface MutableCharBag

bottomOccurrences

public MutableList<CharIntPair> bottomOccurrences(int count)

Description copied from interface: MutableCharBag

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.

Specified by:

bottomOccurrences in interface CharBag

Specified by:

bottomOccurrences in interface MutableCharBag

select

public MutableCharBag 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 CharBag

Specified by:

select in interface CharIterable

Specified by:

select in interface MutableCharBag

Specified by:

select in interface MutableCharCollection

Overrides:

select in class AbstractUnmodifiableCharCollection

reject

public MutableCharBag 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 CharBag

Specified by:

reject in interface CharIterable

Specified by:

reject in interface MutableCharBag

Specified by:

reject in interface MutableCharCollection

Overrides:

reject in class AbstractUnmodifiableCharCollection

collect

public <V> MutableBag<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 CharBag

Specified by:

collect in interface CharIterable

Specified by:

collect in interface MutableCharBag

Specified by:

collect in interface MutableCharCollection

Overrides:

collect in class AbstractUnmodifiableCharCollection

equals

public boolean equals(Object otherBag)

Description copied from interface: CharBag

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

Specified by:

equals in interface CharBag

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: CharBag

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

Specified by:

hashCode in interface CharBag

Overrides:

hashCode in class Object

asUnmodifiable

public MutableCharBag asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableCharBag

Specified by:

asUnmodifiable in interface MutableCharCollection

Overrides:

asUnmodifiable in class AbstractUnmodifiableCharCollection

asSynchronized

public MutableCharBag asSynchronized()

Specified by:

asSynchronized in interface MutableCharBag

Specified by:

asSynchronized in interface MutableCharCollection

Overrides:

asSynchronized in class AbstractUnmodifiableCharCollection

toImmutable

public ImmutableCharBag toImmutable()

Description copied from interface: MutableCharBag

Returns an immutable copy of this bag.

Specified by:

toImmutable in interface CharBag

Specified by:

toImmutable in interface MutableCharBag

Specified by:

toImmutable in interface MutableCharCollection

Overrides:

toImmutable in class AbstractUnmodifiableCharCollection

newEmpty

public MutableCharBag newEmpty()

Description copied from interface: MutableCharBag

Creates a new empty mutable version of the same Bag type.

Specified by:

newEmpty in interface MutableCharBag

Specified by:

newEmpty in interface MutableCharCollection

Since:

9.2.