Package nl.vpro.util

Class BasicWrappedIterator<T>

java.lang.Object

nl.vpro.util.WrappedIterator<T,T>

nl.vpro.util.BasicWrappedIterator<T>

All Implemented Interfaces:

AutoCloseable, Iterator<T>, CloseableIterator<T>, Counted, CountedIterator<T>

Direct Known Subclasses:

MergedSortedIterator

public class BasicWrappedIterator<T>
extends WrappedIterator<T,T>

Since:

0.31

Author:

Michiel Meeuwissen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicWrappedIterator.Builder<T>

Nested classes/interfaces inherited from interface nl.vpro.util.CloseableIterator

CloseableIterator.WrappedCloseableIterator<S>, CloseableIterator.WrappedPeekingCloseableIterator<S>

Field Summary

Fields inherited from class nl.vpro.util.WrappedIterator

wrapped

Constructor Summary

Constructors

Modifier	Constructor	Description
	BasicWrappedIterator(Long size, Long totalSize, Iterator<T> wrapped)
	BasicWrappedIterator(Long totalSize, Iterator<T> wrapped)
	BasicWrappedIterator(Collection<T> wrapped)
	BasicWrappedIterator(AtomicLong size, AtomicLong totalSize, Iterator<T> wrapped)
	BasicWrappedIterator(AtomicLong totalSize, Iterator<T> wrapped)
protected	BasicWrappedIterator(Supplier<Long> sizeSupplier, Supplier<Long> totalSizeSupplier, Long size, Long totalSize, Iterator<T> wrapped)
	BasicWrappedIterator(Iterator<T> wrapped)

Method Summary

Modifier and Type	Method	Description
static <T> BasicWrappedIterator.Builder<T>	builder()
Long	getCount()	The current position.
@NonNull Optional<Long>	getSize()	The size, if known, of the collection this iterator is representing
@NonNull Optional<Long>	getTotalSize()	If the iterator is in some way restricted you may also want to report a total size, representing the unrestricted size.
T	next()

Methods inherited from class nl.vpro.util.WrappedIterator

close, hasNext, iterator, remove, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.vpro.util.CountedIterator

peeking, spliterator, stream

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

BasicWrappedIterator

public BasicWrappedIterator(Iterator<T> wrapped)

BasicWrappedIterator

protected BasicWrappedIterator(Supplier<Long> sizeSupplier,
 Supplier<Long> totalSizeSupplier,
 Long size,
 Long totalSize,
 Iterator<T> wrapped)

BasicWrappedIterator

public BasicWrappedIterator(Long size,
 Long totalSize,
 Iterator<T> wrapped)

BasicWrappedIterator

public BasicWrappedIterator(AtomicLong size,
 AtomicLong totalSize,
 Iterator<T> wrapped)

BasicWrappedIterator

public BasicWrappedIterator(Long totalSize,
 Iterator<T> wrapped)

BasicWrappedIterator

public BasicWrappedIterator(AtomicLong totalSize,
 Iterator<T> wrapped)

BasicWrappedIterator

public BasicWrappedIterator(Collection<T> wrapped)

Method Details

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>

Overrides:

getSize in class WrappedIterator<T,T>

getTotalSize

public @NonNull Optional<Long> getTotalSize()

Description copied from interface: CountedIterator

If the iterator is in some way restricted you may also want to report a total size, representing the unrestricted size.

The default implementation is CountedIterator.getSize().

Specified by:

getTotalSize in interface CountedIterator<T>

Overrides:

getTotalSize in class WrappedIterator<T,T>

next

public T next()

Specified by:

next in interface Iterator<T>

Specified by:

next in class WrappedIterator<T,T>

getCount

public Long getCount()

Description copied from interface: CountedIterator

The current position. Will return 1 after first successfull call to Iterator.next(), 2 after the second one, and so on. It will return 0 before the first call.

Specified by:

getCount in interface Counted

Specified by:

getCount in interface CountedIterator<T>

Overrides:

getCount in class WrappedIterator<T,T>

builder

public static <T> BasicWrappedIterator.Builder<T> builder()