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

Class MgfFileIterator

java.lang.Object

com.compomics.util.experiment.io.mass_spectrometry.mgf.MgfFileIterator

All Implemented Interfaces:

MsFileIterator, AutoCloseable

public class MgfFileIterator
extends Object
implements MsFileIterator

An iterator of the spectra in an mgf file.

Author:

Marc Vaudel, Harald Barsnes

Constructor Summary

Constructors

Constructor	Description
MgfFileIterator(File mgfFile, 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

MgfFileIterator

public MgfFileIterator(File mgfFile,
 WaitingHandler waitingHandler)

Constructor.

Parameters:

mgfFile - the file to go through

waitingHandler - the waiting handler

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