AbstractIteratorDecorator (GlobalMentor Core 0.6.2 API)

java.lang.Object
- com.globalmentor.collections.iterators.AbstractIteratorDecorator<E>

Type Parameters:

E - the type of elements returned by this iterator.

All Implemented Interfaces:

java.util.Enumeration<E>, java.util.Iterator<E>

Direct Known Subclasses:

IteratorDecorator, JoinIterator
```
public abstract class AbstractIteratorDecorator<E>
extends java.lang.Object
implements java.util.Iterator<E>, java.util.Enumeration<E>
```
An abstract base implementation of an iterator that wraps an existing Iterator.

Author:

Garret Wilson

API Note:

This iterator also serves as an adapter, converting an iterator to an Enumeration.

Implementation Note:

Subclasses may override hasNext() and/or next(), and Enumeration compatibility will be maintained., This implementation specifically does not override Iterator.forEachRemaining(Consumer) to delegate to the underlying iterator's version of the method, because subclasses are allowed to change the decorated iterator during iteration. Therefore the default method version is retained, which calls hasNext() and next() repeatedly, allowing a subclass to acquire a different underlying iterator if it desires.

Constructor Summary

Constructors
Constructor Description

AbstractIteratorDecorator()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract java.util.Iterator<E>`	`getIterator()`
`boolean`	`hasMoreElements()`
`boolean`	`hasNext()`
`E`	`next()`
`E`	`nextElement()`
`void`	`remove()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Enumeration
asIterator

Methods inherited from interface java.util.Iterator
forEachRemaining

- Constructor Detail
  - AbstractIteratorDecorator
```
public AbstractIteratorDecorator()
```
- Method Detail
  - getIterator
```
protected abstract java.util.Iterator<E> getIterator()
```
    Returns:
    
    The iterator this class decorates.
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface java.util.Iterator<E>
  - next
```
public E next()
```
    Specified by:
    
    next in interface java.util.Iterator<E>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface java.util.Iterator<E>
  - hasMoreElements
```
public final boolean hasMoreElements()
```
    Specified by:
    
    hasMoreElements in interface java.util.Enumeration<E>
    
    Implementation Specification:
    
    This implementation delegates to hasNext().
  - nextElement
```
public final E nextElement()
```
    Specified by:
    
    nextElement in interface java.util.Enumeration<E>
    
    Implementation Specification:
    
    This implementation delegates to next().