⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
org.apache.commons.collections.iterators

Class AbstractIteratorDecorator

java.lang.Object
|
+--org.apache.commons.collections.iterators.AbstractIteratorDecorator

All Implemented Interfaces:
Iterator

Known Direct Subclasses:
AbstractDualBidiMap.EntrySetIterator, AbstractDualBidiMap.KeySetIterator, AbstractDualBidiMap.ValuesIterator


public class AbstractIteratorDecorator
extends java.lang.Object
implements Iterator

Provides basic behaviour for decorating an iterator with extra functionality.

All methods are forwarded to the decorated iterator.

Since:
Commons Collections 3.0
Authors:
James Strachan
Stephen Colebourne

Field Summary

Iterator

iterator

The iterator being decorated

Constructor Summary

AbstractIteratorDecorator(Iterator iterator)

Constructor that decorates the specified iterator.

Method Summary

Iterator

getIterator()

Gets the iterator being decorated.

boolean

hasNext()

Object

next()

void

remove()

Field Details

iterator

protected final Iterator iterator

The iterator being decorated

Constructor Details

AbstractIteratorDecorator

public AbstractIteratorDecorator(Iterator iterator)

Constructor that decorates the specified iterator.

Parameters:
iterator - the iterator to decorate, must not be null
Throws:
- if the collection is null

Method Details

getIterator

protected Iterator getIterator()

Gets the iterator being decorated.

Returns:
the decorated iterator

hasNext

public boolean hasNext()


next

public Object next()


remove

public void remove()