htsjdk.samtools.util

Class IterableOnceIterator<T>

java.lang.Object

htsjdk.samtools.util.IterableOnceIterator<T>

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, java.lang.Iterable<T>, java.util.Iterator<T>

public abstract class IterableOnceIterator<T>
extends java.lang.Object
implements java.lang.Iterable<T>, java.util.Iterator<T>, java.io.Closeable

Abstract implementation of an iterator that also implements Iterable (to return itself) so that it can be used if for() loops. Only supports calling iterator() once since new iterators are not manufactured but the same object returned.

Constructor Summary

Constructors

Constructor and Description
IterableOnceIterator()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Does nothing, intended to be overridden when needed.
java.util.Iterator<T>	iterator() On the first call returns this object which is also an iterator.
void	remove() Operation not supported.

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

hasNext, next

Constructor Detail

IterableOnceIterator

public IterableOnceIterator()

Method Detail

iterator

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

On the first call returns this object which is also an iterator. On subsequent calls throws an exception since new iterators cannot be generated.

Specified by:

iterator in interface java.lang.Iterable<T>

remove

public void remove()

Operation not supported.

Specified by:

remove in interface java.util.Iterator<T>

close

public void close()
           throws java.io.IOException

Does nothing, intended to be overridden when needed.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException