Package com.compomics.util.experiment.io.mass_spectrometry.cms

Class CmsFileIterator

java.lang.Object

com.compomics.util.experiment.io.mass_spectrometry.cms.CmsFileIterator

All Implemented Interfaces:

MsFileIterator, AutoCloseable

public class CmsFileIterator
extends Object
implements MsFileIterator

Iterator for a Compomics Mass Spectrometry (cms) file.

Author:

Marc Vaudel

Constructor Summary

Constructors

Constructor	Description
CmsFileIterator(File file, WaitingHandler waitingHandler)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	close()
Spectrum	getSpectrum()	Returns the spectrum corresponding to the title returned by the last call to the next() method.
String	next()	Returns the title of the next spectrum, null if none.

Methods inherited from class java.lang.Object

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

Constructor Details

CmsFileIterator

public CmsFileIterator(File file,
 WaitingHandler waitingHandler)
                throws IOException

Constructor.

Parameters:

file - The file to iterate.

waitingHandler - The waiting handler.

Throws:

IOException - Exception thrown if an error occurred while reading the file.

Method Details

next

public String next()

Description copied from interface: MsFileIterator

Returns the title of the next spectrum, null if none.

Specified by:

next in interface MsFileIterator

Returns:

The title of the next spectrum.

getSpectrum

public Spectrum getSpectrum()

Description copied from interface: MsFileIterator

Returns the spectrum corresponding to the title returned by the last call to the next() method.

Specified by:

getSpectrum in interface MsFileIterator

Returns:

The spectrum corresponding to the title returned by the last call to the next() method.

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface MsFileIterator