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
023package org.biojava.bio.seq;
024
025/**
026 * Title:        Frame.<p>
027 * Description:  An interface that can be implemented by classes that contain
028 *               frame information.<p>
029 * Copyright:    Copyright (c) 2001.<p>
030 * @author Mark Schreiber
031 * @since 1.2
032 * @version 1.0
033 */
034
035public interface Frame {
036  public static int FRAME_0 = 0;
037  public static int FRAME_1 = 1;
038  public static int FRAME_2 = 2;
039
040  /**
041   * A method to get the frame information of the implementing object
042   * @return an integer from 0 to 2 representing the frame.
043   */
044  public int getFrame();
045}