/*
   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.string;
   import xbn.util.ForLineRetrieval;

/**
   <P>A ForLineRetrieval where the source text comes from a String.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/string/FLRString.java">FLRString.java</A>. &nbsp;<B>Example code</B> &nbsp;See the similar example code for <A HREF="~JD~flrf~EJD~">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 class FLRString extends ForLineRetrieval  {
   private SOBStringBuffer ssbText = null;
   private boolean bDone = false;

   /**
      <P>Create a FLRString.</P>

      <P>Equal to <CODE><A HREF="~JD~flrs(s,s)~EJD~">FLRString</A>(<A HREF="~JD~xbno~EJD~#sLINE_SEP">sLINE_SEP</A>, s_text)</CODE></P>
    **/
   public FLRString(String s_text)  {
      this(sLINE_SEP, s_text);
   }

   /**
      <P>Create a FLRString.</P>

      <P>The first line of this constructor calls <CODE><A HREF="~JD~flr#flr(s)~EJD~">ForLineRetrieval</A>(s_lineSep)</CODE></P>

      @param  s_text  The actual source text.  May not be null.
    **/
   public FLRString(String s_lineSep, String s_text)  {
      super(s_lineSep);

      ssbText = new SOBStringBuffer(s_text);
   }


   /**
      <P>Create a FLRString.</P>

      <P>Equal to <CODE><A HREF="~JD~flrs(s,sb)~EJD~">FLRString</A>(<A HREF="~JD~xbno~EJD~#sLINE_SEP">sLINE_SEP</A>, sb_text)</CODE></P>
    **/
   public FLRString(StringBuffer sb_text)  {
      this(sLINE_SEP, sb_text);
   }

   /**
      <P>Create a FLRString.</P>

      <P>The first line of this constructor calls <CODE><A HREF="~JD~flr#flr(s)~EJD~">ForLineRetrieval</A>(s_lineSep)</CODE></P>

      @param  sb_text  The actual source text.  May not be null.
    **/
   public FLRString(String s_lineSep, StringBuffer sb_text)  {
      super(s_lineSep);

      ssbText = new SOBStringBuffer(sb_text);
   }

   /**
      <P>Get the entire StringBuffer not-yet-retrieved.  This does not affect the string's value.</P>
    **/
   public final StringBuffer getRemainingSB()  {
      return ssbText.getStringBuffer();
   }

   /**
      <P>Get the next line from the source string.  If all lines have been retrieved (if <A HREF="#hasMoreLines()">hasMoreLines</A> equals false), then return null.</P>
    **/
   public StringBuffer getNextLine()  {
      int iLineSep = ssbText.indexOf(getLineSeparator());

      incLineNumber();

      if(iLineSep == -1)  {
         //There are no more line separators.
         bDone = true;

         //Minus getLineSepLength(), because it's re-added below.
         iLineSep = (ssbText.length() - getLineSepLength());
      }

      int iArrIdxCharAfterLS = (iLineSep + getLineSepLength());

      StringBuffer sbLine = new StringBuffer(ssbText.substring(0, iArrIdxCharAfterLS));

      //Delete this line from the overall text, including the line
      //separator.
      ssbText.delete(0, iArrIdxCharAfterLS);

      return sbLine;
   }

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

      @return  <CODE>([internally-held StringBuffer].length() &gt; 0)</CODE>
    **/
   public boolean hasMoreLines()  {
      return (ssbText.length() > 0);
   }
}