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

Class CharHashBag

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractCharIterable

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

All Implemented Interfaces:

Externalizable, Serializable, CharBag, MutableCharBag, CharIterable, MutableCharCollection, PrimitiveIterable

public class CharHashBag
extends AbstractCharIterable
implements MutableCharBag, Externalizable

CharHashBag is similar to HashBag, and is memory-optimized for char primitives. This file was automatically generated from template file primitiveHashBag.stg.

Since:

3.0.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CharHashBag()
CharHashBag(char... elements)
CharHashBag(int size)
CharHashBag(CharIterable iterable)
CharHashBag(CharHashBag bag)

Method Summary

Modifier and Type	Method	Description
boolean	add(char item)
boolean	addAll(char... source)
boolean	addAll(CharIterable source)
void	addOccurrences(char item, int occurrences)
boolean	allSatisfy(CharPredicate predicate)	Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
boolean	anySatisfy(CharPredicate predicate)	Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
MutableCharBag	asSynchronized()
MutableCharBag	asUnmodifiable()
MutableList<CharIntPair>	bottomOccurrences(int count)	Returns the count least frequently occurring items.
MutableCharIterator	charIterator()	Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
RichIterable<CharIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<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	contains(char value)	Returns true if the value is contained in the CharIterable, and false if it is not.
int	count(CharPredicate predicate)	Returns a count of the number of elements in the CharIterable that return true for the specified predicate.
char	detectIfNone(CharPredicate predicate, char ifNone)
void	each(CharProcedure procedure)	A synonym for forEach.
boolean	equals(Object otherBag)	Follows the same general contract as Bag.equals(Object).
void	forEach(CharProcedure procedure)	Applies the CharProcedure to each element in the CharIterable.
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().
<T> T	injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)
boolean	isEmpty()	Returns true if this iterable has zero items.
char	max()
char	min()
static CharHashBag	newBag(int size)
static CharHashBag	newBag(CharBag source)
static CharHashBag	newBag(CharIterable source)
static CharHashBag	newBagWith(char... source)
CharHashBag	newEmpty()	Creates a new empty CharHashBag.
boolean	noneSatisfy(CharPredicate predicate)	Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
boolean	notEmpty()	The English equivalent of !this.isEmpty()
int	occurrencesOf(char item)	The occurrences of a distinct item in the bag.
void	readExternal(ObjectInput in)
CharHashBag	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
boolean	remove(char item)
boolean	removeAll(char... source)
boolean	removeAll(CharIterable source)
boolean	removeIf(CharPredicate predicate)
boolean	removeOccurrences(char item, int occurrences)
boolean	retainAll(char... source)
boolean	retainAll(CharIterable source)
CharHashBag	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
CharHashBag	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	size()	Returns the number of items in this iterable.
int	sizeDistinct()	The size of the Bag when counting only distinct elements.
long	sum()
char[]	toArray()	Converts the CharIterable to a primitive char array.
char[]	toArray(char[] array)	Converts the CharIterable to a primitive char array.
ImmutableCharBag	toImmutable()	Returns an immutable copy of this bag.
MutableList<CharIntPair>	topOccurrences(int count)	Returns the count most frequently occurring items.
CharHashBag	with(char element)
CharHashBag	with(char element1, char element2)
CharHashBag	with(char element1, char element2, char element3)
CharHashBag	withAll(CharIterable iterable)
CharHashBag	without(char element)
CharHashBag	withoutAll(CharIterable iterable)
void	writeExternal(ObjectOutput out)

Methods inherited from class org.eclipse.collections.impl.primitive.AbstractCharIterable

asLazy, average, containsAll, containsAll, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

toStringOfItemToCount

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

asLazy, average, averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, containsAll, flatCollect, maxIfEmpty, median, medianIfEmpty, minIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics, 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.PrimitiveIterable

appendString, appendString, makeString, makeString, makeString, toString

Constructor Details

CharHashBag

public CharHashBag()

CharHashBag

public CharHashBag(int size)

CharHashBag

public CharHashBag(CharIterable iterable)

CharHashBag

public CharHashBag(char... elements)

CharHashBag

public CharHashBag(CharHashBag bag)

Method Details

newBag

public static CharHashBag newBag(int size)

newBagWith

public static CharHashBag newBagWith(char... source)

newBag

public static CharHashBag newBag(CharIterable source)

newBag

public static CharHashBag newBag(CharBag source)

isEmpty

public boolean isEmpty()

Description copied from interface: PrimitiveIterable

Returns true if this iterable has zero items.

Specified by:

isEmpty in interface PrimitiveIterable

notEmpty

public boolean notEmpty()

Description copied from interface: PrimitiveIterable

The English equivalent of !this.isEmpty()

Specified by:

notEmpty in interface PrimitiveIterable

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

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

clear

public void clear()

Specified by:

clear in interface MutableCharCollection

with

public CharHashBag with(char element)

Specified by:

with in interface MutableCharBag

Specified by:

with in interface MutableCharCollection

with

public CharHashBag with(char element1, char element2)

with

