CharIterable (Eclipse Collections API

All Superinterfaces:

PrimitiveIterable

All Known Subinterfaces:

ByteCharMap, CharBag, CharCharMap, CharList, CharSet, CharStack, CharValuesMap, DoubleCharMap, FloatCharMap, ImmutableByteCharMap, ImmutableCharBag, ImmutableCharCharMap, ImmutableCharCollection, ImmutableCharList, ImmutableCharSet, ImmutableCharStack, ImmutableDoubleCharMap, ImmutableFloatCharMap, ImmutableIntCharMap, ImmutableLongCharMap, ImmutableObjectCharMap<K>, ImmutableShortCharMap, IntCharMap, LazyCharIterable, LongCharMap, MutableByteCharMap, MutableCharBag, MutableCharCharMap, MutableCharCollection, MutableCharList, MutableCharSet, MutableCharStack, MutableCharValuesMap, MutableDoubleCharMap, MutableFloatCharMap, MutableIntCharMap, MutableLongCharMap, MutableObjectCharMap<K>, MutableShortCharMap, ObjectCharMap<K>, OrderedCharIterable, ReversibleCharIterable, ShortCharMap
```
public interface CharIterable
extends PrimitiveIterable
```
CharIterable is an interface which is memory-optimized for char primitives. It is inspired by the interface RichIterable, and contains a subset of the internal iterator methods on RichIterable like collect, sum, etc. The API also includes an external iterator method, which returns an CharIterator. CharIterator helps iterate over the CharIterable without boxing the primitives. This file was automatically generated from template file primitiveIterable.stg.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and 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.
`LazyCharIterable`	`asLazy()` Returns a LazyCharIterable adapter wrapping the source CharIterable.
`double`	`average()`
`default double`	`averageIfEmpty(double defaultValue)`
`CharIterator`	`charIterator()` Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
`default RichIterable<CharIterable>`	`chunk(int size)` Partitions elements in fixed size chunks.
`<V> RichIterable<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.
`default <V,R extends Collection<V>> R`	`collect(CharToObjectFunction<? extends V> function, R target)` Same as `collect(CharToObjectFunction)` , only the results are added to the target Collection.
`default <R extends MutableBooleanCollection> R`	`collectBoolean(CharToBooleanFunction function, R target)` Returns the target `MutableBooleanCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableByteCollection> R`	`collectByte(CharToByteFunction function, R target)` Returns the target `MutableByteCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableCharCollection> R`	`collectChar(CharToCharFunction function, R target)` Returns the target `MutableCharCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableDoubleCollection> R`	`collectDouble(CharToDoubleFunction function, R target)` Returns the target `MutableDoubleCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableFloatCollection> R`	`collectFloat(CharToFloatFunction function, R target)` Returns the target `MutableFloatCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableIntCollection> R`	`collectInt(CharToIntFunction function, R target)` Returns the target `MutableIntCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableLongCollection> R`	`collectLong(CharToLongFunction function, R target)` Returns the target `MutableLongCollection` with the results of applying the specified function on each element of the source collection.
`default <R extends MutableShortCollection> R`	`collectShort(CharToShortFunction function, R target)` Returns the target `MutableShortCollection` 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.
`default boolean`	`containsAll(char... source)` Returns true if all of the values specified in the source array are contained in the CharIterable, and false if they are not.
`default 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.
`default boolean`	`containsAny(char... source)` Returns true if any of the values specified in the source array are contained in the CharIterable, and false if they are not.
`default boolean`	`containsAny(CharIterable source)` Returns true if any of the values specified in the source CharIterable are contained in the CharIterable, and false if they are not.
`default boolean`	`containsNone(char... source)` Returns true if none of the values specified in the source array are contained in the CharIterable, and false if they are.
`default boolean`	`containsNone(CharIterable source)` Returns true if none of the values specified in the source CharIterable are contained in the CharIterable, and false if they are.
`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.
`default <V,R extends Collection<V>> R`	`flatCollect(CharToObjectFunction<? extends Iterable<V>> function, R target)` `flatCollect` is a special case of `collect(CharToObjectFunction)`.
`default void`	`forEach(CharProcedure procedure)` Applies the CharProcedure to each element in the CharIterable.
`<T> T`	`injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)`
`default boolean`	`injectIntoBoolean(boolean injectedValue, BooleanCharToBooleanFunction function)` Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`default byte`	`injectIntoByte(byte injectedValue, ByteCharToByteFunction function)` Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`default char`	`injectIntoChar(char injectedValue, CharCharToCharFunction function)` Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`default double`	`injectIntoDouble(double injectedValue, DoubleCharToDoubleFunction function)` Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`default float`	`injectIntoFloat(float injectedValue, FloatCharToFloatFunction function)` Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`default int`	`injectIntoInt(int injectedValue, IntCharToIntFunction function)` Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`default long`	`injectIntoLong(long injectedValue, LongCharToLongFunction function)` Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`default short`	`injectIntoShort(short injectedValue, ShortCharToShortFunction function)` Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters.
`char`	`max()`
`char`	`maxIfEmpty(char defaultValue)`
`double`	`median()`
`default double`	`medianIfEmpty(double defaultValue)`
`char`	`min()`
`char`	`minIfEmpty(char defaultValue)`
`default boolean`	`noneSatisfy(CharPredicate predicate)` Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
`default long`	`reduce(LongCharToLongFunction accumulator)`
`default long`	`reduceIfEmpty(LongCharToLongFunction accumulator, long defaultValue)`
`CharIterable`	`reject(CharPredicate predicate)` Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
`default <R extends MutableCharCollection> R`	`reject(CharPredicate predicate, R target)` Same as `reject(CharPredicate)` , only the results are added to the target MutableCharCollection.
`CharIterable`	`select(CharPredicate predicate)` Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
`default <R extends MutableCharCollection> R`	`select(CharPredicate predicate, R target)` Same as `select(CharPredicate)` , only the results are added to the target MutableCharCollection.
`long`	`sum()`
`default IntSummaryStatistics`	`summaryStatistics()`
`default CharIterable`	`tap(CharProcedure procedure)`
`char[]`	`toArray()` Converts the CharIterable to a primitive char array.
`default char[]`	`toArray(char[] target)` Converts the CharIterable to a primitive char array.
`MutableCharBag`	`toBag()` Converts the CharIterable to a new MutableCharBag.
`MutableCharList`	`toList()` Converts the CharIterable to a new MutableCharList.
`MutableCharSet`	`toSet()` Converts the CharIterable to a new MutableCharSet.
`char[]`	`toSortedArray()`
`MutableCharList`	`toSortedList()`
`default MutableCharList`	`toSortedList(CharComparator comparator)` Converts the collection to a MutableCharList implementation sorted using the provided comparator.
`default <T> MutableCharList`	`toSortedListBy(CharToObjectFunction<T> function)` Converts the collection to a MutableCharListImplementation sorted based on the natural order of the key returned by `function`.
`default <T> MutableCharList`	`toSortedListBy(CharToObjectFunction<T> function, Comparator<? super T> comparator)` Converts the collection to a MutableCharList implementation, which is sorted based on the key returned by `function` using the provided `comparator`.

Methods inherited from interface org.eclipse.collections.api.PrimitiveIterable
appendString, appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, size, toString

- Method Detail
  - charIterator
```
CharIterator charIterator()
```
    Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
  - toArray
```
char[] toArray()
```
    Converts the CharIterable to a primitive char array.
  - toArray
```
default char[] toArray(char[] target)
```
    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.
  - contains
```
boolean contains(char value)
```
    Returns true if the value is contained in the CharIterable, and false if it is not.
  - containsAll
```
default boolean containsAll(char... source)
```
    Returns true if all of the values specified in the source array are contained in the CharIterable, and false if they are not.
  - containsAll
```
default 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.
  - containsAny
