com.compomics.util.experiment.identification

Class SequenceFactory.HeaderIterator

java.lang.Object

com.compomics.util.experiment.identification.SequenceFactory.HeaderIterator

Enclosing class:

SequenceFactory

public class SequenceFactory.HeaderIterator
extends java.lang.Object

Convenience iterator iterating the headers of a FASTA file without using the cache. The order is the one in the FASTA file.

Constructor Summary

Constructors

Constructor and Description
SequenceFactory.HeaderIterator(java.io.File file, boolean targetOnly) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the connection to the file.
Header	getNext() Returns the next header in the FASTA file.
boolean	hasNext() Returns true if there is a next header.

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceFactory.HeaderIterator

public SequenceFactory.HeaderIterator(java.io.File file,
                              boolean targetOnly)
                               throws java.io.FileNotFoundException

Constructor.

Parameters:

targetOnly - if true only target proteins will be iterated

file - the FASTA file to iterate

Throws:

java.io.FileNotFoundException

Method Detail

hasNext

public boolean hasNext()
                throws java.io.IOException

Returns true if there is a next header.

Returns:

true if there is a next header

Throws:

java.io.IOException

getNext

public Header getNext()

Returns the next header in the FASTA file.

Returns:

the next header in the FASTA file

close

public void close()
           throws java.io.IOException

Closes the connection to the file.

Throws:

java.io.IOException