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
022/*
023 *    SymbolPropertyTableIterator.java
024 */
025package org.biojava.bio.proteomics.aaindex;
026
027import java.util.NoSuchElementException;
028
029import org.biojava.bio.BioException;
030import org.biojava.bio.symbol.SymbolPropertyTable;
031
032/**
033 * Iterator over {@link org.biojava.bio.symbol.SymbolPropertyTable} objects.
034 * @author <a href="mailto:Martin.Szugat@GMX.net">Martin Szugat</a>
035 * @version $Revision$
036 */
037public interface SymbolPropertyTableIterator {
038    /**
039     * Checks if there is a further 
040     * {@link org.biojava.bio.symbol.SymbolPropertyTable} object.
041     * @return <code>true</code> if a call to the {@link #nextTable()} method
042     * is valid, <code>false</code> otherwise.
043     */
044    boolean hasNext();
045    
046    /**
047     * Returns the next {@link org.biojava.bio.symbol.SymbolPropertyTable} 
048     * object.
049     * @return a symbol property table
050     * @throws NoSuchElementException if there is no further symbol property 
051     * table.
052     * @throws BioException if the next symbol property table could not be
053     * retrieved.
054     */
055    SymbolPropertyTable nextTable() 
056    throws NoSuchElementException, BioException;
057}