com.gs.collections.impl.list.mutable.primitive

Class CharArrayList

java.lang.Object

com.gs.collections.impl.list.mutable.primitive.CharArrayList

All Implemented Interfaces:

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

@NotThreadSafe
public final class CharArrayList
extends Object
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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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)
boolean	allSatisfy(CharPredicate predicate)
boolean	anySatisfy(CharPredicate predicate)
void	appendString(Appendable appendable) Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String separator) Prints a string representation of this collection onto the given Appendable.
void	appendString(Appendable appendable, String start, String separator, String end) Prints a string representation of this collection onto the given Appendable.
LazyCharIterable	asLazy()
LazyCharIterable	asReversed()
MutableCharList	asSynchronized()
MutableCharList	asUnmodifiable()
double	average()
CharIterator	charIterator()
void	clear()
<V> MutableList<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)
long	dotProduct(CharList list)
void	ensureCapacity(int minCapacity)
boolean	equals(Object otherList) Follows the same general contract as List.equals(Object).
void	forEach(CharProcedure procedure)
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)
boolean	isEmpty() Returns true if this iterable has zero items.
int	lastIndexOf(char value)
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).
String	makeString(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).
String	makeString(String start, String separator, String end) Returns a string representation of this collection.
char	max()
char	maxIfEmpty(char defaultValue)
double	median()
char	min()
char	minIfEmpty(char defaultValue)
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)
boolean	noneSatisfy(CharPredicate predicate)
boolean	notEmpty() The English equivalent of !this.isEmpty()
void	readExternal(ObjectInput in)
CharArrayList	reject(CharPredicate predicate)
boolean	remove(char value)
boolean	removeAll(char... source)
boolean	removeAll(CharIterable source)
char	removeAtIndex(int index)
boolean	retainAll(char... source)
boolean	retainAll(CharIterable source)
CharArrayList	reverseThis()
CharArrayList	select(CharPredicate predicate)
char	set(int index, char element)
int	size() Returns the number of items in this iterable.
CharArrayList	sortThis() Sorts this list mutating its contents and returns the same mutable list (this).
MutableCharList	subList(int fromIndex, int toIndex)
long	sum()
char[]	toArray()
MutableCharBag	toBag()
ImmutableCharList	toImmutable() Returns an immutable copy of this list.
MutableCharList	toList()
CharArrayList	toReversed()
MutableCharSet	toSet()
char[]	toSortedArray()
MutableCharList	toSortedList()
String	toString() Returns a string representation of this PrimitiveIterable.
void	trimToSize()
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)
CharArrayList	without(char element)
CharArrayList	withoutAll(CharIterable elements)
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CharArrayList

public CharArrayList()

CharArrayList

public CharArrayList(int initialCapacity)

CharArrayList

public CharArrayList(char... array)

Method Detail

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)

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

clear

public void clear()

Specified by:

clear in interface MutableCharCollection

contains

public boolean contains(char value)

Specified by:

contains in interface CharIterable

containsAll

public boolean containsAll(char... source)

Specified by:

containsAll in interface CharIterable

containsAll

public boolean containsAll(CharIterable source)

Specified by:

containsAll in interface CharIterable

get

public char get(int index)

Specified by:

get in interface CharList

getFirst

public char getFirst()

Specified by:

getFirst in interface ReversibleCharIterable

getLast

public char getLast()

Specified by:

getLast in interface ReversibleCharIterable

indexOf

public int indexOf(char value)

Specified by:

indexOf in interface ReversibleCharIterable

lastIndexOf

public int lastIndexOf(char value)

Specified by:

lastIndexOf in interface CharList

trimToSize

public void trimToSize()

ensureCapacity

public void ensureCapacity(int minCapacity)

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

addAtIndex

public void addAtIndex(int index,
                       char element)

Specified by:

addAtIndex in interface MutableCharList

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

remove

public boolean remove(char value)

Specified by:

remove in interface MutableCharCollection

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

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)

charIterator

