htsjdk.samtools.util

Class PeekIterator<T>

java.lang.Object

htsjdk.samtools.util.PeekIterator<T>

All Implemented Interfaces:

java.util.Iterator<T>

public class PeekIterator<T>
extends java.lang.Object
implements java.util.Iterator<T>

Wrapper around an iterator that enables non-destructive peeking at the next element that would be returned by next()

Constructor Summary

Constructors

Constructor and Description
PeekIterator(java.util.Iterator<T> underlyingIterator)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Iterator<T>	getUnderlyingIterator()
boolean	hasNext()
T	next()
T	peek()
void	remove() Unsupported

Methods inherited from class java.lang.Object

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

Constructor Detail

PeekIterator

public PeekIterator(java.util.Iterator<T> underlyingIterator)

Method Detail

hasNext

public boolean hasNext()

Specified by:

hasNext in interface java.util.Iterator<T>

Returns:

true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

next

public T next()

Specified by:

next in interface java.util.Iterator<T>

Returns:

the next element in the iteration. Calling this method repeatedly until the hasNext() method returns false will return each element in the underlying collection exactly once.

peek

public T peek()

Returns:

the next element in the iteration, but without removing it, so the next call to next() or peek() will return the same element as returned by the current call to peek().

remove

public void remove()

Unsupported

Specified by:

remove in interface java.util.Iterator<T>

getUnderlyingIterator

public java.util.Iterator<T> getUnderlyingIterator()

Returns:

the iterator wrapped by this object.