Class ArchiveReader.ArchiveRecordIterator

java.lang.Object

org.archive.io.ArchiveReader.ArchiveRecordIterator

All Implemented Interfaces:

Iterator<ArchiveRecord>

Enclosing class:

ArchiveReader

protected class ArchiveReader.ArchiveRecordIterator
extends Object
implements Iterator<ArchiveRecord>

Inner ArchiveRecord Iterator class. Throws RuntimeExceptions in hasNext() and next() if trouble pulling record from underlying stream.

Version:

$Date$ $Version$

Author:

stack

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ArchiveRecordIterator()

Method Summary

Modifier and Type	Method	Description
protected ArchiveRecord	exceptionNext()	A next that throws exceptions and has handling of recoverable exceptions moving us to next record.
boolean	hasNext()
protected boolean	innerHasNext()
protected ArchiveRecord	innerNext()
ArchiveRecord	next()	Tries to move to next record if we get RecoverableIOException.
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 Details

ArchiveRecordIterator

protected ArchiveRecordIterator()

Method Details

hasNext

public boolean hasNext()

Specified by:

hasNext in interface Iterator<ArchiveRecord>

Returns:

True if we have more records to read.

Throws:

RuntimeException - Can throw an IOException wrapped in a RuntimeException if a problem reading underlying stream (Corrupted gzip, etc.).

innerHasNext

protected boolean innerHasNext()

next

public ArchiveRecord next()

Tries to move to next record if we get RecoverableIOException. If not strict tries to move to next record if we get an IOException.

Specified by:

next in interface Iterator<ArchiveRecord>

Returns:

Next object.

Throws:

RuntimeException - Throws a runtime exception, usually a wrapping of an IOException, if trouble getting a record (Throws exception rather than return null).

exceptionNext

protected ArchiveRecord exceptionNext()
                               throws IOException,
RuntimeException

A next that throws exceptions and has handling of recoverable exceptions moving us to next record. Can call hasNext which itself may throw exceptions.

Returns:

Next record.

Throws:

IOException

RuntimeException - Thrown when we've reached maximum retries.

innerNext

protected ArchiveRecord innerNext()
                           throws IOException

Throws:

IOException

remove

public void remove()

Specified by:

remove in interface Iterator<ArchiveRecord>