org.apache.commons.collections.primitives
Class ArrayCharList

java.lang.Object
  org.apache.commons.collections.primitives.AbstractCharCollection
      org.apache.commons.collections.primitives.RandomAccessCharList
          org.apache.commons.collections.primitives.ArrayCharList

All Implemented Interfaces:

Serializable, CharCollection, CharList

public class ArrayCharList
extends RandomAccessCharList
implements CharList, Serializable

An CharList backed by an array of chars. This implementation supports all optional methods.

Since:

Commons Primitives 1.0

Version:

$Revision: 480460 $ $Date: 2006-11-29 09:14:21 +0100 (Wed, 29 Nov 2006) $

Author:

Rodney Waldhoff

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.commons.collections.primitives.RandomAccessCharList

RandomAccessCharList.RandomAccessCharListIterator, RandomAccessCharList.RandomAccessCharSubList

Constructor Summary

ArrayCharList()
Construct an empty list with the default initial capacity.

ArrayCharList(char[] array)
Constructs a list by copying the specified array.

ArrayCharList(CharCollection that)
Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.

ArrayCharList(int initialCapacity)
Construct an empty list with the given initial capacity.

Method Summary

void	add(int index, char element) Inserts the specified element at the specified position (optional operation).
boolean	addAll(CharCollection collection) Adds all of the elements in the specified collection to me (optional operation).
boolean	addAll(int index, CharCollection collection) Inserts all of the elements in the specified collection into me, at the specified position (optional operation).
void	clear() Removes all my elements (optional operation).
void	ensureCapacity(int mincap) Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.
char	get(int index) Returns the value of the element at the specified position within me.
char	removeElementAt(int index) Removes the element at the specified position in (optional operation).
char	set(int index, char element) Replaces the element at the specified position in me with the specified element (optional operation).
int	size() Returns the number of elements I contain.
void	trimToSize() Reduce my capacity, if necessary, to match my current size.

Methods inherited from class org.apache.commons.collections.primitives.RandomAccessCharList

add, equals, getModCount, hashCode, incrModCount, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList, toString

Methods inherited from class org.apache.commons.collections.primitives.AbstractCharCollection

contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.commons.collections.primitives.CharList

add, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList

Methods inherited from interface org.apache.commons.collections.primitives.CharCollection

contains, containsAll, isEmpty, removeAll, removeElement, retainAll, toArray, toArray

Constructor Detail

ArrayCharList

public ArrayCharList()

Construct an empty list with the default initial capacity.

ArrayCharList

public ArrayCharList(int initialCapacity)

Construct an empty list with the given initial capacity.

Throws:

IllegalArgumentException - when initialCapacity is negative

ArrayCharList

public ArrayCharList(CharCollection that)

Constructs a list containing the elements of the given collection, in the order they are returned by that collection's iterator.

Parameters:

that - the non-null collection of chars to add

Throws:

NullPointerException - if that is null

See Also:

addAll(org.apache.commons.collections.primitives.CharCollection)

ArrayCharList

public ArrayCharList(char[] array)

Constructs a list by copying the specified array.

Parameters:

array - the array to initialize the collection with

Throws:

NullPointerException - if the array is null

Method Detail

get

public char get(int index)

Description copied from interface: CharList

Returns the value of the element at the specified position within me.

Specified by:

get in interface CharList

Specified by:

get in class RandomAccessCharList

Parameters:

index - the index of the element to return

Returns:

the value of the element at the specified position

size

public int size()

Description copied from interface: CharCollection

Returns the number of elements I contain.

Specified by:

size in interface CharCollection

Specified by:

size in class RandomAccessCharList

Returns:

the number of elements I contain

removeElementAt

public char removeElementAt(int index)

Removes the element at the specified position in (optional operation). Any subsequent elements are shifted to the left, subtracting one from their indices. Returns the element that was removed.

Specified by:

removeElementAt in interface CharList

Overrides:

removeElementAt in class RandomAccessCharList

Parameters:

index - the index of the element to remove

Returns:

the value of the element that was removed

Throws:

UnsupportedOperationException - when this operation is not supported

IndexOutOfBoundsException - if the specified index is out of range

set

public char set(int index,
                char element)

Replaces the element at the specified position in me with the specified element (optional operation).

Specified by:

set in interface CharList

Overrides:

set in class RandomAccessCharList

Parameters:

index - the index of the element to change

element - the value to be stored at the specified position

Returns:

the value previously stored at the specified position

Throws:

UnsupportedOperationException - when this operation is not supported

IndexOutOfBoundsException - if the specified index is out of range

add

public void add(int index,
                char element)

Inserts the specified element at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices.

Specified by:

add in interface CharList

Overrides:

add in class RandomAccessCharList

Parameters:

index - the index at which to insert the element

element - the value to insert

Throws:

UnsupportedOperationException - when this operation is not supported

IllegalArgumentException - if some aspect of the specified element prevents it from being added to me

IndexOutOfBoundsException - if the specified index is out of range

clear

public void clear()

Description copied from interface: CharCollection

Removes all my elements (optional operation). I will be empty after this method successfully returns.

Specified by:

clear in interface CharCollection

Overrides:

clear in class AbstractCharCollection

addAll

public boolean addAll(CharCollection collection)

Description copied from interface: CharCollection

Adds all of the elements in the specified collection to me (optional operation).

Specified by:

addAll in interface CharCollection

Overrides:

addAll in class AbstractCharCollection

Parameters:

collection - the collection of elements whose presence within me is to be ensured

Returns:

true iff I changed as a result of this call

addAll

public boolean addAll(int index,
                      CharCollection collection)

Description copied from interface: CharList

Inserts all of the elements in the specified collection into me, at the specified position (optional operation). Shifts the element currently at that position (if any) and any subsequent elements to the right, increasing their indices. The new elements will appear in the order that they are returned by the given collection's iterator.

Specified by:

addAll in interface CharList

Overrides:

addAll in class RandomAccessCharList

Parameters:

index - the index at which to insert the first element from the specified collection

collection - the CharCollection of elements to add

Returns:

true iff I changed as a result of this call

ensureCapacity

public void ensureCapacity(int mincap)

Increases my capacity, if necessary, to ensure that I can hold at least the number of elements specified by the minimum capacity argument without growing.

trimToSize

public void trimToSize()

Reduce my capacity, if necessary, to match my current size.