public CharIterator charIterator()

Specified by:

charIterator in interface CharIterable

forEach

public void forEach(CharProcedure procedure)

Specified by:

forEach in interface CharIterable

forEachWithIndex

public void forEachWithIndex(CharIntProcedure procedure)

Specified by:

forEachWithIndex in interface ReversibleCharIterable

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 ReversibleCharIterable

count

public int count(CharPredicate predicate)

Specified by:

count in interface CharIterable

anySatisfy

public boolean anySatisfy(CharPredicate predicate)

Specified by:

anySatisfy in interface CharIterable

allSatisfy

public boolean allSatisfy(CharPredicate predicate)

Specified by:

allSatisfy in interface CharIterable

noneSatisfy

public boolean noneSatisfy(CharPredicate predicate)

Specified by:

noneSatisfy in interface CharIterable

select

public CharArrayList select(CharPredicate predicate)

Specified by:

select in interface CharIterable

Specified by:

select in interface MutableCharCollection

Specified by:

select in interface CharList

Specified by:

select in interface MutableCharList

Specified by:

select in interface ReversibleCharIterable

reject

public CharArrayList reject(CharPredicate predicate)

Specified by:

reject in interface CharIterable

Specified by:

reject in interface MutableCharCollection

Specified by:

reject in interface CharList

Specified by:

reject in interface MutableCharList

Specified by:

reject in interface ReversibleCharIterable

detectIfNone

public char detectIfNone(CharPredicate predicate,
                         char ifNone)

Specified by:

detectIfNone in interface CharIterable

collect

public <V> MutableList<V> collect(CharToObjectFunction<? extends V> function)

Specified by:

collect in interface CharIterable

Specified by:

collect in interface MutableCharCollection

Specified by:

collect in interface CharList

Specified by:

collect in interface MutableCharList

Specified by:

collect in interface ReversibleCharIterable

max

public char max()

Specified by:

max 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

maxIfEmpty

public char maxIfEmpty(char defaultValue)

Specified by:

maxIfEmpty 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

average

public double average()

Specified by:

average in interface CharIterable

median

public double median()

Specified by:

median in interface CharIterable

toArray

public char[] toArray()

Specified by:

toArray in interface CharIterable

toSortedArray

public char[] toSortedArray()

Specified by:

toSortedArray 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

toString

public String toString()

Description copied from interface: PrimitiveIterable

Returns a string representation of this PrimitiveIterable. The string representation consists of a list of the PrimitiveIterable's elements in the order they are returned by its iterator, enclosed in square brackets ("[]"). Adjacent elements are separated by the characters ", " (comma and space). Elements are converted to strings as by String#valueOf().

Specified by:

toString in interface PrimitiveIterable

Overrides:

toString in class Object

Returns:

a string representation of this PrimitiveIterable

makeString

public 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 String makeString(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 String makeString(String start,
                         String separator,
                         String end)

Description copied from interface: PrimitiveIterable

Returns a string representation of this collection. The string representation consists of a list of the collection's elements in the order they are returned by its iterator, enclosed in the start and end strings. Adjacent elements are separated by the separator string. Elements are converted to strings using the appropriate version of String.valueOf().

Specified by:

makeString in interface PrimitiveIterable

Returns:

a string representation of this collection.

appendString

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

toList

public MutableCharList toList()

Specified by:

toList in interface CharIterable

toSortedList

public MutableCharList toSortedList()

Specified by:

toSortedList in interface CharIterable

toSet

public MutableCharSet toSet()

Specified by:

toSet in interface CharIterable

toBag

public MutableCharBag toBag()

Specified by:

toBag in interface CharIterable

asLazy

public LazyCharIterable asLazy()

Specified by:

asLazy in interface CharIterable

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 MutableCharCollection

Specified by:

toImmutable in interface CharList

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

toReversed

public CharArrayList toReversed()

Specified by:

toReversed in interface CharList

Specified by:

toReversed in interface MutableCharList

Specified by:

toReversed 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)}