/*
   XBN Java:  Generically useful, non-GUI Java code.
   http://sourceforge.net/projects/xbnjava

   Copyright (C) 1997-2003, Jeff Epstein
   All rights reserved.

   Modifications: No

   Redistribution in binary form, with or without modifications, are permitted provided that the following conditions are met:

      * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
      * If modifications are made to source code then this license should indicate that fact in the "Modifications" section above.
      * Neither the author, nor the contributors may be used to endorse or promote products derived from this software without specific prior written permission.

   THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

   [NOTE:  This license contains NO advertising clause.]
 */
package xbn.util;
   import xbn.XBNObject;

/**
   <P>Represents multiple-line source text, from which lines are retrieved individually, and in order.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/util/ForLineRetrieval.java">ForLineRetrieval.java</A>. &nbsp;<B>Example code</B> &nbsp;See the example code for <A HREF="FLRFile.html">FLRFile</A>.</I></CODE></P>

   @version  0.9b
   @author  Jeff Epstein, <A HREF="http://sourceforge.net/projects/xbnjava">http://sourceforge.net/projects/xbnjava</A>.
 **/
public abstract class ForLineRetrieval extends XBNObject  {

   //Must initialize this to 1.
   private int iLineNumber = 1;
   private String sLineSep = null;
   private int iLineSepLength = -1;

   protected ForLineRetrieval(String s_lineSep)  {
      throwAXIfBadStr(s_lineSep, "s_lineSep", sCNSTR);
      sLineSep = s_lineSep;
      iLineSepLength = sLineSep.length();
   }

   /**
      <P>Get the next line of text from the source.</P>
    **/
   public abstract StringBuffer getNextLine();

   /**
      <P>What is the number of the line <I>about</I> to be read?</P>
    **/
   public final int getLineNumberNext()  {
      return iLineNumber;
   }

   /**
      <P>How many lines have been read thus far?.  What is the number of the line that was <I>just</I> read in?</P>

      @return <CODE>(<A HREF="#getLineNumberNext()">getLineNumberNext</A>() - 1)</CODE>
    **/
   public final int getLineNumberPrev()  {
      return (getLineNumberNext() - 1);
   }

   /**
      <P>Increment the line number.  Sometime during <A HREF="#getNextLine()">getNextLine</A>, this must be called.  Of course, don't call it after the entire text has been processed.</P>
    **/
   protected final void incLineNumber()  {
      iLineNumber++;
   }

   /**
      <P>Are there more lines to be retrieved with getNextLine?</P>

      @return  <B>true</B>  If there are more lines to be processed.
      <BR><B>false</B>  If all lines have been processed.
    **/
   public abstract boolean hasMoreLines();

   public final String getLineSeparator()  {
      return sLineSep;
   }

   public final int getLineSepLength()  {
      return iLineSepLength;
   }
}