CallbackIterator (vpro-shared-util 3.5.3 API)

java.lang.Object
- nl.vpro.util.CallbackIterator<T>

All Implemented Interfaces:

AutoCloseable, Iterator<T>, CloseableIterator<T>, Counted, CountedIterator<T>
```
public class CallbackIterator<T>
extends Object
implements CountedIterator<T>
```
An iterator that can call a callback function when its iteration is finished.
It simply wraps another iterator, which is one iteration ahead on call of 'hasNext'.

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class CallbackIterator.Builder<T>
- Nested classes/interfaces inherited from interface nl.vpro.util.CloseableIterator
  CloseableIterator.WrappedCloseableIterator<S>, CloseableIterator.WrappedPeekingCloseableIterator<S>

Constructor Summary

Constructors
Constructor Description

CallbackIterator(Iterator<T> wrapped, Runnable callback)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static <T> CallbackIterator.Builder<T>`	`builder()`
`void`	`close()`
`protected boolean`	`findNext()`
`Long`	`getCount()`	The current position.
`@NonNull Optional<Long>`	`getSize()`	The size, if known, of the collection this iterator is representing
`boolean`	`hasNext()`
`T`	`next()`
`void`	`remove()`

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

Methods inherited from interface nl.vpro.util.CountedIterator
getTotalSize, peeking, spliterator, stream

Methods inherited from interface java.util.Iterator
forEachRemaining

- Constructor Detail
  - CallbackIterator
```
public CallbackIterator(Iterator<T> wrapped,
                        Runnable callback)
```
- Method Detail
  - hasNext
```
public boolean hasNext()
```
    Specified by:
    
    hasNext in interface Iterator<T>
  - next
```
public T next()
```
    Specified by:
    
    next in interface Iterator<T>
  - remove
```
public void remove()
```
    Specified by:
    
    remove in interface Iterator<T>
  - findNext
```
protected boolean findNext()
```
  - getSize
```
public @NonNull Optional<Long> getSize()
```
    Description copied from interface: CountedIterator
    
    The size, if known, of the collection this iterator is representing
    
    Specified by:
    
    getSize in interface CountedIterator<T>
  - getCount
```
public Long getCount()
```
    The current position.
    
    Specified by:
    
    getCount in interface Counted
    
    Specified by:
    
    getCount in interface CountedIterator<T>
  - close
```
public void close()
           throws Exception
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface CountedIterator<T>
    
    Throws:
    
    Exception
  - builder
```
public static <T> CallbackIterator.Builder<T> builder()
```