bak.pcj.list
Class CharArrayList

java.lang.Object
  bak.pcj.AbstractCharCollection
      bak.pcj.list.AbstractCharList
          bak.pcj.list.CharArrayList

All Implemented Interfaces:

CharCollection, CharList, Cloneable, Serializable

Direct Known Subclasses:

CharArrayStack

public class CharArrayList

extends AbstractCharList

implements Cloneable, Serializable

This class represents an array implemenation of lists of char values.

Since:

1.0

See Also:

ArrayList, Serialized Form

Field Summary

static int	DEFAULT_CAPACITY The default capacity of this list.
static int	DEFAULT_GROWTH_CHUNK The default chunk size with which to increase the capacity of this list.
static double	DEFAULT_GROWTH_FACTOR The default factor with which to increase the capacity of this list.

Constructor Summary

CharArrayList()
Creates a new array list with capacity 10 and a relative growth factor of 1.0.

CharArrayList(char[] a)
Creates a new array list with the same elements as a specified array.

CharArrayList(CharCollection c)
Creates a new array list with the same elements as a specified collection.

CharArrayList(int capacity)
Creates a new array list with a specified capacity and a relative growth factor of 1.0.

CharArrayList(int capacity, double growthFactor)
Creates a new array list with a specified capacity and relative growth factor.

CharArrayList(int capacity, int growthChunk)
Creates a new array list with a specified capacity and absolute growth factor.

Method Summary

void	add(int index, char v) Throws UnsupportedOperationException.
int	capacity() Returns the current capacity of this list.
void	clear() Clears this collection.
Object	clone() Returns a clone of this array list.
boolean	contains(char v) Indicates whether this collection contains a specified element.
int	ensureCapacity(int capacity) Ensures that this list has at least a specified capacity.
boolean	equals(Object obj) Indicates whether this collection is equal to some object.
char	get(int index) Returns the element at a specified position in this list.
int	hashCode() Returns a hash code value for this collection.
int	indexOf(char c) Returns the index of the first occurance of a specified element in this list.
int	indexOf(int index, char c) Returns the index of the first occurance of a specified element in this list after or at a specified index.
boolean	isEmpty() Indicates whether this collection is empty.
int	lastIndexOf(char c) Returns the index of the last occurance of a specified element in this list.
boolean	remove(char v) Removes a specified element from this collection.
char	removeElementAt(int index) Throws UnsupportedOperationException.
char	set(int index, char v) Sets a specified element to a new value.
int	size() Returns the number of elements in this collection.
char[]	toArray() Returns the elements of this collection as an array.
char[]	toArray(char[] a) Returns the elements of this collection as an array.
void	trimToSize() Minimizes the memory used by this array list.

Methods inherited from class bak.pcj.list.AbstractCharList

add, addAll, iterator, lastIndexOf, listIterator, listIterator

Methods inherited from class bak.pcj.AbstractCharCollection

addAll, containsAll, removeAll, retainAll, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface bak.pcj.CharCollection

addAll, containsAll, removeAll, retainAll

Field Detail

DEFAULT_GROWTH_FACTOR

public static final double DEFAULT_GROWTH_FACTOR

The default factor with which to increase the capacity of this list.

See Also:

Constant Field Values

DEFAULT_GROWTH_CHUNK

public static final int DEFAULT_GROWTH_CHUNK

The default chunk size with which to increase the capacity of this list.

See Also:

Constant Field Values

DEFAULT_CAPACITY

public static final int DEFAULT_CAPACITY

The default capacity of this list.

See Also:

Constant Field Values

Constructor Detail

CharArrayList

public CharArrayList()

Creates a new array list with capacity 10 and a relative growth factor of 1.0.

See Also:

CharArrayList(int,double)

CharArrayList

public CharArrayList(CharCollection c)

Creates a new array list with the same elements as a specified collection. The elements of the specified collection are added to the end of the list in the collection's iteration order.

Parameters:

c - the collection whose elements to add to the new list.

Throws:

NullPointerException - if c is null.

CharArrayList

public CharArrayList(char[] a)

Creates a new array list with the same elements as a specified array. The elements of the specified array are added to the end of the list in order of the array.

Parameters:

a - the array whose elements to add to the new list.

Throws:

NullPointerException - if a is null.

Since:

1.1

CharArrayList

public CharArrayList(int capacity)

Creates a new array list with a specified capacity and a relative growth factor of 1.0.

Parameters:

capacity - the initial capacity of the list.

Throws:

IllegalArgumentException - if capacity is negative.

See Also:

CharArrayList(int,double)

CharArrayList

public CharArrayList(int capacity,
                     double growthFactor)

Creates a new array list with a specified capacity and relative growth factor.

The array capacity increases to capacity()*(1+growthFactor). This strategy is good for avoiding many capacity increases, but the amount of wasted memory is approximately the size of the list.

Parameters:

capacity - the initial capacity of the list.

growthFactor - the relative amount with which to increase the the capacity when a capacity increase is needed.

