Class ImmutableCharHashBag

java.lang.Object

org.eclipse.collections.impl.bag.immutable.primitive.ImmutableCharHashBag

All Implemented Interfaces:

Serializable, CharBag, ImmutableCharBag, CharIterable, ImmutableCharCollection, PrimitiveIterable

final class ImmutableCharHashBag
extends Object
implements ImmutableCharBag, Serializable

ImmutableCharHashBag is the non-modifiable equivalent of CharHashBag. This file was automatically generated from template file immutablePrimitiveHashBag.stg.

Since:

4.0.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ImmutableCharHashBag.ImmutableCharBagSerializationProxy

Field Summary

Fields

Modifier and Type	Field	Description
private final MutableCharBag	delegate
private static final long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor	Description
private	ImmutableCharHashBag(char[] newElements)
private	ImmutableCharHashBag(MutableCharBag delegate)

Method Summary

Modifier and Type	Method	Description
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)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator)	Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyCharIterable	asLazy()	Returns a LazyCharIterable adapter wrapping the source CharIterable.
double	average()
ImmutableList<CharIntPair>	bottomOccurrences(int count)	Returns the count least frequently occurring items.
CharIterator	charIterator()	Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
private void	checkOptimizedSize(int length)
RichIterable<CharIterable>	chunk(int size)	Partitions elements in fixed size chunks.
<V> ImmutableBag<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.
boolean	containsAll(char... elements)	Returns true if all of the values specified in the source array are contained in the CharIterable, and false if they are not.
boolean	containsAll(CharIterable source)	Returns true if all of the values specified in the source CharIterable are contained in the CharIterable, and false if they are 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 obj)	Follows the same general contract as Bag.equals(Object).
void	forEachWithOccurrences(CharIntProcedure charIntProcedure)	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.
String	makeString()	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).
String	makeString(String separator)	Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).
String	makeString(String start, String separator, String end)	Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.
char	max()
char	maxIfEmpty(char defaultValue)
double	median()
char	min()
char	minIfEmpty(char defaultValue)
static ImmutableCharHashBag	newBagWith(char... elements)
static ImmutableCharHashBag	newBagWith(MutableCharBag elements)
ImmutableCharBag	newWith(char element)
ImmutableCharBag	newWithAll(CharIterable elements)
ImmutableCharBag	newWithout(char element)
ImmutableCharBag	newWithoutAll(CharIterable elements)
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.
ImmutableCharBag	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
ImmutableCharBag	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
ImmutableCharBag	selectByOccurrences(IntPredicate predicate)	Returns all elements of the bag that have a number of occurrences that satisfy the predicate.
ImmutableCharSet	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[] target)	Converts the CharIterable to a primitive char array.
MutableCharBag	toBag()	Converts the CharIterable to a new MutableCharBag.
ImmutableCharBag	toImmutable()	Returns an immutable copy of this bag.
MutableCharList	toList()	Converts the CharIterable to a new MutableCharList.
ImmutableList<CharIntPair>	topOccurrences(int count)	Returns the count most frequently occurring items.
MutableCharSet	toSet()	Converts the CharIterable to a new MutableCharSet.
char[]	toSortedArray()
MutableCharList	toSortedList()
String	toString()	Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.
private Object	writeReplace()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface CharBag

toStringOfItemToCount

Methods inherited from interface CharIterable

averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAny, containsAny, containsNone, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, medianIfEmpty, reduce, reduceIfEmpty, reject, select, summaryStatistics, toSortedList, toSortedListBy, toSortedListBy

Methods inherited from interface ImmutableCharBag

selectDuplicates, tap

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

delegate

private final MutableCharBag delegate

Constructor Details

ImmutableCharHashBag

private ImmutableCharHashBag(char[] newElements)

ImmutableCharHashBag

private ImmutableCharHashBag(MutableCharBag delegate)

Method Details

checkOptimizedSize

private void checkOptimizedSize(int length)

newBagWith

public static ImmutableCharHashBag newBagWith(char... elements)

newBagWith

public static ImmutableCharHashBag newBagWith(MutableCharBag elements)

newWith

public ImmutableCharBag newWith(char element)

Specified by:

newWith in interface ImmutableCharBag

Specified by:

newWith in interface ImmutableCharCollection

newWithout

public ImmutableCharBag newWithout(char element)

Specified by:

newWithout in interface ImmutableCharBag

Specified by:

newWithout in interface ImmutableCharCollection

newWithAll

public ImmutableCharBag newWithAll(CharIterable elements)

Specified by:

newWithAll in interface ImmutableCharBag

Specified by:

newWithAll in interface ImmutableCharCollection

