bak.pcj.adapter
Class IteratorToFloatIteratorAdapter

java.lang.Object
  bak.pcj.adapter.IteratorToFloatIteratorAdapter

All Implemented Interfaces:

FloatIterator

public class IteratorToFloatIteratorAdapter

extends Object

implements FloatIterator

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

      CollectionToFloatCollectionAdapter s;
      ...
      assert s.validate();
  

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

      CollectionToFloatCollectionAdapter 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

IteratorToFloatIteratorAdapter(Iterator iterator)
Creates a new adaption to an iterator over float values.

Method Summary

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

IteratorToFloatIteratorAdapter

public IteratorToFloatIteratorAdapter(Iterator iterator)

Creates a new adaption to an iterator over float values.

Parameters:

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

Throws:

NullPointerException - if iterator is null.

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: FloatIterator

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

Specified by:

hasNext in interface FloatIterator

Returns:

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

See Also:

FloatIterator.next()

next

public float next()

Description copied from interface: FloatIterator

Returns the next float value of this iterator.

Specified by:

next in interface FloatIterator

Returns:

the next float value of this iterator.

Throws:

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

See Also:

FloatIterator.hasNext()

remove

public void remove()

Description copied from interface: FloatIterator

Removes the last float value returned from the underlying collection.

Specified by:

remove in interface FloatIterator