org.apache.commons.collections.primitives
Class RandomAccessCharList

java.lang.Object
  |
  +--org.apache.commons.collections.primitives.AbstractCharCollection
        |
        +--org.apache.commons.collections.primitives.RandomAccessCharList

All Implemented Interfaces:

CharCollection, CharList

Direct Known Subclasses:

ArrayCharList

public abstract class RandomAccessCharList

extends AbstractCharCollection

implements CharList

Abstract base class for CharLists backed by random access structures like arrays.

Read-only subclasses must override get(int) and size(). Mutable subclasses should also override set(int, char). Variably-sized subclasses should also override add(int, char) and removeElementAt(int). All other methods have at least some base implementation derived from these. Subclasses may choose to override these methods to provide a more efficient implementation.

Since:

Commons Primitives 1.0

Version:

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

Method Summary

boolean	add(char element) Appends the specified element to the end of me (optional operation).
void	add(int index, char element) Unsupported in this implementation.
boolean	addAll(int index, org.apache.commons.collections.primitives.CharCollection collection) Inserts all of the elements in the specified collection into me, at the specified position (optional operation).
boolean	equals(Object that) Returns true iff that is an CharList that contains the same elements in the same order as me.
abstract char	get(int index) Returns the value of the element at the specified position within me.
int	hashCode() Returns my hash code.
int	indexOf(char element) Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain the element.
org.apache.commons.collections.primitives.CharIterator	iterator() Returns an iterator over all my elements, in the appropriate sequence.
int	lastIndexOf(char element) Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.
org.apache.commons.collections.primitives.CharListIterator	listIterator() Returns a bidirectional iterator over all my elements, in the appropriate sequence.
org.apache.commons.collections.primitives.CharListIterator	listIterator(int index) Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position.
char	removeElementAt(int index) Unsupported in this implementation.
char	set(int index, char element) Unsupported in this implementation.
abstract int	size() Returns the number of elements I contain.
org.apache.commons.collections.primitives.CharList	subList(int fromIndex, int toIndex) Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive.
String	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

getClass, notify, notifyAll, wait, wait, wait

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

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

Method Detail

get

public abstract 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

Parameters:

index - the index of the element to return

Returns:

the value of the element at the specified position

size

public abstract 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 AbstractCharCollection

Returns:

the number of elements I contain

removeElementAt

public char removeElementAt(int index)

Unsupported in this implementation.

Specified by:

removeElementAt in interface CharList

Parameters:

index - the index of the element to remove

Returns:

the value of the element that was removed

Throws:

UnsupportedOperationException - since this method is not supported

set

public char set(int index,
                char element)

Unsupported in this implementation.

Specified by:

set in interface CharList

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 - since this method is not supported

add

public void add(int index,
                char element)

Unsupported in this implementation.

Specified by:

add in interface CharList

Parameters:

index - the index at which to insert the element

element - the value to insert

Throws:

UnsupportedOperationException - since this method is not supported

add

public boolean add(char element)

Description copied from interface: CharList

Appends the specified element to the end of me (optional operation). Returns true iff I changed as a result of this call.

If a collection refuses to add the specified element for any reason other than that it already contains the element, it must throw an exception (rather than simply returning false). This preserves the invariant that a collection always contains the specified element after this call returns.

Specified by:

add in interface CharList

Overrides:

add in class AbstractCharCollection

Parameters:

element - the value 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,
                      org.apache.commons.collections.primitives.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

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

indexOf

public int indexOf(char element)

Description copied from interface: CharList

Returns the index of the first occurrence of the specified element within me, or -1 if I do not contain the element.

Specified by:

indexOf in interface CharList

Parameters:

element - the element to search for

Returns:

the smallest index of an element matching the specified value, or -1 if no such matching element can be found

lastIndexOf

public int lastIndexOf(char element)

Description copied from interface: CharList

Returns the index of the last occurrence of the specified element within me, or -1 if I do not contain the element.

Specified by:

lastIndexOf in interface CharList

Parameters:

element - the element to search for

Returns:

the largest index of an element matching the specified value, or -1 if no such matching element can be found

iterator

public org.apache.commons.collections.primitives.CharIterator iterator()

Description copied from interface: CharList

Returns an iterator over all my elements, in the appropriate sequence.

Specified by:

iterator in interface CharList

Specified by:

iterator in class AbstractCharCollection

Returns:

an iterator over all my elements.

listIterator

public org.apache.commons.collections.primitives.CharListIterator listIterator()

Description copied from interface: CharList

Returns a bidirectional iterator over all my elements, in the appropriate sequence.

Specified by:

listIterator in interface CharList

listIterator

public org.apache.commons.collections.primitives.CharListIterator listIterator(int index)

Description copied from interface: CharList

Returns a bidirectional iterator over all my elements, in the appropriate sequence, starting at the specified position. The specified index indicates the first element that would be returned by an initial call to the next method. An initial call to the previous method would return the element with the specified index minus one.

Specified by:

listIterator in interface CharList

subList

public org.apache.commons.collections.primitives.CharList subList(int fromIndex,
                                                                  int toIndex)

Description copied from interface: CharList

Returns a view of the elements within me between the specified fromIndex, inclusive, and toIndex, exclusive. The returned CharList is backed by me, so that any changes in the returned list are reflected in me, and vice-versa. The returned list supports all of the optional operations that I support.

Note that when fromIndex == toIndex, the returned list is initially empty, and when fromIndex == 0 && toIndex == size() the returned list is my "improper" sublist, containing all my elements.

The semantics of the returned list become undefined if I am structurally modified in any way other than via the returned list.

Specified by:

subList in interface CharList

Parameters:

fromIndex - the smallest index (inclusive) in me that appears in the returned list

toIndex - the largest index (exclusive) in me that appears in the returned list

Returns:

a view of this list from fromIndex (inclusive) to toIndex (exclusive)

equals

public boolean equals(Object that)

Description copied from interface: CharList

Returns true iff that is an CharList that contains the same elements in the same order as me. In other words, returns true iff that is an CharList that has the same size as me, and for which the elements returned by its iterator are equal (==) to the corresponding elements within me. (This contract ensures that this method works properly across different implementations of the CharList interface.)

Specified by:

equals in interface CharList

Overrides:

equals in class Object

Parameters:

that - the object to compare to me

Returns:

true iff that is an CharList that contains the same elements in the same order as me

hashCode

public int hashCode()

Description copied from interface: CharList

Returns my hash code.

The hash code of an CharList is defined to be the result of the following calculation:

 int hash = 1;
 for(CharIterator iter = iterator(); iter.hasNext(); ) {
   char value = iter.next();
   hash = 31*hash + (int)(value ^ (value >>> 32));
 }

This contract ensures that this method is consistent with equals and with the hashCode method of a List of Characters.

Specified by:

hashCode in interface CharList

Overrides:

hashCode in class Object

Returns:

my hash code

toString

public String toString()

Overrides:

toString in class Object