bak.pcj.adapter
Class ListIteratorToCharListIteratorAdapter

java.lang.Object
  bak.pcj.adapter.ListIteratorToCharListIteratorAdapter

All Implemented Interfaces:

CharIterator, CharListIterator

public class ListIteratorToCharListIteratorAdapter

extends Object

implements CharListIterator

This class represents adaptions of Java Collections Framework list iterators to primitive list iterators over char values.

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:

      CollectionToCharCollectionAdapter s;
      ...
      assert s.validate();
  

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

      CollectionToCharCollectionAdapter 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 ListIterator

iterator The underlying iterator.

Constructor Summary

ListIteratorToCharListIteratorAdapter(ListIterator iterator)
Creates a new adaption of a list iterator to a primitive list iterator over char values.

Method Summary

void	add(char v) Adds a specified element to the list at this iterator's current position.
boolean	hasNext() Indicates whether more char values can be returned by this iterator.
boolean	hasPrevious() Indicates whether more char values can be returned by this iterator by calling previous().
char	next() Returns the next char value of this iterator.
int	nextIndex() Returns the index of the element that would be returned by a call to next().
char	previous() Returns the previous char value of this iterator.
int	previousIndex() Returns the index of the element that would be returned by a call to previous().
void	remove() Removes the last char value returned from the underlying collection.
void	set(char v) Sets the last element returned to a specified value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

iterator

protected ListIterator iterator

The underlying iterator.

Constructor Detail

ListIteratorToCharListIteratorAdapter

public ListIteratorToCharListIteratorAdapter(ListIterator iterator)

Creates a new adaption of a list iterator to a primitive list iterator over char values.

Parameters:

iterator - the iterator to adapt to a primitive iterator.

Throws:

NullPointerException - if iterator is null.

Method Detail

add

public void add(char v)

Description copied from interface: CharListIterator

Adds a specified element to the list at this iterator's current position.

Specified by:

add in interface CharListIterator

Parameters:

v - the element to add.

hasNext

public boolean hasNext()

Description copied from interface: CharIterator

Indicates whether more char values can be returned by this iterator.

Specified by:

hasNext in interface CharIterator

Returns:

true if more char values can be returned by this iterator; returns false otherwise.

See Also:

CharIterator.next()

hasPrevious

public boolean hasPrevious()

Description copied from interface: CharListIterator

Indicates whether more char values can be returned by this iterator by calling previous().

Specified by:

hasPrevious in interface CharListIterator

Returns:

true if more char values can be returned by this iterator in backwards direction; returns false otherwise.

See Also:

CharListIterator.previous()

next

public char next()

Description copied from interface: CharIterator

Returns the next char value of this iterator.

Specified by:

next in interface CharIterator

Returns:

the next char value of this iterator.

See Also:

CharIterator.hasNext()

nextIndex

public int nextIndex()

Description copied from interface: CharListIterator

Returns the index of the element that would be returned by a call to next().

Specified by:

nextIndex in interface CharListIterator

Returns:

the index of the element that would be returned by a call to next().

See Also:

CharIterator.next()

previous

public char previous()

Description copied from interface: CharListIterator

Returns the previous char value of this iterator.

Specified by:

previous in interface CharListIterator

Returns:

the previous char value of this iterator.

See Also:

CharListIterator.hasPrevious()

previousIndex

public int previousIndex()

Description copied from interface: CharListIterator

Returns the index of the element that would be returned by a call to previous().

Specified by:

previousIndex in interface CharListIterator

Returns:

the index of the element that would be returned by a call to previous(); if no more elements are available in backwards direction, -1 is returned.

See Also:

CharListIterator.previous()

remove

public void remove()

Description copied from interface: CharIterator

Removes the last char value returned from the underlying collection.

Specified by:

remove in interface CharIterator

set

public void set(char v)

Description copied from interface: CharListIterator

Sets the last element returned to a specified value.

Specified by:

set in interface CharListIterator

Parameters:

v - the new value of the element.