Package io.permazen.util

Class UniqueIterator<E>

java.lang.Object

io.permazen.util.UniqueIterator<E>

All Implemented Interfaces:

CloseableIterator<E>, Closeable, AutoCloseable, Iterator<E>

public class UniqueIterator<E>
extends Object
implements CloseableIterator<E>

CloseableIterator implementation that provides a read-only view of an inner Iterator in which consecutive duplicate values are eliminated.

Constructor Summary

Constructors

Constructor	Description
UniqueIterator(Iterator<? extends E> iterator)	Constructor.
UniqueIterator(Iterator<? extends E> iterator, Comparator<? super E> comparator)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	hasNext()
E	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 io.permazen.util.CloseableIterator

toStream

Methods inherited from interface java.util.Iterator

forEachRemaining

Constructor Details

UniqueIterator

public UniqueIterator(Iterator<? extends E> iterator)

Constructor.

Object equality using Object.equals(java.lang.Object) is used to detect duplicates.

Parameters:

iterator - wrapped Iterator

Throws:

IllegalArgumentException - if iterator is null

UniqueIterator

public UniqueIterator(Iterator<? extends E> iterator,
 Comparator<? super E> comparator)

Constructor.

A zero result from comparator is used to detect duplicates. If comparator is null, Object.equals(java.lang.Object) is used.

Parameters:

iterator - wrapped Iterator

comparator - used to compare consecutive values, or null to use Object.equals(java.lang.Object)

Throws:

IllegalArgumentException - if iterator is null

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<E>

next

public E next()

Specified by:

next in interface Iterator<E>

remove

public void remove()

Specified by:

remove in interface Iterator<E>

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface CloseableIterator<E>