Class CharArrayList

java.lang.Object

org.eclipse.collections.impl.primitive.AbstractCharIterable

org.eclipse.collections.impl.list.mutable.primitive.CharArrayList

All Implemented Interfaces:

Externalizable, Serializable, CharIterable, MutableCharCollection, CharList, MutableCharList, OrderedCharIterable, ReversibleCharIterable, PrimitiveIterable

public class CharArrayList
extends AbstractCharIterable
implements MutableCharList, Externalizable

CharArrayList is similar to FastList, and is memory-optimized for char primitives. This file was automatically generated from template file primitiveArrayList.stg.

Since:

3.0.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	CharArrayList.InternalCharIterator

Field Summary

Fields

Modifier and Type	Field	Description
private static final char[]	DEFAULT_SIZED_EMPTY_ARRAY
protected char[]	items
private static final int	MAXIMUM_ARRAY_SIZE
private static final long	serialVersionUID
protected int	size
private static final char[]	ZERO_SIZED_ARRAY

Constructor Summary

Constructors

Constructor	Description
CharArrayList()
CharArrayList(char... array)
CharArrayList(int initialCapacity)

Method Summary

Modifier and Type	Method	Description
boolean	add(char newItem)
boolean	addAll(char... source)
boolean	addAll(CharIterable source)
boolean	addAllAtIndex(int index, char... source)
boolean	addAllAtIndex(int index, CharIterable source)
void	addAtIndex(int index, char element)
private void	addAtIndexLessThanSize(int index, char element)
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(Appendable appendable, String start, String separator, String end)	Prints a string representation of this collection onto the given Appendable.
LazyCharIterable	asReversed()
MutableCharList	asSynchronized()
MutableCharList	asUnmodifiable()
int	binarySearch(char value)
MutableList<Character>	boxed()
MutableCharIterator	charIterator()	Returns a primitive iterator that can be used to iterate over the CharIterable in an imperative style.
private void	checkEmpty()
RichIterable<CharIterable>	chunk(int size)	Partitions elements in fixed size chunks.
void	clear()
<V> MutableList<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.
<V, R extends Collection<V>> R	collect(CharToObjectFunction<? extends V> function, R target)	Same as CharIterable.collect(CharToObjectFunction) , only the results are added to the target Collection.
boolean	contains(char value)	Returns true if the value is contained in the CharIterable, and false if it is not.
private void	copyItems(int sourceSize, char[] source)
private char[]	copyItemsWithNewCapacity(int newCapacity)
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)
MutableCharList	distinct()
long	dotProduct(CharList list)
void	each(CharProcedure procedure)	A synonym for forEach.
void	ensureCapacity(int minCapacity)
private void	ensureCapacityForAdd()
boolean	equals(Object otherList)	Follows the same general contract as List.equals(Object).
void	forEachWithIndex(CharIntProcedure procedure)
char	get(int index)
char	getFirst()
char	getLast()
int	hashCode()	Follows the same general contract as List.hashCode().
int	indexOf(char value)
<T> T	injectInto(T injectedValue, ObjectCharToObjectFunction<? super T, ? extends T> function)
<T> T	injectIntoWithIndex(T injectedValue, ObjectCharIntToObjectFunction<? super T, ? extends T> function)
int	lastIndexOf(char value)
char	max()
char	min()
CharArrayList	newEmpty()	Creates a new empty CharArrayList.
private IndexOutOfBoundsException	newIndexOutOfBoundsException(int index)
static CharArrayList	newList(CharIterable source)
static CharArrayList	newListWith(char... elements)	Creates a new list using the passed elements argument as the backing store.
static CharArrayList	newWithNValues(int size, char value)
void	readExternal(ObjectInput in)
CharArrayList	reject(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return false for the specified predicate.
<R extends MutableCharCollection> R	reject(CharPredicate predicate, R target)	Same as CharIterable.reject(CharPredicate) , only the results are added to the target MutableCharCollection.
boolean	remove(char value)
boolean	removeAll(char... source)
boolean	removeAll(CharIterable source)
char	removeAtIndex(int index)
boolean	removeIf(CharPredicate predicate)
boolean	retainAll(char... source)
boolean	retainAll(CharIterable source)
CharArrayList	reverseThis()
CharArrayList	select(CharPredicate predicate)	Returns a new CharIterable with all of the elements in the CharIterable that return true for the specified predicate.
<R extends MutableCharCollection> R	select(CharPredicate predicate, R target)	Same as CharIterable.select(CharPredicate) , only the results are added to the target MutableCharCollection.
char	set(int index, char element)
private void	shiftElementsAtIndex(int index, int sourceSize)
int	size()	Returns the number of items in this iterable.
private int	sizePlusFiftyPercent(int oldSize)
CharArrayList	sortThis()	Sorts this list mutating its contents and returns the same mutable list (this).
CharArrayList	sortThis(CharComparator comparator)	Sorts the internal data structure of this list and returns the list itself as a convenience.
MutableCharList	subList(int fromIndex, int toIndex)
long	sum()
void	swap(int index1, int index2)
private void	throwOutOfBounds(int index)
char[]	toArray()	Converts the CharIterable to a primitive char array.
char[]	toArray(char[] target)	Converts the CharIterable to a primitive char array.
ImmutableCharList	toImmutable()	Returns an immutable copy of this list.
CharArrayList	toReversed()
MutableCharStack	toStack()	Converts the collection to a CharStack.
private void	transferItemsToNewArrayWithCapacity(int newCapacity)
void	trimToSize()
private void	wipeAndResetTheEnd(int newCurrentFilledIndex)
CharArrayList	with(char element)
CharArrayList	with(char element1, char element2)
CharArrayList	with(char element1, char element2, char element3)
CharArrayList	with(char element1, char element2, char element3, char... elements)
CharArrayList	withAll(CharIterable elements)
private CharArrayList	withArrayCopy(char[] elements, int begin, int length)
CharArrayList	without(char element)
CharArrayList	withoutAll(CharIterable elements)
static CharArrayList	wrapCopy(char... array)	Creates a new list by first copying the array passed in.
void	writeExternal(ObjectOutput out)
<T> MutableList<CharObjectPair<T>>	zip(Iterable<T> iterable)	Returns a MutableList formed from this MutableCharList and a ListIterable by combining corresponding elements in pairs.
MutableList<CharCharPair>	zipChar(CharIterable iterable)	Returns a MutableList formed from this MutableCharList and another CharList by combining corresponding elements in pairs.

Methods inherited from class AbstractCharIterable

asLazy, average, maxIfEmpty, median, minIfEmpty, toBag, toList, toSet, toSortedArray, toSortedList, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface CharIterable

asLazy, average, averageIfEmpty, collectBoolean, collectByte, collectChar, collectDouble, collectFloat, collectInt, collectLong, collectShort, containsAll, containsAll, containsAny, containsAny, containsNone, containsNone, flatCollect, forEach, injectIntoBoolean, injectIntoByte, injectIntoChar, injectIntoDouble, injectIntoFloat, injectIntoInt, injectIntoLong, injectIntoShort, maxIfEmpty, median, medianIfEmpty, minIfEmpty, noneSatisfy, reduce, reduceIfEmpty, summaryStatistics, toBag, toList, toSet, toSortedArray, toSortedList, toSortedList, toSortedListBy, toSortedListBy

Methods inherited from interface CharList

forEachInBoth

Methods inherited from interface MutableCharList

collectWithIndex, rejectWithIndex, selectWithIndex, shuffleThis, shuffleThis, sortThisBy, sortThisBy, tap

Methods inherited from interface OrderedCharIterable

collectWithIndex, rejectWithIndex, selectWithIndex

Methods inherited from interface PrimitiveIterable

appendString, appendString, isEmpty, makeString, makeString, makeString, notEmpty, toString

Field Details

serialVersionUID

private static final long serialVersionUID

See Also:

• Constant Field Values

DEFAULT_SIZED_EMPTY_ARRAY

private static final char[] DEFAULT_SIZED_EMPTY_ARRAY

ZERO_SIZED_ARRAY

private static final char[] ZERO_SIZED_ARRAY

MAXIMUM_ARRAY_SIZE

private static final int MAXIMUM_ARRAY_SIZE

See Also:

• Constant Field Values

size

protected int size

items

protected transient char[] items

Constructor Details

CharArrayList

public CharArrayList()

CharArrayList

public CharArrayList(int initialCapacity)

CharArrayList

public CharArrayList(char... array)

Method Details

newListWith

public static CharArrayList newListWith(char... elements)

Creates a new list using the passed elements argument as the backing store.

!!! WARNING: This method uses the passed in array, so can be very unsafe if the original array is held onto anywhere else. !!!

newList

public static CharArrayList newList(CharIterable source)

newWithNValues

public static CharArrayList newWithNValues(int size,
 char value)

wrapCopy

public static CharArrayList wrapCopy(char... array)

Creates a new list by first copying the array passed in.

size

public int size()

Description copied from interface: PrimitiveIterable

Returns the number of items in this iterable.

Specified by:

size in interface PrimitiveIterable

clear

public void clear()

Specified by:

clear in interface MutableCharCollection

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

get

public char get(int index)

Specified by:

get in interface CharList

newIndexOutOfBoundsException

private IndexOutOfBoundsException newIndexOutOfBoundsException(int index)

getFirst

public char getFirst()

Specified by:

getFirst in interface OrderedCharIterable

getLast

public char getLast()

Specified by:

getLast in interface ReversibleCharIterable

checkEmpty

private void checkEmpty()

indexOf

public int indexOf(char value)

Specified by:

indexOf in interface OrderedCharIterable

lastIndexOf

public int lastIndexOf(char value)

Specified by:

lastIndexOf in interface CharList

trimToSize

public void trimToSize()

transferItemsToNewArrayWithCapacity

private void transferItemsToNewArrayWithCapacity(int newCapacity)

copyItemsWithNewCapacity

private char[] copyItemsWithNewCapacity(int newCapacity)

sizePlusFiftyPercent

private int sizePlusFiftyPercent(int oldSize)

ensureCapacity

public void ensureCapacity(int minCapacity)

ensureCapacityForAdd

private void ensureCapacityForAdd()

add

public boolean add(char newItem)

Specified by:

add in interface MutableCharCollection

addAll

public boolean addAll(char... source)

Specified by:

addAll in interface MutableCharCollection

addAll

public boolean addAll(CharIterable source)

Specified by:

addAll in interface MutableCharCollection

copyItems

private void copyItems(int sourceSize,
 char[] source)

throwOutOfBounds

private void throwOutOfBounds(int index)

addAtIndex

public void addAtIndex(int index,
 char element)

Specified by:

addAtIndex in interface MutableCharList

addAtIndexLessThanSize

private void addAtIndexLessThanSize(int index,
 char element)

addAllAtIndex

public boolean addAllAtIndex(int index,
 char... source)

Specified by:

addAllAtIndex in interface MutableCharList

addAllAtIndex

public boolean addAllAtIndex(int index,
 CharIterable source)

Specified by:

addAllAtIndex in interface MutableCharList

shiftElementsAtIndex

private void shiftElementsAtIndex(int index,
 int sourceSize)

remove

public boolean remove(char value)

Specified by:

remove in interface MutableCharCollection

removeIf

public boolean removeIf(CharPredicate predicate)

Specified by:

removeIf in interface MutableCharCollection

wipeAndResetTheEnd

private void wipeAndResetTheEnd(int newCurrentFilledIndex)

removeAll

public boolean removeAll(CharIterable source)

Specified by:

removeAll in interface MutableCharCollection

removeAll

public boolean removeAll(char... source)

Specified by:

removeAll in interface MutableCharCollection

retainAll

public boolean retainAll(CharIterable source)

Specified by:

retainAll in interface MutableCharCollection

See Also:

• Collection.retainAll(Collection)

retainAll

public boolean retainAll(char... source)

Specified by:

retainAll in interface MutableCharCollection

See Also:

• Collection.retainAll(Collection)

removeAtIndex

public char removeAtIndex(int index)

Specified by:

removeAtIndex in interface MutableCharList

set

public char set(int index,
 char element)

Specified by:

set in interface MutableCharList

swap

public void swap(int index1,
 int index2)

Specified by:

swap in interface MutableCharList

with

public CharArrayList with(char element)

Specified by:

with in interface MutableCharCollection

Specified by:

with in interface MutableCharList

without

public CharArrayList without(char element)

Specified by:

without in interface MutableCharCollection

Specified by:

without in interface MutableCharList

withAll

public CharArrayList withAll(CharIterable elements)

Specified by:

withAll in interface MutableCharCollection

Specified by:

withAll in interface MutableCharList

withoutAll

public CharArrayList withoutAll(CharIterable elements)

Specified by:

withoutAll in interface MutableCharCollection

Specified by:

withoutAll in interface MutableCharList

with

public CharArrayList with(char element1,
 char element2)

with

public CharArrayList with(char element1,
 char element2,
 char element3)

with

public CharArrayList with(char element1,
 char element2,
 char element3,
 char... elements)

withArrayCopy

private CharArrayList withArrayCopy(char[] elements,
 int begin,
 int length)

charIterator

public MutableCharIterator 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 interface CharIterable

Specified by:

charIterator in interface MutableCharCollection

each

public void each(CharProcedure procedure)

Description copied from interface: CharIterable

A synonym for forEach.

Specified by:

each in interface CharIterable

Since:

7.0.

forEachWithIndex

public void forEachWithIndex(CharIntProcedure procedure)

Specified by:

forEachWithIndex in interface OrderedCharIterable

injectInto

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

Specified by:

injectInto in interface CharIterable

injectIntoWithIndex

public <T> T injectIntoWithIndex(T injectedValue,
 ObjectCharIntToObjectFunction<? super T, ? extends T> function)

Specified by:

injectIntoWithIndex in interface OrderedCharIterable

Specified by:

injectIntoWithIndex in interface ReversibleCharIterable

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.

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

select

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

Specified by:

select in interface CharList

Specified by:

select in interface MutableCharCollection

Specified by:

select in interface MutableCharList

Specified by:

select in interface OrderedCharIterable

Specified by:

select in interface ReversibleCharIterable

select

public <R extends MutableCharCollection> R select(CharPredicate predicate,
 R target)

Description copied from interface: CharIterable

Same as CharIterable.select(CharPredicate) , only the results are added to the target MutableCharCollection.

Specified by:

select in interface CharIterable

Since:

8.1.

reject

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

Specified by:

reject in interface CharList

Specified by:

reject in interface MutableCharCollection

Specified by:

reject in interface MutableCharList

Specified by:

reject in interface OrderedCharIterable

Specified by:

reject in interface ReversibleCharIterable

reject

public <R extends MutableCharCollection> R reject(CharPredicate predicate,
 R target)

Description copied from interface: CharIterable

Same as CharIterable.reject(CharPredicate) , only the results are added to the target MutableCharCollection.

Specified by:

reject in interface CharIterable

Since:

8.1.

detectIfNone

public char detectIfNone(CharPredicate predicate,
 char ifNone)

Specified by:

detectIfNone in interface CharIterable

collect

public <V> MutableList<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

Specified by:

collect in interface CharList

Specified by:

collect in interface MutableCharCollection

Specified by:

collect in interface MutableCharList

Specified by:

collect in interface OrderedCharIterable

Specified by:

collect in interface ReversibleCharIterable

collect

public <V, R extends Collection<V>> R collect(CharToObjectFunction<? extends V> function,
 R target)

Description copied from interface: CharIterable

Same as CharIterable.collect(CharToObjectFunction) , only the results are added to the target Collection.

Specified by:

collect in interface CharIterable

Since:

8.1.

max

public char max()

Specified by:

max in interface CharIterable

min

public char min()

Specified by:

min in interface CharIterable

sum

public long sum()

Specified by:

sum in interface CharIterable

dotProduct

public long dotProduct(CharList list)

Specified by:

dotProduct in interface CharList

toArray

public char[] toArray()

Description copied from interface: CharIterable

Converts the CharIterable to a primitive char array.

Specified by:

toArray in interface CharIterable

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 interface CharIterable

equals

public boolean equals(Object otherList)

Description copied from interface: CharList

Follows the same general contract as List.equals(Object).

Specified by:

equals in interface CharList

Overrides:

equals in class Object

hashCode

public int hashCode()

Description copied from interface: CharList

Follows the same general contract as List.hashCode().

Specified by:

hashCode in interface CharList

Overrides:

hashCode in class Object

appendString

public void appendString(Appendable appendable,
 String start,
 String separator,
 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

asUnmodifiable

public MutableCharList asUnmodifiable()

Specified by:

asUnmodifiable in interface MutableCharCollection

Specified by:

asUnmodifiable in interface MutableCharList

asSynchronized

public MutableCharList asSynchronized()

Specified by:

asSynchronized in interface MutableCharCollection

Specified by:

asSynchronized in interface MutableCharList

toImmutable

public ImmutableCharList toImmutable()

Description copied from interface: MutableCharList

Returns an immutable copy of this list.

Specified by:

toImmutable in interface CharList

Specified by:

toImmutable in interface MutableCharCollection

Specified by:

toImmutable in interface MutableCharList

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

asReversed

public LazyCharIterable asReversed()

Specified by:

asReversed in interface ReversibleCharIterable

reverseThis

public CharArrayList reverseThis()

Specified by:

reverseThis in interface MutableCharList

sortThis

public CharArrayList sortThis()

Description copied from interface: MutableCharList

Sorts this list mutating its contents and returns the same mutable list (this).

Specified by:

sortThis in interface MutableCharList

sortThis

public CharArrayList sortThis(CharComparator comparator)

Description copied from interface: MutableCharList

Sorts the internal data structure of this list and returns the list itself as a convenience.

Specified by:

sortThis in interface MutableCharList

toReversed

public CharArrayList toReversed()

Specified by:

toReversed in interface CharList

Specified by:

toReversed in interface MutableCharList

Specified by:

toReversed in interface ReversibleCharIterable

binarySearch

public int binarySearch(char value)

Specified by:

binarySearch in interface CharList

distinct

public MutableCharList distinct()

Specified by:

distinct in interface CharList

Specified by:

distinct in interface MutableCharList

Specified by:

distinct in interface ReversibleCharIterable

subList

public MutableCharList subList(int fromIndex,
 int toIndex)

Specified by:

subList in interface CharList

Specified by:

subList in interface MutableCharList

See Also:

• List.subList(int fromIndex, int toIndex)

zipChar

public MutableList<CharCharPair> zipChar(CharIterable iterable)

Description copied from interface: MutableCharList

Returns a MutableList formed from this MutableCharList and another CharList by combining corresponding elements in pairs. If one of the two CharLists is longer than the other, its remaining elements are ignored.

Specified by:

zipChar in interface CharList

Specified by:

zipChar in interface MutableCharList

Since:

9.1.

newEmpty

public CharArrayList newEmpty()

Creates a new empty CharArrayList.

Specified by:

newEmpty in interface MutableCharCollection

Specified by:

newEmpty in interface MutableCharList

Since:

9.2.

zip

public <T> MutableList<CharObjectPair<T>> zip(Iterable<T> iterable)

Description copied from interface: MutableCharList

Returns a MutableList formed from this MutableCharList and a ListIterable by combining corresponding elements in pairs. If one of the two Lists is longer than the other, its remaining elements are ignored.

Specified by:

zip in interface CharList

Specified by:

zip in interface MutableCharList

Since:

9.1.

boxed

public MutableList<Character> boxed()

Specified by:

boxed in interface MutableCharList

toStack

public MutableCharStack toStack()

Description copied from interface: OrderedCharIterable

Converts the collection to a CharStack.

Specified by:

toStack in interface OrderedCharIterable