public CharHashBag with(char element1, char element2, char element3)

withAll

public CharHashBag withAll(CharIterable iterable)

Specified by:

withAll in interface MutableCharBag

Specified by:

withAll in interface MutableCharCollection

without

public CharHashBag without(char element)

Specified by:

without in interface MutableCharBag

Specified by:

without in interface MutableCharCollection

withoutAll

public CharHashBag withoutAll(CharIterable iterable)

Specified by:

withoutAll in interface MutableCharBag

Specified by:

withoutAll in interface MutableCharCollection

contains

public boolean contains(char value)

Description copied from interface: CharIterable

Returns true if the value is contained in the CharIterable, and false if it is not.

Specified by:

contains in interface CharIterable

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 CharHashBag 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

add

public boolean add(char item)

Specified by:

add in interface MutableCharCollection

remove

public boolean remove(char item)

Specified by:

remove in interface MutableCharCollection

removeIf

public boolean removeIf(CharPredicate predicate)

Specified by:

removeIf in interface MutableCharCollection

addAll

public boolean addAll(char... source)

Specified by:

addAll in interface MutableCharCollection

addAll

public boolean addAll(CharIterable source)

Specified by:

addAll in interface MutableCharCollection

removeAll

public boolean removeAll(char... source)

Specified by:

removeAll in interface MutableCharCollection

removeAll

public boolean removeAll(CharIterable source)

Specified by:

removeAll in interface MutableCharCollection

retainAll

public boolean retainAll(CharIterable source)

Specified by:

retainAll in interface MutableCharCollection

See Also:

Collection.retainAll(Collection)

retainAll

public boolean retainAll(char... source)

Specified by:

retainAll in interface MutableCharCollection

See Also:

Collection.retainAll(Collection)

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

forEach

public void forEach(CharProcedure procedure)

Description copied from interface: CharIterable

Applies the CharProcedure to each element in the CharIterable.

Specified by:

forEach in interface CharIterable

each

public void each(CharProcedure procedure)

Description copied from interface: CharIterable

A synonym for forEach.

Specified by:

each in interface CharIterable

Since:

7.0.

select

public CharHashBag 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

reject

public CharHashBag 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

injectInto

public <T> T injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)

Specified by:

injectInto in interface CharIterable

chunk

public RichIterable<CharIterable> chunk(int size)

Description copied from interface: CharIterable

Partitions elements in fixed size chunks.

Specified by:

chunk in interface CharIterable

Parameters:

size - the number of elements per chunk

Returns:

A RichIterable containing CharIterables of size size, except the last will be truncated if the elements don't divide evenly.

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

appendString

public void appendString(Appendable appendable, String start, String separator, String end)

Description copied from interface: PrimitiveIterable

Prints a string representation of this collection onto the given Appendable. Prints the string returned by PrimitiveIterable.makeString(String, String, String).

Specified by:

appendString in interface PrimitiveIterable

count

public int count(CharPredicate predicate)

Description copied from interface: CharIterable

Returns a count of the number of elements in the CharIterable that return true for the specified predicate.

Specified by:

count in interface CharIterable

anySatisfy

public boolean anySatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

Specified by:

anySatisfy in interface CharIterable

allSatisfy

public boolean allSatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

Specified by:

allSatisfy in interface CharIterable

noneSatisfy

public boolean noneSatisfy(CharPredicate predicate)

Description copied from interface: CharIterable

Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

Specified by:

noneSatisfy in interface CharIterable

detectIfNone

public char detectIfNone(CharPredicate predicate, char ifNone)

Specified by:

detectIfNone in interface CharIterable

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

max

public char max()

Specified by:

max in interface CharIterable

min

public char min()

Specified by:

min in interface CharIterable

sum

public long sum()

Specified by:

sum in interface CharIterable

toArray

public char[] toArray()

Description copied from interface: CharIterable

Converts the CharIterable to a primitive char array.

Specified by:

toArray in interface CharIterable

toArray

public char[] toArray(char[] array)

Description copied from interface: CharIterable

Converts the CharIterable to a primitive char array. If the collection fits into the provided array it is used to store its elements and is returned from the method, otherwise a new array of the appropriate size is allocated and returned. If the iterable is empty, the target array is returned unchanged.

Specified by:

toArray in interface CharIterable

asUnmodifiable

public MutableCharBag asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableCharBag

Specified by:

asUnmodifiable in interface MutableCharCollection

asSynchronized

public MutableCharBag asSynchronized()

Specified by:

asSynchronized in interface MutableCharBag

Specified by:

asSynchronized in interface MutableCharCollection

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

newEmpty

public CharHashBag newEmpty()

Creates a new empty CharHashBag.

Specified by:

newEmpty in interface MutableCharBag

Specified by:

newEmpty in interface MutableCharCollection

Since:

9.2.

charIterator

public MutableCharIterator charIterator()

Description copied from interface: CharIterable

Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.

Specified by:

charIterator in interface CharIterable

Specified by:

charIterator in interface MutableCharCollection

writeExternal

public void writeExternal(ObjectOutput out) throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in) throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException