Class ImmutableCharHashBag
java.lang.Object
org.eclipse.collections.impl.bag.immutable.primitive.ImmutableCharHashBag
- All Implemented Interfaces:
Serializable
,CharBag
,ImmutableCharBag
,CharIterable
,ImmutableCharCollection
,PrimitiveIterable
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 ClassesModifier and TypeClassDescriptionprotected static class
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
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 givenAppendable
.void
appendString
(Appendable appendable, String separator) Prints a string representation of this collection onto the givenAppendable
.void
appendString
(Appendable appendable, String start, String separator, String end) Prints a string representation of this collection onto the givenAppendable
.asLazy()
Returns a LazyCharIterable adapter wrapping the source CharIterable.double
average()
bottomOccurrences
(int count) Returns thecount
least frequently occurring items.Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.private void
checkOptimizedSize
(int length) 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
Follows the same general contract asBag.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 asBag.hashCode()
.<T> T
injectInto
(T injectedValue, ObjectCharToObjectFunction<? super T, ? extends T> function) boolean
isEmpty()
Returns true if this iterable has zero items.Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String)
and defaulting the separator parameter to the characters", "
(comma and space).makeString
(String separator) Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String, String, String)
and defaulting the start and end parameters to""
(the empty 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) newWith
(char element) newWithAll
(CharIterable elements) newWithout
(char element) 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.reject
(CharPredicate predicate) Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.select
(CharPredicate predicate) Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.selectByOccurrences
(IntPredicate predicate) Returns all elements of the bag that have a number of occurrences that satisfy the predicate.Returns all elements of the bag that have exactly one occurrence.int
size()
Returns the number of items in this iterable.int
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.toBag()
Converts the CharIterable to a new MutableCharBag.Returns an immutable copy of this bag.toList()
Converts the CharIterable to a new MutableCharList.topOccurrences
(int count) Returns thecount
most frequently occurring items.toSet()
Converts the CharIterable to a new MutableCharSet.char[]
toString()
Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.private Object
Methods inherited from class java.lang.Object
clone, finalize, 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
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 org.eclipse.collections.api.bag.primitive.ImmutableCharBag
selectDuplicates, tap
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
delegate
-
-
Constructor Details
-
ImmutableCharHashBag
private ImmutableCharHashBag(char[] newElements)
-
-
Method Details
-
checkOptimizedSize
private void checkOptimizedSize(int length) -
newBagWith
-
newWith
- Specified by:
newWith
in interfaceImmutableCharBag
- Specified by:
newWith
in interfaceImmutableCharCollection
-
newWithout
- Specified by:
newWithout
in interfaceImmutableCharBag
- Specified by:
newWithout
in interfaceImmutableCharCollection
-
newWithAll
- Specified by:
newWithAll
in interfaceImmutableCharBag
- Specified by:
newWithAll
in interfaceImmutableCharCollection
-
newWithoutAll
- Specified by:
newWithoutAll
in interfaceImmutableCharBag
- Specified by:
newWithoutAll
in interfaceImmutableCharCollection
-
size
public int size()Description copied from interface:PrimitiveIterable
Returns the number of items in this iterable.- Specified by:
size
in interfacePrimitiveIterable
-
isEmpty
public boolean isEmpty()Description copied from interface:PrimitiveIterable
Returns true if this iterable has zero items.- Specified by:
isEmpty
in interfacePrimitiveIterable
-
notEmpty
public boolean notEmpty()Description copied from interface:PrimitiveIterable
The English equivalent of !this.isEmpty()- Specified by:
notEmpty
in interfacePrimitiveIterable
-
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 interfaceCharIterable
-
containsAll
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 interfaceCharIterable
-
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 interfaceCharIterable
-
each
Description copied from interface:CharIterable
A synonym for forEach.- Specified by:
each
in interfaceCharIterable
- Since:
- 7.0.
-
select
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 interfaceCharBag
- Specified by:
select
in interfaceCharIterable
- Specified by:
select
in interfaceImmutableCharBag
- Specified by:
select
in interfaceImmutableCharCollection
-
selectByOccurrences
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 interfaceCharBag
- Specified by:
selectByOccurrences
in interfaceImmutableCharBag
-
selectUnique
Description copied from interface:ImmutableCharBag
Returns all elements of the bag that have exactly one occurrence.- Specified by:
selectUnique
in interfaceCharBag
- Specified by:
selectUnique
in interfaceImmutableCharBag
-
topOccurrences
Description copied from interface:ImmutableCharBag
Returns thecount
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 interfaceCharBag
- Specified by:
topOccurrences
in interfaceImmutableCharBag
-
bottomOccurrences
Description copied from interface:ImmutableCharBag
Returns thecount
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 interfaceCharBag
- Specified by:
bottomOccurrences
in interfaceImmutableCharBag
-
reject
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 interfaceCharBag
- Specified by:
reject
in interfaceCharIterable
- Specified by:
reject
in interfaceImmutableCharBag
- Specified by:
reject
in interfaceImmutableCharCollection
-
collect
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 interfaceCharBag
- Specified by:
collect
in interfaceCharIterable
- Specified by:
collect
in interfaceImmutableCharBag
- Specified by:
collect
in interfaceImmutableCharCollection
-
toList
Description copied from interface:CharIterable
Converts the CharIterable to a new MutableCharList.- Specified by:
toList
in interfaceCharIterable
-
sizeDistinct
public int sizeDistinct()Description copied from interface:CharBag
The size of the Bag when counting only distinct elements.- Specified by:
sizeDistinct
in interfaceCharBag
-
occurrencesOf
public int occurrencesOf(char item) Description copied from interface:CharBag
The occurrences of a distinct item in the bag.- Specified by:
occurrencesOf
in interfaceCharBag
-
forEachWithOccurrences
Description copied from interface:CharBag
For each distinct item, with the number of occurrences, execute the specified procedure.- Specified by:
forEachWithOccurrences
in interfaceCharBag
-
detectIfNone
- Specified by:
detectIfNone
in interfaceCharIterable
-
count
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 interfaceCharIterable
-
anySatisfy
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 interfaceCharIterable
-
sum
public long sum()- Specified by:
sum
in interfaceCharIterable
-
min
public char min()- Specified by:
min
in interfaceCharIterable
-
max
public char max()- Specified by:
max
in interfaceCharIterable
-
maxIfEmpty
public char maxIfEmpty(char defaultValue) - Specified by:
maxIfEmpty
in interfaceCharIterable
-
minIfEmpty
public char minIfEmpty(char defaultValue) - Specified by:
minIfEmpty
in interfaceCharIterable
-
average
public double average()- Specified by:
average
in interfaceCharIterable
-
median
public double median()- Specified by:
median
in interfaceCharIterable
-
toSortedArray
public char[] toSortedArray()- Specified by:
toSortedArray
in interfaceCharIterable
-
toSortedList
- Specified by:
toSortedList
in interfaceCharIterable
-
noneSatisfy
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 interfaceCharIterable
-
allSatisfy
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 interfaceCharIterable
-
injectInto
public <T> T injectInto(T injectedValue, ObjectCharToObjectFunction<? super T, ? extends T> function) - Specified by:
injectInto
in interfaceCharIterable
-
chunk
Description copied from interface:CharIterable
Partitions elements in fixed size chunks.- Specified by:
chunk
in interfaceCharIterable
- Parameters:
size
- the number of elements per chunk- Returns:
- A
RichIterable
containingCharIterable
s of sizesize
, except the last will be truncated if the elements don't divide evenly.
-
equals
Description copied from interface:CharBag
Follows the same general contract asBag.equals(Object)
. -
hashCode
public int hashCode()Description copied from interface:CharBag
Follows the same general contract asBag.hashCode()
. -
toSet
Description copied from interface:CharIterable
Converts the CharIterable to a new MutableCharSet.- Specified by:
toSet
in interfaceCharIterable
-
toBag
Description copied from interface:CharIterable
Converts the CharIterable to a new MutableCharBag.- Specified by:
toBag
in interfaceCharIterable
-
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 interfaceCharBag
-
asLazy
Description copied from interface:CharIterable
Returns a LazyCharIterable adapter wrapping the source CharIterable.- Specified by:
asLazy
in interfaceCharIterable
-
toArray
public char[] toArray()Description copied from interface:CharIterable
Converts the CharIterable to a primitive char array.- Specified by:
toArray
in interfaceCharIterable
-
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 interfaceCharIterable
-
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 interfacePrimitiveIterable
- Overrides:
toString
in classObject
- Returns:
- a string representation of this PrimitiveIterable
- See Also:
-
makeString
Description copied from interface:PrimitiveIterable
Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String)
and defaulting the separator parameter to the characters", "
(comma and space).- Specified by:
makeString
in interfacePrimitiveIterable
- Returns:
- a string representation of this collection.
-
makeString
Description copied from interface:PrimitiveIterable
Returns a string representation of this collection by delegating toPrimitiveIterable.makeString(String, String, String)
and defaulting the start and end parameters to""
(the empty String).- Specified by:
makeString
in interfacePrimitiveIterable
- Returns:
- a string representation of this collection.
-
makeString
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 interfacePrimitiveIterable
- Returns:
- a string representation of this collection.
-
appendString
Description copied from interface:PrimitiveIterable
Prints a string representation of this collection onto the givenAppendable
. Prints the string returned byPrimitiveIterable.makeString()
.- Specified by:
appendString
in interfacePrimitiveIterable
-
appendString
Description copied from interface:PrimitiveIterable
Prints a string representation of this collection onto the givenAppendable
. Prints the string returned byPrimitiveIterable.makeString(String)
.- Specified by:
appendString
in interfacePrimitiveIterable
-
appendString
Description copied from interface:PrimitiveIterable
Prints a string representation of this collection onto the givenAppendable
. Prints the string returned byPrimitiveIterable.makeString(String, String, String)
.- Specified by:
appendString
in interfacePrimitiveIterable
-
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 interfaceCharIterable
-
writeReplace
-