edu.ucla.sspace.util

Class IteratorDecorator<T>

java.lang.Object

edu.ucla.sspace.util.IteratorDecorator<T>

All Implemented Interfaces:

Serializable, Iterator<T>

public class IteratorDecorator<T>
extends Object
implements Iterator<T>, Serializable

A decorator around an existing Iterator that is designed to facilitate subclasses that need to extend the functionality of an existing iterator. For example, a subclass of this may need to perform additional clean-up after a remove() operation, or may need to ensure that the current element meets some additional criteria by altering the behavior of hasNext().

In its default behavior, this class performs identically to the backing iterator, passing all method calls through and return the respective values.

Author:

David Jurgens

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected T	cur The element that was just returned or null if no elements have been returned yet or if the current element was removed via remove().

Constructor Summary

Constructors

Constructor and Description
IteratorDecorator(Iterator<T> iter) Creates a new decorator around the existing iterator.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasNext() Returns true if this iterator has more elements to return
T	next() Returns the next element
void	remove() Removes the current element if the backing iterator supports removal.

Methods inherited from class java.lang.Object

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

Field Detail

cur

protected T cur

The element that was just returned or null if no elements have been returned yet or if the current element was removed via remove().

Constructor Detail

IteratorDecorator

public IteratorDecorator(Iterator<T> iter)

Creates a new decorator around the existing iterator.

Method Detail

hasNext

public boolean hasNext()

Returns true if this iterator has more elements to return

Specified by:

hasNext in interface Iterator<T>

next

public T next()

Returns the next element

Specified by:

next in interface Iterator<T>

remove

public void remove()

Removes the current element if the backing iterator supports removal.

Specified by:

remove in interface Iterator<T>