bak.pcj.adapter
Class IteratorToIntIteratorAdapter

java.lang.Object
  bak.pcj.adapter.IteratorToIntIteratorAdapter

All Implemented Interfaces:

IntIterator

public class IteratorToIntIteratorAdapter

extends Object

implements IntIterator

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

      CollectionToIntCollectionAdapter s;
      ...
      assert s.validate();
  

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

      CollectionToIntCollectionAdapter 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

IteratorToIntIteratorAdapter(Iterator iterator)
Creates a new adaption to an iterator over int values.

Method Summary

boolean	hasNext() Indicates whether more int values can be returned by this iterator.
int	next() Returns the next int value of this iterator.
void	remove() Removes the last int 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

IteratorToIntIteratorAdapter

public IteratorToIntIteratorAdapter(Iterator iterator)

Creates a new adaption to an iterator over int values.

Parameters:

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

Throws:

NullPointerException - if iterator is null.

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: IntIterator

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

Specified by:

hasNext in interface IntIterator

Returns:

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

See Also:

IntIterator.next()

next

public int next()

Description copied from interface: IntIterator

Returns the next int value of this iterator.

Specified by:

next in interface IntIterator

Returns:

the next int value of this iterator.

Throws:

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

See Also:

IntIterator.hasNext()

remove

public void remove()

Description copied from interface: IntIterator

Removes the last int value returned from the underlying collection.

Specified by:

remove in interface IntIterator