bak.pcj.adapter
Class IteratorToCharIteratorAdapter

java.lang.Object
  bak.pcj.adapter.IteratorToCharIteratorAdapter

All Implemented Interfaces:

CharIterator

public class IteratorToCharIteratorAdapter

extends Object

implements CharIterator

This class represents adaptions of Java Collections Framework iterators to primitive 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

Constructor Summary

IteratorToCharIteratorAdapter(Iterator iterator)
Creates a new adaption to an iterator over char values.

Method Summary

boolean	hasNext() Indicates whether more char values can be returned by this iterator.
char	next() Returns the next char value of this iterator.
void	remove() Removes the last char value returned from the underlying collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

IteratorToCharIteratorAdapter

public IteratorToCharIteratorAdapter(Iterator iterator)

Creates a new adaption to an iterator over char values.

Parameters:

iterator - the underlying iterator. This iterator must return values of class Character. Otherwise a ClassCastException will be thrown by next().

Throws:

NullPointerException - if iterator is null.

Method Detail

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

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.

Throws:

ClassCastException - if the underlying iterator returns an object that is not of class Character.

See Also:

CharIterator.hasNext()

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