com.biomatters.geneious.publicapi.plugin

Class AssemblerInput.Reads

java.lang.Object

com.biomatters.geneious.publicapi.plugin.AssemblerInput.Reads

Enclosing class:

AssemblerInput

public class AssemblerInput.Reads
extends Object

Provides the ability to iterate over all reads to be assembled. An instance of this can be created using AssemblerInput.getReads().

Method Summary

Methods

Modifier and Type	Method and Description
AssemblerInput.Read	getNextReadPair() Gets the next read or pair of reads.
boolean	hasNext()

Methods inherited from class java.lang.Object

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

Method Detail

hasNext

public boolean hasNext()

Returns:

true if there is at least one more read that could be returned from getNextReadPair()

getNextReadPair

public AssemblerInput.Read getNextReadPair()
                                    throws DocumentOperationException

Gets the next read or pair of reads.

Returns:

the next read or pair of reads.

Throws:

DocumentOperationException - if the read can't be loaded

IllegalStateException - if there is no next read (hasNext() would have returned false)