newWithoutAll

public ImmutableCharBag newWithoutAll(CharIterable elements)

Specified by:

newWithoutAll in interface ImmutableCharBag

Specified by:

newWithoutAll in interface ImmutableCharCollection

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

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

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

containsAll

public boolean containsAll(CharIterable source)

Description copied from interface: CharIterable

Returns true if all of the values specified in the source CharIterable are contained in the CharIterable, and false if they are not.

Specified by:

containsAll in interface CharIterable

containsAll

public boolean containsAll(char... elements)

Description copied from interface: CharIterable

Returns true if all of the values specified in the source array are contained in the CharIterable, and false if they are not.

Specified by:

containsAll 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 ImmutableCharBag 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 ImmutableCharBag

Specified by:

select in interface ImmutableCharCollection

selectByOccurrences

public ImmutableCharBag selectByOccurrences(IntPredicate predicate)

Description copied from interface: ImmutableCharBag

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 ImmutableCharBag

selectUnique

public ImmutableCharSet selectUnique()

Description copied from interface: ImmutableCharBag

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

Specified by:

selectUnique in interface CharBag

Specified by:

selectUnique in interface ImmutableCharBag

topOccurrences

public ImmutableList<CharIntPair> topOccurrences(int count)

Description copied from interface: ImmutableCharBag

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 ImmutableCharBag

bottomOccurrences

public ImmutableList<CharIntPair> bottomOccurrences(int count)

Description copied from interface: ImmutableCharBag

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 ImmutableCharBag

reject

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

Specified by:

reject in interface ImmutableCharCollection

collect

public <V> ImmutableBag<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 ImmutableCharBag

Specified by:

collect in interface ImmutableCharCollection

toList

public MutableCharList toList()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharList.

Specified by:

toList in interface CharIterable

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 charIntProcedure)

Description copied from interface: CharBag

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

Specified by:

forEachWithOccurrences in interface CharBag

detectIfNone

public char detectIfNone(CharPredicate predicate,
 char ifNone)

Specified by:

detectIfNone in interface CharIterable

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

sum

public long sum()

Specified by:

sum in interface CharIterable

min

public char min()

Specified by:

min in interface CharIterable

max

public char max()

Specified by:

max in interface CharIterable

maxIfEmpty

public char maxIfEmpty(char defaultValue)

Specified by:

maxIfEmpty in interface CharIterable

minIfEmpty

public char minIfEmpty(char defaultValue)

Specified by:

minIfEmpty in interface CharIterable

average

public double average()

Specified by:

average in interface CharIterable

median

public double median()

Specified by:

median in interface CharIterable

toSortedArray

public char[] toSortedArray()

Specified by:

toSortedArray in interface CharIterable

toSortedList

public MutableCharList toSortedList()

Specified by:

toSortedList 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

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

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 obj)

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

toSet

public MutableCharSet toSet()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharSet.

Specified by:

toSet in interface CharIterable

toBag

public MutableCharBag toBag()

Description copied from interface: CharIterable

Converts the CharIterable to a new MutableCharBag.

Specified by:

toBag in interface CharIterable

toImmutable

public ImmutableCharBag toImmutable()

Description copied from interface: CharBag

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

Specified by:

toImmutable in interface CharBag

asLazy

public LazyCharIterable asLazy()

Description copied from interface: CharIterable

Returns a LazyCharIterable adapter wrapping the source CharIterable.

Specified by:

asLazy 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[] target)

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

toString

public String toString()

Description copied from interface: PrimitiveIterable

Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.

Assert.assertEquals("[]", IntLists.mutable.empty().toString());
Assert.assertEquals("[1]", IntLists.mutable.with(1).toString());
Assert.assertEquals("[1, 2, 3]", IntLists.mutable.with(1, 2, 3).toString());

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this PrimitiveIterable

See Also:

• AbstractCollection.toString()

makeString

public String makeString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String) and defaulting the separator parameter to the characters ", " (comma and space).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String separator)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection by delegating to PrimitiveIterable.makeString(String, String, String) and defaulting the start and end parameters to "" (the empty String).

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

makeString

public String makeString(String start,
 String separator,
 String end)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection with the elements separated by the specified separator and enclosed between the start and end strings.

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

appendString

public void appendString(Appendable appendable)

Description copied from interface: PrimitiveIterable

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

Specified by:

appendString in interface PrimitiveIterable

appendString

public void appendString(Appendable appendable,
 String separator)

Description copied from interface: PrimitiveIterable

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

Specified by:

appendString in interface PrimitiveIterable

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

charIterator

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

writeReplace

private Object writeReplace()