/*
   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.XBNObject;

/**
   <P>Configuration regarding TrimChars.trimAllLines.  See <A HREF="~JD~tc~EJD~">TrimChars</A>.<A HREF="~JD~tc#trimAllLines(sob)~EJD~">trimAllLines</A>.  This object is provided directly to the TrimChars <A HREF="~JD~tc#tc(c[],talc,b,c,b)~EJD~">constructor</A></P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/string/TALConfig.java">TALConfig.java</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 TALConfig extends XBNObject  {
   private String sLineSep = null;
   private boolean bTrimLeft = false;
   private boolean bTrimRight = false;

   /**
      <P>Create a TALConfig with default settings.</P>

      <P>Equal to <CODE><A HREF="~JD~talc(s)~EJD~">TALConfig</A>(<A HREF="~JD~xbno~EJD~#sLINE_SEP">sLINE_SEP</A>)</CODE></P>
    **/
   public TALConfig()  {
      this(sLINE_SEP);
   }

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

      <P>Equal to <CODE><A HREF="~JD~talc(s,b,b)~EJD~">TALConfig</A>(s_lineSep, true, true)</CODE></P>
    **/
   public TALConfig(String s_lineSep)  {
      this(s_lineSep, true, true);
   }

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

      <P>Equal to <CODE><A HREF="~JD~talc(s,b,b)~EJD~">TALConfig</A>(<A HREF="~JD~xbno~EJD~#sLINE_SEP">sLINE_SEP</A>, b_trimLeft, b_trimRight)</CODE></P>
    **/
   public TALConfig(boolean b_trimLeft, boolean b_trimRight)  {
      this(sLINE_SEP, b_trimLeft, b_trimRight);
   }

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

      @param  s_lineSep  Defines the line separator.  May not be null or zero characters in length, and may not contain any characters existing in <CODE>ac_toTrim</CODE> (as provided to the <A HREF="~JD~tc~EJD~">TrimChars</A> <A HREF="~JD~tc#tc(c[],talc,b,c,b)~EJD~">constructor</A>.
      @param  b_trimLeft  When true, then the left side of each line should be trimmed.  If false, the the left side is left alone.  See <a href="#doTrimLeft()">doTrimLeft</a>.
      @param  b_trimRight  When true, then the right side of each line should be trimmed.  If false, the the right side is left alone.  See <a href="#doTrimRight()">doTrimRight</a>.
    **/
   public TALConfig(String s_lineSep, boolean b_trimLeft, boolean b_trimRight)  {
      throwAXIfBadStr(s_lineSep, "s_lineSep", sCNSTR);
      sLineSep = s_lineSep;
      bTrimLeft = b_trimLeft;
      bTrimRight = b_trimRight;
   }

   /**
      <P>Get the line separator.</P>

      @return  <B>s_lineSep</B>  Exactly as provided to the <A HREF="~JD~talc(s,b,b)~EJD~">constructor</A>.
    **/
   public final String getLineSeparator()  {
      return sLineSep;
   }

   /**
      <P>Should characters be trimmed off the left side of each line?</P>

      @return  <B>b_trimLeft</B>  Exactly as provided to the <A HREF="~JD~talc(s,b,b)~EJD~">constructor</A>.
    **/
   public final boolean doTrimLeft()  {
      return bTrimLeft;
   }

   /**
      <P>Should characters be trimmed off the right side of each line?</P>

      @return  <B>b_trimRight</B>  Exactly as provided to the <A HREF="~JD~talc(s,b,b)~EJD~">constructor</A>.
    **/
   public final boolean doTrimRight()  {
      return bTrimRight;
   }
}