```
default boolean containsAny(char... source)
```
    Returns true if any of the values specified in the source array are contained in the CharIterable, and false if they are not.
    
    Since:
    
    11.0
  - containsAny
```
default boolean containsAny(CharIterable source)
```
    Returns true if any of the values specified in the source CharIterable are contained in the CharIterable, and false if they are not.
    
    Since:
    
    11.0
  - containsNone
```
default boolean containsNone(char... source)
```
    Returns true if none of the values specified in the source array are contained in the CharIterable, and false if they are.
    
    Since:
    
    11.0
  - containsNone
```
default boolean containsNone(CharIterable source)
```
    Returns true if none of the values specified in the source CharIterable are contained in the CharIterable, and false if they are.
    
    Since:
    
    11.0
  - forEach
```
default void forEach(CharProcedure procedure)
```
    Applies the CharProcedure to each element in the CharIterable.
  - each
```
void each(CharProcedure procedure)
```
    A synonym for forEach.
    
    Since:
    
    7.0.
  - tap
```
default CharIterable tap(CharProcedure procedure)
```
    Since:
    
    9.0.
  - select
```
CharIterable select(CharPredicate predicate)
```
    Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
  - reject
```
CharIterable reject(CharPredicate predicate)
```
    Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
  - select
```
default <R extends MutableCharCollection> R select(CharPredicate predicate,
                                                   R target)
```
    Same as select(CharPredicate) , only the results are added to the target MutableCharCollection.
    
    Since:
    
    8.1.
  - reject
