bak.pcj.adapter
Class IteratorToBooleanIteratorAdapter

java.lang.Object
  bak.pcj.adapter.IteratorToBooleanIteratorAdapter

All Implemented Interfaces:

BooleanIterator

public class IteratorToBooleanIteratorAdapter

extends Object

implements BooleanIterator

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

      CollectionToBooleanCollectionAdapter s;
      ...
      assert s.validate();
  

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

      CollectionToBooleanCollectionAdapter 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

IteratorToBooleanIteratorAdapter(Iterator iterator)
Creates a new adaption to an iterator over boolean values.

Method Summary

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

IteratorToBooleanIteratorAdapter

public IteratorToBooleanIteratorAdapter(Iterator iterator)

Creates a new adaption to an iterator over boolean values.

Parameters:

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

Throws:

NullPointerException - if iterator is null.

Method Detail

hasNext

public boolean hasNext()

Description copied from interface: BooleanIterator

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

Specified by:

hasNext in interface BooleanIterator

Returns:

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

See Also:

BooleanIterator.next()

next

public boolean next()

Description copied from interface: BooleanIterator

Returns the next boolean value of this iterator.

Specified by:

next in interface BooleanIterator

Returns:

the next boolean value of this iterator.

Throws:

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

See Also:

BooleanIterator.hasNext()

remove

public void remove()

Description copied from interface: BooleanIterator

Removes the last boolean value returned from the underlying collection.

Specified by:

remove in interface BooleanIterator