Throws:

IllegalArgumentException - if capacity is negative; if growthFactor is negative.

CharArrayList

public CharArrayList(int capacity,
                     int growthChunk)

Creates a new array list with a specified capacity and absolute growth factor.

The array capacity increases to capacity()+growthChunk. This strategy is good for avoiding wasting memory. However, an overhead is potentially introduced by frequent capacity increases.

Parameters:

capacity - the initial capacity of the list.

growthChunk - the absolute amount with which to increase the the capacity when a capacity increase is needed.

Throws:

IllegalArgumentException - if capacity is negative; if growthChunk is negative.

Method Detail

ensureCapacity

public int ensureCapacity(int capacity)

Ensures that this list has at least a specified capacity. The actual capacity is calculated from the growth factor or growth chunk specified to the constructor.

Parameters:

capacity - the minimum capacity of this list.

Returns:

the new capacity of this list.

See Also:

capacity()

capacity

public int capacity()

Returns the current capacity of this list. The capacity is the number of elements that the list can contain without having to increase the amount of memory used.

Returns:

the current capacity of this list.

See Also:

ensureCapacity(int)

add

public void add(int index,
                char v)

Description copied from class: AbstractCharList

Throws UnsupportedOperationException.

Specified by:

add in interface CharList

Overrides:

add in class AbstractCharList

get

public char get(int index)

Description copied from interface: CharList

Returns the element at a specified position in this list.

Specified by:

get in interface CharList

Parameters:

index - the position of the element to return.

Returns:

the element at the specified position.

set

public char set(int index,
                char v)

Description copied from interface: CharList

Sets a specified element to a new value.

Specified by:

set in interface CharList

Parameters:

index - the index of the element whose value to set.

v - the new value of the specified element.

Returns:

the previous value of the element.

removeElementAt

public char removeElementAt(int index)

Description copied from class: AbstractCharList

Throws UnsupportedOperationException.

Specified by:

removeElementAt in interface CharList

Overrides:

removeElementAt in class AbstractCharList

trimToSize

public void trimToSize()

Minimizes the memory used by this array list. The underlying array is replaced by an array whose size is exactly the number of elements in this array list. The method can be used to free up memory after many removals.

Specified by:

trimToSize in interface CharCollection

Overrides:

trimToSize in class AbstractCharCollection

clone

public Object clone()

Returns a clone of this array list.

Returns:

a clone of this array list.

Since:

1.1

size

public int size()

Description copied from interface: CharCollection

Returns the number of elements in this collection.

Specified by:

size in interface CharCollection

Overrides:

size in class AbstractCharCollection

isEmpty

public boolean isEmpty()

Description copied from interface: CharCollection

Indicates whether this collection is empty.

Specified by:

isEmpty in interface CharCollection

Overrides:

isEmpty in class AbstractCharCollection

clear

public void clear()

Description copied from interface: CharCollection

Clears this collection.

Specified by:

clear in interface CharCollection

Overrides:

clear in class AbstractCharCollection

contains

public boolean contains(char v)

Description copied from interface: CharCollection

Indicates whether this collection contains a specified element.

Specified by:

contains in interface CharCollection

Overrides:

contains in class AbstractCharCollection

indexOf

public int indexOf(char c)

Description copied from interface: CharList

Returns the index of the first occurance of a specified element in this list.

Specified by:

indexOf in interface CharList

Overrides:

indexOf in class AbstractCharList

indexOf

public int indexOf(int index,
                   char c)

Description copied from interface: CharList

Returns the index of the first occurance of a specified element in this list after or at a specified index.

Specified by:

indexOf in interface CharList

Overrides:

indexOf in class AbstractCharList

Since:

1.2

lastIndexOf

public int lastIndexOf(char c)

Description copied from interface: CharList

Returns the index of the last occurance of a specified element in this list.

Specified by:

lastIndexOf in interface CharList

Overrides:

lastIndexOf in class AbstractCharList

remove

public boolean remove(char v)

Description copied from interface: CharCollection

Removes a specified element from this collection.

Specified by:

remove in interface CharCollection

Overrides:

remove in class AbstractCharCollection

toArray

public char[] toArray()

Description copied from interface: CharCollection

Returns the elements of this collection as an array.

Specified by:

toArray in interface CharCollection

Overrides:

toArray in class AbstractCharCollection

toArray

public char[] toArray(char[] a)

Description copied from interface: CharCollection

Returns the elements of this collection as an array.

Specified by:

toArray in interface CharCollection

Overrides:

toArray in class AbstractCharCollection

equals

public boolean equals(Object obj)

Description copied from interface: CharCollection

Indicates whether this collection is equal to some object.

Specified by:

equals in interface CharCollection

Overrides:

equals in class AbstractCharList

hashCode

public int hashCode()

Description copied from interface: CharCollection

Returns a hash code value for this collection.

Specified by:

hashCode in interface CharCollection

Overrides:

hashCode in class AbstractCharList