```
default <R extends MutableCharCollection> R reject(CharPredicate predicate,
                                                   R target)
```
    Same as reject(CharPredicate) , only the results are added to the target MutableCharCollection.
    
    Since:
    
    8.1.
  - collect
```
<V> RichIterable<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. This method is also commonly called transform or map.
  - collect
```
default <V,R extends Collection<V>> R collect(CharToObjectFunction<? extends V> function,
                                              R target)
```
    Same as collect(CharToObjectFunction) , only the results are added to the target Collection.
    
    Since:
    
    8.1.
  - flatCollect
```
default <V,R extends Collection<V>> R flatCollect(CharToObjectFunction<? extends Iterable<V>> function,
                                                  R target)
```
    flatCollect is a special case of collect(CharToObjectFunction). With collect, when the CharToObjectFunction returns a collection, the result is a collection of collections. flatCollect outputs a single "flattened" collection instead. This method is commonly called flatMap.
    
    Since:
    
    8.1.
  - collectBoolean
```
default <R extends MutableBooleanCollection> R collectBoolean(CharToBooleanFunction function,
                                                              R target)
```
    Returns the target MutableBooleanCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectByte
```
default <R extends MutableByteCollection> R collectByte(CharToByteFunction function,
                                                        R target)
```
    Returns the target MutableByteCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectChar
```
default <R extends MutableCharCollection> R collectChar(CharToCharFunction function,
                                                        R target)
```
    Returns the target MutableCharCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectShort
```
default <R extends MutableShortCollection> R collectShort(CharToShortFunction function,
                                                          R target)
```
    Returns the target MutableShortCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectInt
```
default <R extends MutableIntCollection> R collectInt(CharToIntFunction function,
                                                      R target)
```
    Returns the target MutableIntCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectFloat
```
default <R extends MutableFloatCollection> R collectFloat(CharToFloatFunction function,
                                                          R target)
```
    Returns the target MutableFloatCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectLong
```
default <R extends MutableLongCollection> R collectLong(CharToLongFunction function,
                                                        R target)
```
    Returns the target MutableLongCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - collectDouble
```
default <R extends MutableDoubleCollection> R collectDouble(CharToDoubleFunction function,
                                                            R target)
```
    Returns the target MutableDoubleCollection with the results of applying the specified function on each element of the source collection.
    
    Since:
    
    8.1.
  - detectIfNone
```
char detectIfNone(CharPredicate predicate,
                  char ifNone)
```
  - count
```
int count(CharPredicate predicate)
```
    Returns a count of the number of elements in the CharIterable that return true for the specified predicate.
  - anySatisfy
```
boolean anySatisfy(CharPredicate predicate)
```
    Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
  - allSatisfy
```
boolean allSatisfy(CharPredicate predicate)
```
    Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
  - noneSatisfy
```
default boolean noneSatisfy(CharPredicate predicate)
```
    Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
  - toList
```
MutableCharList toList()
```
    Converts the CharIterable to a new MutableCharList.
  - toSet
```
MutableCharSet toSet()
```
    Converts the CharIterable to a new MutableCharSet.
  - toBag
```
MutableCharBag toBag()
```
    Converts the CharIterable to a new MutableCharBag.
  - asLazy
```
LazyCharIterable asLazy()
```
    Returns a LazyCharIterable adapter wrapping the source CharIterable.
  - injectInto
```
<T> T injectInto(T injectedValue,
                 ObjectCharToObjectFunction<? super T,? extends T> function)
```
  - injectIntoBoolean
```
default boolean injectIntoBoolean(boolean injectedValue,
                                  BooleanCharToBooleanFunction function)
