001/*
002 *                    BioJava development code
003 *
004 * This code may be freely distributed and modified under the
005 * terms of the GNU Lesser General Public Licence.  This should
006 * be distributed with the code.  If you do not have a copy,
007 * see:
008 *
009 *      http://www.gnu.org/copyleft/lesser.html
010 *
011 * Copyright for this code is held jointly by the individual
012 * authors.  These should be listed in @author doc comments.
013 *
014 * For more information on the BioJava project and its aims,
015 * or to join the biojava-l mailing list, visit the home page
016 * at:
017 *
018 *      http://www.biojava.org/
019 *
020 */
021
022package org.biojavax.bio;
023import java.util.NoSuchElementException;
024
025import org.biojava.bio.BioException;
026
027
028
029/**
030 * Essentially the same as SequenceIterator. It provides a new
031 * method that returns RichSequence objects without the need for
032 * explicit casting. Implementations of this interface should <b>always</b>
033 * return RichSequence objects for both the nextSequence() and
034 * nextRichSequence() methods.
035 *
036 * @author Mark Schreiber
037 * @author Richard Holland
038 * @see org.biojava.bio.seq.SequenceIterator
039 * @since 1.5
040 */
041public interface BioEntryIterator {
042    /**
043     * Returns whether there are more sequences to iterate over.
044     *
045     * @return  true if there are more sequences to get and false otherwise
046     */
047    boolean hasNext();
048    
049    public BioEntry nextBioEntry() throws NoSuchElementException, BioException;
050}