bak.pcj.list
Class AbstractCharList

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

All Implemented Interfaces:

CharCollection, CharList

Direct Known Subclasses:

CharArrayDeque, CharArrayList, ListToCharListAdapter

public abstract class AbstractCharList

extends AbstractCharCollection

implements CharList

This class represents an abstract base for implementing lists of char values. All operations that can be implemented using iterators and the get() and set() methods are implemented as such. In most cases, this is hardly an efficient solution, and at least some of those methods should be overridden by sub-classes.

Since:

1.0

Constructor Summary

protected

AbstractCharList() Default constructor to be invoked by sub-classes.

Method Summary

boolean	add(char v) Adds an element to this collection.
void	add(int index, char v) Throws UnsupportedOperationException.
boolean	addAll(int index, CharCollection c) Adds all the elements of a specified collection to this list starting at a specified index.
boolean	equals(Object obj) Indicates whether this collection is equal to some object.
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.
CharIterator	iterator() Returns an iterator over this collection.
int	lastIndexOf(char c) Returns the index of the last occurance of a specified element in this list.
int	lastIndexOf(int index, char c) Returns the index of the last occurance of a specified element in this list before a specified index.
CharListIterator	listIterator() Returns a list iterator over this list.
CharListIterator	listIterator(int index) Returns a list iterator over this list, starting from a specified index.
char	removeElementAt(int index) Throws UnsupportedOperationException.

Methods inherited from class bak.pcj.AbstractCharCollection

addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, toArray, toArray, toString, trimToSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface bak.pcj.list.CharList

get, set

Methods inherited from interface bak.pcj.CharCollection

addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, size, toArray, toArray, trimToSize

Constructor Detail

AbstractCharList

protected AbstractCharList()

Default constructor to be invoked by sub-classes.

Method Detail

add

public boolean add(char v)

Description copied from interface: CharCollection

Adds an element to this collection.

Specified by:

add in interface CharCollection

Overrides:

add in class AbstractCharCollection

add

public void add(int index,
                char v)

Throws UnsupportedOperationException.

Specified by:

add in interface CharList

Parameters:

index - the index at which to add the element. If index == size() the element is appended to this list.

v - the char value to add to this list.

Throws:

UnsupportedOperationException - unconditionally.

See Also:

CharCollection.add(char), CharCollection.addAll(CharCollection), CharList.addAll(int,CharCollection)

addAll

public boolean addAll(int index,
                      CharCollection c)

Description copied from interface: CharList

Adds all the elements of a specified collection to this list starting at a specified index. The elements are inserted in the specified collection's iteration order. All elements from the specified index and forward are pushed to their successors' indices (c.size() indices).

Specified by:

addAll in interface CharList

Parameters:

index - the index at which to insert the elements of the specified collection. If index == size() the elements are appended to this list.

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

Returns:

true if this list was modified as a result of adding the elements of c; returns false otherwise.

See Also:

CharCollection.add(char), CharList.add(int, char), CharCollection.addAll(CharCollection)

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

Parameters:

c - the element to find.

Returns:

the index of the first occurance of the specified element in this list; returns -1, if the element is not contained in this list.

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

Parameters:

c - the element to find.

index - the index at which to start the search.

Returns:

the index of the first occurance of the specified element in this list; returns -1, if the element is not contained in this list.

Since:

1.2

iterator

public CharIterator iterator()

Description copied from interface: CharCollection

Returns an iterator over this collection.

Specified by:

iterator in interface CharCollection

Returns:

an iterator over this collection.

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

Parameters:

c - the element to find.

Returns:

the index of the last occurance of the specified element in this list; returns -1, if the element is not contained in this list.

lastIndexOf

public int lastIndexOf(int index,
                       char c)

Description copied from interface: CharList

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

Specified by:

lastIndexOf in interface CharList

Parameters:

c - the element to find.

index - the index at which to start the search. Note that the element at index is not included in the search.

Returns:

the index of the last occurance of the specified element in this list; returns -1, if the element is not contained in this list.

listIterator

public CharListIterator listIterator()

Description copied from interface: CharList

Returns a list iterator over this list.

Specified by:

listIterator in interface CharList

Returns:

a list iterator over this list.

listIterator

public CharListIterator listIterator(int index)

Description copied from interface: CharList

Returns a list iterator over this list, starting from a specified index.

Specified by:

listIterator in interface CharList

Parameters:

index - the index at which to begin the iteration.

Returns:

a list iterator over this list.

removeElementAt

public char removeElementAt(int index)

Throws UnsupportedOperationException.

Specified by:

removeElementAt in interface CharList

Parameters:

index - the index of the element to remove.

Returns:

the value of the element removed.

Throws:

UnsupportedOperationException - unconditionally.

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

hashCode

public int hashCode()

Description copied from interface: CharCollection

Returns a hash code value for this collection.

Specified by:

hashCode in interface CharCollection