Eclipse Collections 13.0.0 · org.eclipse.collections.api.CharIterable

Method Summary

Modifier and Type	Method and Description
public boolean	allSatisfy(CharPredicate predicate) Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
public boolean	anySatisfy(CharPredicate predicate) Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
public LazyCharIterable	asLazy() Returns a LazyCharIterable adapter wrapping the source CharIterable.
public double	average()
public default double	averageIfEmpty(double defaultValue)
public CharIterator	charIterator() Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
public default RichIterable<CharIterable>	Returns: A `RichIterable` containing `CharIterable`s of size `size`, except the last will be truncated if the elements don't divide evenly. chunk(int the number of elements per chunk size) Partitions elements in fixed size chunks.
public <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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public boolean	contains(char value) Returns true if the value is contained in the CharIterable, and false if it is not.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public int	count(CharPredicate predicate) Returns a count of the number of elements in the CharIterable that return true for the specified predicate.
public char	detectIfNone(CharPredicate predicate, char ifNone)
public void	each(CharProcedure procedure) A synonym for forEach.
public default <V, R extends Collection<V>> R	flatCollect(CharToObjectFunction<? extends Iterable<V>> function, R target) `flatCollect` is a special case of `collect(CharToObjectFunction)`.
public default void	forEach(CharProcedure procedure) Applies the CharProcedure to each element in the CharIterable.
public <T> T	injectInto(T injectedValue, ObjectCharToObjectFunction<? super T, ? extends T> function)
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public 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.
public char	max()
public char	maxIfEmpty(char defaultValue)
public double	median()
public default double	medianIfEmpty(double defaultValue)
public char	min()
public char	minIfEmpty(char defaultValue)
public default boolean	noneSatisfy(CharPredicate predicate) Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.
public default long	reduce(LongCharToLongFunction accumulator)
public default long	reduceIfEmpty(LongCharToLongFunction accumulator, long defaultValue)
public CharIterable	reject(CharPredicate predicate) Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
public default <R extends MutableCharCollection> R	reject(CharPredicate predicate, R target) Same as `reject(CharPredicate)` , only the results are added to the target MutableCharCollection.
public CharIterable	select(CharPredicate predicate) Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
public default <R extends MutableCharCollection> R	select(CharPredicate predicate, R target) Same as `select(CharPredicate)` , only the results are added to the target MutableCharCollection.
public long	sum()
public default IntSummaryStatistics	summaryStatistics()
public default CharIterable	tap(CharProcedure procedure)
public char[]	toArray() Converts the CharIterable to a primitive char array.
public default char[]	toArray(char[] target) Converts the CharIterable to a primitive char array.
public MutableCharBag	toBag() Converts the CharIterable to a new MutableCharBag.
public MutableCharList	toList() Converts the CharIterable to a new MutableCharList.
public MutableCharSet	toSet() Converts the CharIterable to a new MutableCharSet.
public char[]	toSortedArray()
public MutableCharList	toSortedList()
public default MutableCharList	toSortedList(CharComparator comparator) Converts the collection to a MutableCharList implementation sorted using the provided comparator.
public 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`.
public 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`.

Inherited from org.eclipse.collections.api.PrimitiveIterable:: appendString appendString appendString isEmpty makeString makeString makeString notEmpty size toString

Method Detail

allSatisfy	back to summary
public boolean allSatisfy(CharPredicate predicate) Returns true if all of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

anySatisfy	back to summary
public boolean anySatisfy(CharPredicate predicate) Returns true if any of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

asLazy	back to summary
public LazyCharIterable asLazy() Returns a LazyCharIterable adapter wrapping the source CharIterable.

average	back to summary
public double average()

averageIfEmpty	back to summary
public default double averageIfEmpty(double defaultValue) Since 9.0

charIterator	back to summary
public CharIterator charIterator() Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.

chunk back to summary

chunk	back to summary
public default RichIterable<CharIterable> chunk(int size) Partitions elements in fixed size chunks. Parameters size:int the number of elements per chunk Returns:RichIterable<CharIterable> A `RichIterable` containing `CharIterable`s of size `size`, except the last will be truncated if the elements don't divide evenly. Since 9.2

public default RichIterable<CharIterable> chunk(int size)

Partitions elements in fixed size chunks.

Parameters

size:int: the number of elements per chunk

Returns:RichIterable<CharIterable>

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

Since

9.2

collect	back to summary
public <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 back to summary

