com.chemaxon.overlap.io

Class StructureRecordIterator

java.lang.Object

com.google.common.collect.UnmodifiableIterator<T>

com.google.common.collect.AbstractIterator<T>

com.chemaxon.calculations.io.CloseableAbstractIterator<StructureRecord>

com.chemaxon.overlap.io.StructureRecordIterator

All Implemented Interfaces:

CloseableIterator<StructureRecord>, Closeable, AutoCloseable, Iterator<StructureRecord>

public class StructureRecordIterator
extends CloseableAbstractIterator<StructureRecord>

Class encapsulating MRecordReader.

Closes underlying reader upon explicit close.

Constructor Summary

Constructors

Constructor and Description
StructureRecordIterator(InputStream is, String opts) New instance.

Method Summary

Modifier and Type	Method and Description
void	close()
protected StructureRecord	computeNext()
String	getFormat() Get format.

Methods inherited from class com.google.common.collect.AbstractIterator

endOfData, hasNext, next, peek

Methods inherited from class com.google.common.collect.UnmodifiableIterator

remove

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.chemaxon.calculations.io.CloseableIterator

transform

Methods inherited from interface java.util.Iterator

forEachRemaining, hasNext, next, remove

Constructor Detail

StructureRecordIterator

public StructureRecordIterator(InputStream is,
                               String opts)

New instance.

Note that empty stream can not be wrapped. Otherwise getFormat() would need to be ambiguous in case of empty stream.

Parameters:

is - InputStream to read from. Note that the passed stream is read but not closed when end reached. Method close() closes the underlying MRecordReader. Note that if the stream is empty IllegalArgumentException thrown.

opts - Options to pass to underlying MFileFormatUtil.createRecordReader(java.io.InputStream, java.lang.String)

Throws:

IllegalArgumentException - when opening was problematic due to exception from the underlying MRecordReader.

Method Detail

computeNext

protected StructureRecord computeNext()

Specified by:

computeNext in class AbstractIterator<StructureRecord>

close

public void close()

getFormat

public String getFormat()

Get format.

Returns:

Recognized format returned by MRecordReader.getRecognizedFormat()