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.biojava.utils.io;
023import java.io.IOException;
024
025/** 
026 * This interface provides a collective name for IO classes that implement a
027 * seek function (e.g., {@link java.io.RandomAccessFile}).
028 *
029 * @author Rhett Sutphin (<a href="http://genome.uiowa.edu/">UI CBCB</a>)
030 */
031public interface Seekable {
032    /** 
033     * Moves the pointer in the inputstream such that the byte starting  at 
034     * <code>pos</code> are returned by the next read.
035     * @param pos the position to which to seek
036     * @throws IOException when there's an I/O problem
037     */
038    public void seek(long pos) throws IOException;
039}