collect	back to summary
public 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.

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

collectBoolean back to summary

collectBoolean	back to summary
public 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.

public 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 back to summary

collectByte	back to summary
public 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.

public 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 back to summary

collectChar	back to summary
public 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.

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

collectDouble back to summary

collectDouble	back to summary
public 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.

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

collectFloat back to summary

collectFloat	back to summary
public 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.

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

collectInt back to summary

collectInt	back to summary
public 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.

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

collectLong back to summary

collectLong	back to summary
public 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.

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

collectShort back to summary

collectShort	back to summary
public 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.

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

contains	back to summary
public boolean contains(char value) Returns true if the value is contained in the CharIterable, and false if it is not.

containsAll	back to summary
public 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	back to summary
public 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	back to summary
public 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

back to summary

public 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	back to summary
public 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

containsAny

back to summary

public 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	back to summary
public 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

back to summary

public 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	back to summary
public 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

containsNone

back to summary

public 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

count	back to summary
public int count(CharPredicate predicate) Returns a count of the number of elements in the CharIterable that return true for the specified predicate.

detectIfNone	back to summary
public char detectIfNone(CharPredicate predicate, char ifNone)

each	back to summary
public void each(CharProcedure procedure) A synonym for forEach. Since 7.0.

each

back to summary

public void each(CharProcedure procedure)

A synonym for forEach.

Since: 7.0.

flatCollect back to summary

flatCollect	back to summary
public 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.

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

forEach	back to summary
public default void forEach(CharProcedure procedure) Applies the CharProcedure to each element in the CharIterable.

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

injectIntoBoolean	back to summary
public 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

injectIntoBoolean

back to summary

public 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	back to summary
public 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

injectIntoByte

back to summary

public 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	back to summary
public 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

injectIntoChar

back to summary

public 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

injectIntoDouble	back to summary
public 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

injectIntoDouble

back to summary

public 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

injectIntoFloat	back to summary
public 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

injectIntoFloat

back to summary

public 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

injectIntoInt	back to summary
public 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

injectIntoInt

back to summary

public 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

injectIntoLong	back to summary
public 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

injectIntoLong

back to summary

public 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

injectIntoShort	back to summary
public 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

injectIntoShort

back to summary

public 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

max	back to summary
public char max()

maxIfEmpty	back to summary
public char maxIfEmpty(char defaultValue)

median	back to summary
public double median()

medianIfEmpty	back to summary
public default double medianIfEmpty(double defaultValue) Since 9.0

min	back to summary
public char min()

minIfEmpty	back to summary
public char minIfEmpty(char defaultValue)

noneSatisfy	back to summary
public default boolean noneSatisfy(CharPredicate predicate) Returns true if none of the elements in the CharIterable return true for the specified predicate, otherwise returns false.

reduce	back to summary
public default long reduce(LongCharToLongFunction accumulator) Since 10.0 See Also `RichIterable#reduce(BinaryOperator)`

reduceIfEmpty	back to summary
public default long reduceIfEmpty(LongCharToLongFunction accumulator, long defaultValue) Since 10.0 See Also `reduce(LongCharToLongFunction)`

reject	back to summary
public CharIterable reject(CharPredicate predicate) Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.

reject back to summary

reject	back to summary
public 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.

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

select	back to summary
public CharIterable select(CharPredicate predicate) Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.

select back to summary

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

sum	back to summary
public long sum()

summaryStatistics	back to summary
public default IntSummaryStatistics summaryStatistics() Since 8.0

tap	back to summary
public default CharIterable tap(CharProcedure procedure) Since 9.0.

toArray	back to summary
public char[] toArray() Converts the CharIterable to a primitive char array.

toArray	back to summary
public 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.

toBag	back to summary
public MutableCharBag toBag() Converts the CharIterable to a new MutableCharBag.

toList	back to summary
public MutableCharList toList() Converts the CharIterable to a new MutableCharList.

toSet	back to summary
public MutableCharSet toSet() Converts the CharIterable to a new MutableCharSet.

toSortedArray	back to summary
public char[] toSortedArray()

toSortedList	back to summary
public MutableCharList toSortedList()

toSortedList	back to summary
public default MutableCharList toSortedList(CharComparator comparator) Converts the collection to a MutableCharList implementation sorted using the provided comparator.

toSortedListBy	back to summary
public 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	back to summary
public 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`.

public Interface CharIterable

Method Summary

Method Detail