com.github.wnameless.json.flattener

Class IndexedPeekIterator<E>

java.lang.Object

com.github.wnameless.json.flattener.IndexedPeekIterator<E>

Type Parameters:

E - the type of elements

All Implemented Interfaces:

Iterator<E>

public final class IndexedPeekIterator<E>
extends Object
implements Iterator<E>

IndexedPeekIterator is an Iterator which provides user a peek() method to peek an element advanced, a getIndex() method to get the index of last returned element and a getCurrent() method to get the last returned element itself.

Author:

Wei-Ming Wu

Constructor Summary

Constructors

Constructor and Description
IndexedPeekIterator(Iterator<? extends E> iterator) Creates an IndexedPeekIterator.

Method Summary

Modifier and Type	Method and Description
E	getCurrent() Returns the last returned element.
int	getIndex() Returns the index of last returned element.
boolean	hasNext()
static <T> IndexedPeekIterator<T>	newIndexedPeekIterator(Iterable<T> iter) Creates an IndexedPeekIterator by given Iterable.
E	next()
E	peek() Peeks an element advanced.
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.Iterator

forEachRemaining

Constructor Detail

IndexedPeekIterator

public IndexedPeekIterator(Iterator<? extends E> iterator)

Creates an IndexedPeekIterator.

Parameters:

iterator - an Iterator

Method Detail

newIndexedPeekIterator

public static <T> IndexedPeekIterator<T> newIndexedPeekIterator(Iterable<T> iter)

Creates an IndexedPeekIterator by given Iterable.

Type Parameters:

T - the type of elements

Parameters:

iter - any Iterable

Returns:

an IndexedPeekIterator

getIndex

public int getIndex()

Returns the index of last returned element. If there is no element has been returned, it returns -1.

Returns:

the index of last returned element

getCurrent

public E getCurrent()

Returns the last returned element. If next() has never been called, it returns null.

Returns:

the last returned element

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>

peek

public E peek()

Peeks an element advanced. Warning: remove() is temporarily out of function after a peek() until a next() is called.

Returns:

element