org.chromattic.common.collection
Class AbstractFilterIterator<E,I>

java.lang.Object
  org.chromattic.common.collection.AbstractFilterIterator<E,I>

All Implemented Interfaces:

java.util.Iterator<E>

Direct Known Subclasses:

FilterIterator

public abstract class AbstractFilterIterator<E,I>
extends java.lang.Object
implements java.util.Iterator<E>

An iterator that filter the elements of a delegate iterator allowing to skip some elements and to perform type conversion.

Version:

$Revision$

Author:

Julien Viet

Constructor Summary

AbstractFilterIterator(java.util.Iterator<I> iterator)
Create a new filter iterator.

Method Summary

protected abstract E	adapt(I internal) Adapts the internal element as an external element.
boolean	hasNext()
E	next()
void	remove()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFilterIterator

public AbstractFilterIterator(java.util.Iterator<I> iterator)
                       throws java.lang.NullPointerException

Create a new filter iterator.

Parameters:

iterator - the iterator

Throws:

java.lang.NullPointerException - if the iterator is null

Method Detail

hasNext

public final boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<E>

next

public final E next()

Specified by:

next in interface java.util.Iterator<E>

remove

public void remove()

Specified by:

remove in interface java.util.Iterator<E>

adapt

protected abstract E adapt(I internal)

Adapts the internal element as an external element. Returning a null external element means that the element must be skipped and not considered by the iterator.

Parameters:

internal - the internal element

Returns:

the external element