```
    Returns the final boolean result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Since:
    
    11.1
  - injectIntoByte
```
default byte injectIntoByte(byte injectedValue,
                            ByteCharToByteFunction function)
```
    Returns the final byte result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Since:
    
    11.1
  - injectIntoChar
```
default char injectIntoChar(char injectedValue,
                            CharCharToCharFunction function)
```
    Returns the final char result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Since:
    
    11.1
  - injectIntoShort
```
default short injectIntoShort(short injectedValue,
                              ShortCharToShortFunction function)
```
    Returns the final short result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Since:
    
    11.1
  - injectIntoInt
```
default int injectIntoInt(int injectedValue,
                          IntCharToIntFunction function)
```
    Returns the final int result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Since:
    
    11.1
  - injectIntoFloat
```
default float injectIntoFloat(float injectedValue,
                              FloatCharToFloatFunction function)
```
    Returns the final float result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Since:
    
    11.1
  - injectIntoLong
```
default long injectIntoLong(long injectedValue,
                            LongCharToLongFunction function)
```
    Returns the final long result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Since:
    
    11.1
  - injectIntoDouble
```
default double injectIntoDouble(double injectedValue,
                                DoubleCharToDoubleFunction function)
```
    Returns the final double result of evaluating function using each element of the iterable and the previous evaluation result as the parameters. The injected value is used for the first parameter of the first evaluation, and the current item in the iterable is used as the second parameter.
    
    Since:
    
    11.1
  - reduceIfEmpty
```
default long reduceIfEmpty(LongCharToLongFunction accumulator,
                           long defaultValue)
```
    Since:
    
    10.0
    
    See Also:
    
    reduce(LongCharToLongFunction)
  - reduce
```
default long reduce(LongCharToLongFunction accumulator)
```
    Since:
    
    10.0
    
    See Also:
    
    RichIterable.reduce(BinaryOperator)
  - chunk
```
default RichIterable<CharIterable> chunk(int size)
```
    Partitions elements in fixed size chunks.
    
    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.
    
    Since:
    
    9.2
  - sum
```
long sum()
```
  - summaryStatistics
```
default IntSummaryStatistics summaryStatistics()
```
    Since:
    
    8.0
  - max
```
char max()
```
  - maxIfEmpty
```
char maxIfEmpty(char defaultValue)
```
  - min
```
char min()
```
  - minIfEmpty
```
char minIfEmpty(char defaultValue)
```
  - average
```
double average()
```
  - averageIfEmpty
```
default double averageIfEmpty(double defaultValue)
```
    Since:
    
    9.0
  - median
```
double median()
```
  - medianIfEmpty
```
default double medianIfEmpty(double defaultValue)
```
    Since:
    
    9.0
  - toSortedArray
```
char[] toSortedArray()
```
  - toSortedList
```
MutableCharList toSortedList()
```
  - toSortedList
```
default MutableCharList toSortedList(CharComparator comparator)
```
    Converts the collection to a MutableCharList implementation sorted using the provided comparator.
  - toSortedListBy
```
default <T> MutableCharList toSortedListBy(CharToObjectFunction<T> function)
```
    Converts the collection to a MutableCharListImplementation sorted based on the natural order of the key returned by function.
  - toSortedListBy
```
default <T> MutableCharList toSortedListBy(CharToObjectFunction<T> function,
                                           Comparator<? super T> comparator)
```
    Converts the collection to a MutableCharList implementation, which is sorted based on the key returned by function using the provided comparator.

Interface CharIterable

Method Summary

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

Method Detail

charIterator

toArray

toArray

contains

containsAll

containsAll

containsAny

containsAny

containsNone

containsNone

forEach

each

tap

select

reject

select

reject

collect

collect

flatCollect

collectBoolean

collectByte

collectChar

collectShort

collectInt

collectFloat

collectLong

collectDouble

detectIfNone

count

anySatisfy

allSatisfy

noneSatisfy

toList

toSet

toBag

asLazy

injectInto

injectIntoBoolean

injectIntoByte

injectIntoChar

injectIntoShort

injectIntoInt

injectIntoFloat

injectIntoLong

injectIntoDouble

reduceIfEmpty

reduce

chunk

sum

summaryStatistics

max

maxIfEmpty

min

minIfEmpty

average

averageIfEmpty

median

medianIfEmpty

toSortedArray

toSortedList

toSortedList

toSortedListBy

toSortedListBy