AbstractIterator (Jackrabbit Oak 1.88.0 API)

java.lang.Object
- org.apache.jackrabbit.oak.commons.collections.AbstractIterator<T>

Type Parameters:

T - the type of elements returned by this iterator

All Implemented Interfaces:

Iterator<T>

Direct Known Subclasses:

BlobReferenceIterator, DepthFirstNodeIterator, JournalReader
```
public abstract class AbstractIterator<T>
extends Object
implements Iterator<T>
```
An abstract base class for implementing iterators with custom logic. Subclasses should implement computeNext() to provide elements and must call endOfData() to signal no more element.
The iteration ends when endOfData() is called from computeNext().

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractIterator()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract T`	`computeNext()`	Computes the next element in the iteration.
`protected T`	`endOfData()`	Signals that the iteration has no more elements.
`boolean`	`hasNext()`
`T`	`next()`

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

Methods inherited from interface java.util.Iterator
forEachRemaining, remove

- Constructor Detail
  - AbstractIterator
```
protected AbstractIterator()
```
- Method Detail
  - computeNext
```
protected abstract T computeNext()
```
    Computes the next element in the iteration. Subclasses must implement this method and call endOfData() when no more elements are available.
    
    Returns:
    
    the next element, or endOfData() if iteration is over
  - endOfData
```
protected final T endOfData()
```
    Signals that the iteration has no more elements. Should be called from computeNext() to end iteration.
    
    Returns:
    
    null, indicating end of data
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T>
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T>