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:

java.io.Serializable, CharCollection, CharList

public class ArrayCharList
extends RandomAccessCharList
implements CharList, java.io.Serializable

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

Since:

Commons Primitives 1.0

Version:

$Revision: 1.3 $ $Date: 2003/10/16 20:49:35 $

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

Field Summary

Fields

Modifier and Type	Field and Description
private char[]	_data
private int	_size

Constructor Summary

Constructors

Constructor and Description
ArrayCharList() Construct an empty list with the default initial capacity.
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

Modifier and Type	Method and Description
void	add(int index, char element) Inserts the specified element at the specified position (optional operation).
private void	checkRange(int index)
private void	checkRangeIncludingEndpoint(int index)
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.
private void	readObject(java.io.ObjectInputStream in)
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.
private void	writeObject(java.io.ObjectOutputStream out)

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

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

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

addAll, clear, 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, addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, subList

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

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

Field Detail

_data

private transient char[] _data

_size

private int _size

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:

java.lang.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:

java.lang.NullPointerException - if that is null

See Also:

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

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:

java.lang.UnsupportedOperationException - when this operation is not supported

java.lang.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:

java.lang.UnsupportedOperationException - when this operation is not supported

java.lang.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:

java.lang.UnsupportedOperationException - when this operation is not supported

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

java.lang.IndexOutOfBoundsException - if the specified index is out of range

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.

writeObject

private void writeObject(java.io.ObjectOutputStream out)
                  throws java.io.IOException

Throws:

java.io.IOException

readObject

private void readObject(java.io.ObjectInputStream in)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Throws:

java.io.IOException

java.lang.ClassNotFoundException

checkRange

private final void checkRange(int index)

checkRangeIncludingEndpoint

private final void checkRangeIncludingEndpoint(int index)