bak.pcj.adapter
Class ListToCharListAdapter

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

All Implemented Interfaces:

CharCollection, CharList

public class ListToCharListAdapter

extends AbstractCharList

This class represents adaptions of Java Collections Framework lists to primitive lists of char values. The adapter is implemented as a wrapper around the list. Thus, changes to the underlying list are reflected by this list and vice versa.

Adapters from JCF collections to primitive collections will fail if the JCF collection contains null values or values of the wrong class. However, adapters are not fast failing in the case that the underlying collection should contain illegal values. To implement fast failure would require every operation to check every element of the underlying collection before doing anything. Instead validation methods are provided. They can be called using the assertion facility in the client code:

      ListToCharListAdapter s;
      ...
      assert s.validate();
  

or by letting the adapter throw an exception on illegal values:

      ListToCharListAdapter s;
      ...
      s.evalidate();  // Throws an exception on illegal values
  

Either way, validation must be invoked directly by the client code.

Since:

1.0

Field Summary

protected List

list The underlying list.

Constructor Summary

ListToCharListAdapter(List list)
Creates a new adaption of a list to a list of char values.

ListToCharListAdapter(List list, boolean validate)
Creates a new adaption of a list to a list of char values.

Method Summary

void	add(int index, char v) Throws UnsupportedOperationException.
void	evalidate() Validates the list underlying this adapter and throws an exception if it is invalid.
char	get(int index) Returns the element at a specified position in this list.
CharListIterator	listIterator(int index) Returns a list iterator over this list, starting from a specified index.
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.
boolean	validate() Indicates whether the underlying list is valid for this adapter.

Methods inherited from class bak.pcj.list.AbstractCharList

add, addAll, equals, hashCode, indexOf, indexOf, iterator, lastIndexOf, lastIndexOf, listIterator

Methods inherited from class bak.pcj.AbstractCharCollection

addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, 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.CharCollection

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

Field Detail

list

protected List list

The underlying list.

Constructor Detail

ListToCharListAdapter

public ListToCharListAdapter(List list)

Creates a new adaption of a list to a list of char values.

Parameters:

list - the underlying list. This list must consist of values of class Character. Otherwise a ClassCastException will be thrown by some methods.

Throws:

NullPointerException - if list is null.

ListToCharListAdapter

public ListToCharListAdapter(List list,
                             boolean validate)

Creates a new adaption of a list to a list of char values. The list to adapt is optionally validated.

Parameters:

list - the underlying list. This collection must consist of values of class Character. Otherwise a ClassCastException will be thrown by some methods.

validate - indicates whether list should be checked for illegal values.

Throws:

NullPointerException - if list is null.

IllegalStateException - if validate is true and list contains a null value or a value that is not of class Character.

Method Detail

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.

Parameters:

index - the position of the element to return.

Returns:

the element at the specified position.

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

Overrides:

listIterator in class AbstractCharList

removeElementAt

public char removeElementAt(int index)

Description copied from class: AbstractCharList

Throws UnsupportedOperationException.

Specified by:

removeElementAt in interface CharList

Overrides:

removeElementAt in class AbstractCharList

set

public char set(int index,
                char v)

Description copied from interface: CharList

Sets a specified element to a new value.

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.

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

validate

public boolean validate()

Indicates whether the underlying list is valid for this adapter. For the underlying list to be valid, it can only contain Character values and no null values.

Returns:

true if the underlying list is valid; returns false otherwise.

evalidate

public void evalidate()

Validates the list underlying this adapter and throws an exception if it is invalid. For the underlying list to be valid, it can only contain Character values and no null values.

Throws:

IllegalStateException - if the underlying list is invalid.