org.apache.commons.collections.primitives.adapters
Class ListCharList

java.lang.Object
  |
  +--org.apache.commons.collections.primitives.adapters.AbstractCollectionCharCollection
        |
        +--org.apache.commons.collections.primitives.adapters.AbstractListCharList
              |
              +--org.apache.commons.collections.primitives.adapters.ListCharList

All Implemented Interfaces:

CharCollection, CharList, Serializable

public class ListCharList

extends org.apache.commons.collections.primitives.adapters.AbstractListCharList

implements Serializable

Adapts a Number-valued List to the CharList interface.

This implementation delegates most methods to the provided List implementation in the "obvious" way.

Since:

Commons Primitives 1.0

Version:

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

See Also:

Serialized Form

Constructor Summary

ListCharList(List list)
Creates an CharList wrapping the specified List.

Method Summary

boolean	add(char element) Appends the specified element to the end of me (optional operation).
void	add(int index, char element) Inserts the specified element at the specified position (optional operation).
boolean	addAll(org.apache.commons.collections.primitives.CharCollection c) Adds all of the elements in the specified collection to me (optional operation).
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).
void	clear() Removes all my elements (optional operation).
boolean	contains(char element) Returns true iff I contain the specified element.
boolean	containsAll(org.apache.commons.collections.primitives.CharCollection c) Returns true iff I contain all of the elements in the given collection.
boolean	equals(Object obj) Returns true iff that is an CharList that contains the same elements in the same order as me.
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.
boolean	isEmpty() Returns true iff I contain no elements.
org.apache.commons.collections.primitives.CharIterator	iterator() wraps the Iterator returned by my underlying Collection, if any.
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() wraps the CharList returned by my underlying CharListIterator, if any.
org.apache.commons.collections.primitives.CharListIterator	listIterator(int index) wraps the CharList returned by my underlying CharListIterator, if any.
boolean	removeAll(org.apache.commons.collections.primitives.CharCollection c) Removes all of my elements that are contained in the specified collection (optional operation).
boolean	removeElement(char element) Removes a single occurrence of the specified element (optional operation).
char	removeElementAt(int index) Removes the element at the specified position in (optional operation).
boolean	retainAll(org.apache.commons.collections.primitives.CharCollection c) Removes all of my elements that are not contained in the specified collection (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.
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.
char[]	toArray() Returns an array containing all of my elements.
char[]	toArray(char[] dest) Returns an array containing all of my elements, using the given array if it is large enough.
String	toString()
static org.apache.commons.collections.primitives.CharList	wrap(List list) Create an CharList wrapping the specified List.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

add, iterator

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

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

Constructor Detail

ListCharList

public ListCharList(List list)

Creates an CharList wrapping the specified List.

See Also:

wrap(java.util.List)

Method Detail

wrap

public static org.apache.commons.collections.primitives.CharList wrap(List list)

Create an CharList wrapping the specified List. When the given list is null, returns null.

Parameters:

list - the (possibly null) List to wrap

Returns:

a CharList wrapping the given list, or null when list is null.

toString

public String toString()

Overrides:

toString in class org.apache.commons.collections.primitives.adapters.AbstractCollectionCharCollection

add

public void add(int index,
                char element)

Description copied from interface: CharList

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

Parameters:

index - the index at which to insert the element

element - the value to insert

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

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

Parameters:

index - the index of the element to return

Returns:

the value of the element at the specified position

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

listIterator

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

wraps the CharList returned by my underlying CharListIterator, if any.

Specified by:

listIterator in interface CharList

listIterator

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

wraps the CharList returned by my underlying CharListIterator, if any.

Specified by:

listIterator in interface CharList

removeElementAt

public char removeElementAt(int index)

Description copied from interface: CharList

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

Parameters:

index - the index of the element to remove

Returns:

the value of the element that was removed

set

public char set(int index,
                char element)

Description copied from interface: CharList

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

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

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 obj)

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:

obj - 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

add

public boolean add(char element)

Description copied from interface: CharCollection

Ensures that I contain the specified element (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 CharCollection

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(org.apache.commons.collections.primitives.CharCollection c)

Description copied from interface: CharCollection

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

Specified by:

addAll in interface CharCollection

Parameters:

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

Returns:

true iff I changed as a result of this call

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

contains

public boolean contains(char element)

Description copied from interface: CharCollection

Returns true iff I contain the specified element.

Specified by:

contains in interface CharCollection

Parameters:

element - the value whose presence within me is to be tested

Returns:

true iff I contain the specified element

containsAll

public boolean containsAll(org.apache.commons.collections.primitives.CharCollection c)

Description copied from interface: CharCollection

Returns true iff I contain all of the elements in the given collection.

Specified by:

containsAll in interface CharCollection

Parameters:

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

Returns:

true iff I contain the all the specified elements

isEmpty

public boolean isEmpty()

Description copied from interface: CharCollection

Returns true iff I contain no elements.

Specified by:

isEmpty in interface CharCollection

Returns:

true iff I contain no elements.

iterator

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

wraps the Iterator returned by my underlying Collection, if any.

Specified by:

iterator in interface CharCollection

Returns:

an iterator over all my elements.

removeElement

public boolean removeElement(char element)

Description copied from interface: CharCollection

Removes a single occurrence of the specified element (optional operation).

Specified by:

removeElement in interface CharCollection

Parameters:

element - the element to remove, if present

Returns:

true iff I contained the specified element, in other words, iff I changed as a result of this call

removeAll

public boolean removeAll(org.apache.commons.collections.primitives.CharCollection c)

Description copied from interface: CharCollection

Removes all of my elements that are contained in the specified collection (optional operation). The behavior of this method is unspecified if the given collection is modified while this method is executing. Note that this includes the case in which the given collection is this collection, and it is not empty.

Specified by:

removeAll in interface CharCollection

Parameters:

c - the collection of elements to remove

Returns:

true iff I contained the at least one of the specified elements, in other words, returns true iff I changed as a result of this call

retainAll

public boolean retainAll(org.apache.commons.collections.primitives.CharCollection c)

Description copied from interface: CharCollection

Removes all of my elements that are not contained in the specified collection (optional operation). (In other words, retains only my elements that are contained in the specified collection.) The behavior of this method is unspecified if the given collection is modified while this method is executing.

Specified by:

retainAll in interface CharCollection

Parameters:

c - the collection of elements to retain

Returns:

true iff I changed as a result of this call

size

public int size()

Description copied from interface: CharCollection

Returns the number of elements I contain.

Specified by:

size in interface CharCollection

Returns:

the number of elements I contain

toArray

public char[] toArray()

Description copied from interface: CharCollection

Returns an array containing all of my elements. The length of the returned array will be equal to my size.

The returned array will be independent of me, so that callers may modify that returned array without modifying this collection.

When I guarantee the order in which elements are returned by an iterator, the returned array will contain elements in the same order.

Specified by:

toArray in interface CharCollection

Returns:

an array containing all my elements

toArray

public char[] toArray(char[] dest)

Description copied from interface: CharCollection

Returns an array containing all of my elements, using the given array if it is large enough. When the length of the given array is larger than the number of elements I contain, values outside of my range will be unchanged.

The returned array will be independent of me, so that callers may modify that returned array without modifying this collection.

When I guarantee the order in which elements are returned by an iterator, the returned array will contain elements in the same order.

Specified by:

toArray in interface CharCollection

Parameters:

dest - an array that may be used to contain the elements

Returns:

an array containing all my elements