src/org/marc4j/MarcReader.java

   1 // $Id: MarcReader.java,v 1.19 2006/07/30 10:14:56 bpeters Exp $\r
   2 /**\r
   3  * Copyright (C) 2004 Bas Peters\r
   4  *\r
   5  * This file is part of MARC4J\r
   6  *\r
   7  * MARC4J is free software; you can redistribute it and/or\r
   8  * modify it under the terms of the GNU Lesser General Public \r
   9  * License as published by the Free Software Foundation; either \r
  10  * version 2.1 of the License, or (at your option) any later version.\r
  11  *\r
  12  * MARC4J is distributed in the hope that it will be useful,\r
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU\r
  15  * Lesser General Public License for more details.\r
  16  *\r
  17  * You should have received a copy of the GNU Lesser General Public \r
  18  * License along with MARC4J; if not, write to the Free Software\r
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
  20  */\r
  21 package org.marc4j;\r
  22 \r
  23 import org.marc4j.marc.Record;\r
  24 \r
  25 /**\r
  26  * Implement this interface to provide an iterator over a collection of\r
  27  * <code>Record</code> objects.\r
  28  * \r
  29  * <p>See the {@link org.marc4j.marc} package Javadoc for more information\r
  30  * about the {@link org.marc4j.marc.Record} object model.</p>\r
  31  * \r
  32  * @author Bas Peters\r
  33  * @version $Revision: 1.19 $\r
  34  *  \r
  35  */\r
  36 public interface MarcReader {\r
  37 \r
  38   /**\r
  39    * Returns true if the iteration has more records, false otherwise.\r
  40    */\r
  41   public boolean hasNext();\r
  42 \r
  43   /**\r
  44    * Returns the next record in the iteration.\r
  45    * \r
  46    * @return Record - the record object\r
  47    */\r
  48   public Record next();\r
  49 \r
  50 }