CharIterable (Eclipse Collections

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

All Known Implementing Classes:

AbstractCharIterable, AbstractCharSet, AbstractImmutableCharSet, AbstractImmutableObjectCharMap, AbstractLazyCharIterable, AbstractMutableCharKeySet, AbstractMutableCharValuesMap, AbstractSynchronizedCharCollection, AbstractUnmodifiableCharCollection, ByteCharHashMap, CharAdapter, CharArrayList, CharArrayStack, CharCharHashMap, CharHashBag, CharHashSet, CollectBooleanToCharIterable, CollectByteToCharIterable, CollectCharIterable, CollectCharToCharIterable, CollectDoubleToCharIterable, CollectFloatToCharIterable, CollectIntToCharIterable, CollectLongToCharIterable, CollectShortToCharIterable, DoubleCharHashMap, FloatCharHashMap, IntCharHashMap, LazyCharIterableAdapter, LongCharHashMap, ObjectCharHashMap, ObjectCharHashMapWithHashingStrategy, ReverseCharIterable, SelectCharIterable, ShortCharHashMap, SynchronizedByteCharMap, SynchronizedCharBag, SynchronizedCharCharMap, SynchronizedCharCollection, SynchronizedCharIterable, SynchronizedCharList, SynchronizedCharSet, SynchronizedCharStack, SynchronizedDoubleCharMap, SynchronizedFloatCharMap, SynchronizedIntCharMap, SynchronizedLongCharMap, SynchronizedObjectCharMap, SynchronizedShortCharMap, UnmodifiableByteCharMap, UnmodifiableCharBag, UnmodifiableCharCharMap, UnmodifiableCharCollection, UnmodifiableCharList, UnmodifiableCharSet, UnmodifiableCharStack, UnmodifiableDoubleCharMap, UnmodifiableFloatCharMap, UnmodifiableIntCharMap, UnmodifiableLongCharMap, UnmodifiableObjectCharMap, UnmodifiableShortCharMap
```
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
Modifier and Type	Method and Description
`boolean`	`allSatisfy(CharPredicate predicate)`
`boolean`	`anySatisfy(CharPredicate predicate)`
`LazyCharIterable`	`asLazy()`
`double`	`average()`
`CharIterator`	`charIterator()`
`<V> RichIterable<V>`	`collect(CharToObjectFunction<? extends V> function)`
`boolean`	`contains(char value)`
`boolean`	`containsAll(char... source)`
`boolean`	`containsAll(CharIterable source)`
`int`	`count(CharPredicate predicate)`
`char`	`detectIfNone(CharPredicate predicate, char ifNone)`
`void`	`each(CharProcedure procedure)`
`void`	`forEach(CharProcedure procedure)`
`<T> T`	`injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)`
`char`	`max()`
`char`	`maxIfEmpty(char defaultValue)`
`double`	`median()`
`char`	`min()`
`char`	`minIfEmpty(char defaultValue)`
`boolean`	`noneSatisfy(CharPredicate predicate)`
`CharIterable`	`reject(CharPredicate predicate)`
`CharIterable`	`select(CharPredicate predicate)`
`long`	`sum()`
`char[]`	`toArray()`
`MutableCharBag`	`toBag()`
`MutableCharList`	`toList()`
`MutableCharSet`	`toSet()`
`char[]`	`toSortedArray()`
`MutableCharList`	`toSortedList()`

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

Method Detail

charIterator
```
CharIterator charIterator()
```

toArray
```
char[] toArray()
```

contains
```
boolean contains(char value)
```

containsAll
```
boolean containsAll(char... source)
```

containsAll

boolean containsAll(CharIterable source)

forEach
```
void forEach(CharProcedure procedure)
```

each
```
void each(CharProcedure procedure)
```
Since:

7.0.

select

CharIterable select(CharPredicate predicate)

reject

CharIterable reject(CharPredicate predicate)

collect

<V> RichIterable<V> collect(CharToObjectFunction<? extends V> function)

detectIfNone

char detectIfNone(CharPredicate predicate,
                  char ifNone)

count
```
int count(CharPredicate predicate)
```

anySatisfy

boolean anySatisfy(CharPredicate predicate)

allSatisfy

boolean allSatisfy(CharPredicate predicate)

noneSatisfy

boolean noneSatisfy(CharPredicate predicate)

toList
```
MutableCharList toList()
```

toSet
```
MutableCharSet toSet()
```

toBag
```
MutableCharBag toBag()
```

asLazy
```
LazyCharIterable asLazy()
```

injectInto

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

sum
```
long sum()
```

max
```
char max()
```

maxIfEmpty
```
char maxIfEmpty(char defaultValue)
```

min
```
char min()
```

minIfEmpty
```
char minIfEmpty(char defaultValue)
```

average
```
double average()
```

median
```
double median()
```

toSortedArray
```
char[] toSortedArray()
```

toSortedList
```
MutableCharList toSortedList()
```

Interface CharIterable

Method Summary

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

Method Detail

charIterator

toArray

contains

containsAll

containsAll

forEach

each

select

reject

collect

detectIfNone

count

anySatisfy

allSatisfy

noneSatisfy

toList

toSet

toBag

asLazy

injectInto

sum

max

maxIfEmpty

min

minIfEmpty

average

median

toSortedArray

toSortedList