SynchronizedCharIterable (Eclipse Collections

java.lang.Object
- org.eclipse.collections.impl.primitive.SynchronizedCharIterable

All Implemented Interfaces:

java.io.Serializable, CharIterable, PrimitiveIterable
```
public class SynchronizedCharIterable
extends java.lang.Object
implements CharIterable, java.io.Serializable
```
A synchronized view of a CharIterable. This file was automatically generated from template file synchronizedPrimitiveIterable.stg.

Since:

5.0.

See Also:

Serialized Form

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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(java.lang.Appendable appendable)`	Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(java.lang.Appendable appendable, java.lang.String separator)`	Prints a string representation of this collection onto the given `Appendable`.
`void`	`appendString(java.lang.Appendable appendable, java.lang.String start, java.lang.String separator, java.lang.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()`
`CharIterator`	`charIterator()`	Must be called in a synchronized block.
`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.
`boolean`	`contains(char value)`	Returns true if the value is contained in the CharIterable, and false if it is not.
`boolean`	`containsAll(char... source)`	Returns true if the 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 the 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.
`void`	`forEach(CharProcedure procedure)`	Applies the CharProcedure to each element in the CharIterable.
`<T> T`	`injectInto(T injectedValue, ObjectCharToObjectFunction<? super T,? extends T> function)`
`boolean`	`isEmpty()`	Returns true if this iterable has zero items.
`java.lang.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).
`java.lang.String`	`makeString(java.lang.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).
`java.lang.String`	`makeString(java.lang.String start, java.lang.String separator, java.lang.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)`
`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()
`static SynchronizedCharIterable`	`of(CharIterable iterable)`	This method will take a CharIterable and wrap it directly in a SynchronizedCharIterable.
`static SynchronizedCharIterable`	`of(CharIterable iterable, java.lang.Object lock)`	This method will take a CharIterable and wrap it directly in a SynchronizedCharIterable.
`long`	`reduce(LongCharToLongFunction accumulator)`
`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.
`CharIterable`	`select(CharPredicate predicate)`	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
`int`	`size()`	Returns the number of items in this iterable.
`long`	`sum()`
`char[]`	`toArray()`	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()`
`java.lang.String`	`toString()`	Returns a string with the elements of this iterable separated by commas with spaces and enclosed in square brackets.

Methods inherited from interface org.eclipse.collections.api.CharIterable
averageIfEmpty, collect, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, flatCollect, medianIfEmpty, reject, select, summaryStatistics, tap

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - of
```
public static SynchronizedCharIterable of(CharIterable iterable)
```
    This method will take a CharIterable and wrap it directly in a SynchronizedCharIterable.
  - of
```
public static SynchronizedCharIterable of(CharIterable iterable,
                                          java.lang.Object lock)
```
    This method will take a CharIterable and wrap it directly in a SynchronizedCharIterable. Additionally, a developer specifies which lock to use with the collection.
  - toArray
```
public char[] toArray()
```
    Description copied from interface: CharIterable
    
    Converts the CharIterable to a primitive char array.
    
    Specified by:
    
    toArray in interface CharIterable
  - 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(char... source)
```
    Description copied from interface: CharIterable
    
    Returns true if the 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
  - containsAll
```
public boolean containsAll(CharIterable source)
```
    Description copied from interface: CharIterable
    
    Returns true if the 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
  - forEach
```
public void forEach(CharProcedure procedure)
```
    Description copied from interface: CharIterable
    
    Applies the CharProcedure to each element in the CharIterable.
    
    Specified by:
    
    forEach 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 CharIterable 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 CharIterable
  - reject
```
public CharIterable 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 CharIterable
  - collect
```
public <V> RichIterable<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 CharIterable
  - 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
  - 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
  - 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
  - toList
```
public MutableCharList toList()
```
    Description copied from interface: CharIterable
    
    Converts the CharIterable to a new MutableCharList.
    
    Specified by:
    
    toList in interface CharIterable
  - 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
  - asLazy
```
public LazyCharIterable asLazy()
```
    Description copied from interface: CharIterable
    
    Returns a LazyCharIterable adapter wrapping the source CharIterable.
    
    Specified by:
    
    asLazy in interface CharIterable
  - sum
```
public long sum()
```
    Specified by:
    
    sum 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
  - min
```
public char min()
```
    Specified by:
    
    min 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
  - 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
  - injectInto
```
public <T> T injectInto(T injectedValue,
                        ObjectCharToObjectFunction<? super T,? extends T> function)
```
    Specified by:
    
    injectInto in interface CharIterable
  - reduce
```
public long reduce(LongCharToLongFunction accumulator)
```
    Specified by:
    
    reduce in interface CharIterable
    
    See Also:
    
    RichIterable.reduce(BinaryOperator)
  - reduceIfEmpty
```
public long reduceIfEmpty(LongCharToLongFunction accumulator,
                          long defaultValue)
```
    Specified by:
    
    reduceIfEmpty in interface CharIterable
    
    See Also:
    
    CharIterable.reduce(LongCharToLongFunction)
  - 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.
  - toString
```
public java.lang.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 java.lang.Object
    
    Returns:
    
    a string representation of this PrimitiveIterable
    
    See Also:
    
    AbstractCollection.toString()
  - makeString
```
public java.lang.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 java.lang.String makeString(java.lang.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 java.lang.String makeString(java.lang.String start,
                                   java.lang.String separator,
                                   java.lang.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(java.lang.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(java.lang.Appendable appendable,
                         java.lang.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(java.lang.Appendable appendable,
                         java.lang.String start,
                         java.lang.String separator,
                         java.lang.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()
```
    Must be called in a synchronized block.
    
    Specified by:
    
    charIterator in interface CharIterable

Class SynchronizedCharIterable

Method Summary

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

Methods inherited from class java.lang.Object

Method Detail

of

of

toArray

contains

containsAll

containsAll

forEach

each

select

reject

collect

detectIfNone

count

anySatisfy

allSatisfy

noneSatisfy

toList

toSet

toBag

asLazy

sum

max

maxIfEmpty

min

minIfEmpty

average

median

toSortedArray

toSortedList

size

isEmpty

notEmpty

injectInto

reduce

reduceIfEmpty

chunk

toString

makeString

makeString

makeString

appendString

appendString

appendString

charIterator