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

/**
   <P>Part of PCSConfig that configures crash-if-null-specific items.  See <A HREF="PCSConfig.html">PCSConfig</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/string/padchop/SpcfcCfgIfNull.java">SpcfcCfgIfNull.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 SpcfcCfgIfNull extends XBNObject  {
   private boolean bCrashIfNull = false;
   private StringBuffer sbIfNull = null;

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

      <P>Equal to <CODE><A HREF="~JD~scin(b)~EJD~">SpcfcCfgIfNull</A>(false)</CODE></P>
    **/
   public SpcfcCfgIfNull()  {
      this(false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~scin(b,sb)~EJD~">SpcfcCfgIfNull</A>(b_crashIfNull, (new <A HREF="~JD~sb#sb()~EJD~">StringBuffer</A>("")))</CODE></P>
    **/
   public SpcfcCfgIfNull(boolean b_crashIfNull)  {
      this(b_crashIfNull, (new StringBuffer(sES)));
   }

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

      <P>Equal to <CODE><A HREF="~JD~scin(b,sb)~EJD~">SpcfcCfgIfNull</A>(false, sb_ifNull)</CODE></P>
    **/
   public SpcfcCfgIfNull(StringBuffer sb_ifNull)  {
      this(false, sb_ifNull);
   }

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

      @param  b_crashIfNull  If true and [the string to be padded/chopped] is null, throw an <A HREF="~JD~ax~EJD~">AssertException</A>.  If false and [the string to be padded/chopped] is null, return sb_ifNull.  See <A HREF="#doCrashIfNull()">doCrashIfNull</A>.
      @param  sb_ifNull  The StringBuffer to return when [the string to be padded/chopped] is null and b_crashIfNull is false.  See <A HREF="#getIfNullSB()">getIfNullSB</A>.
    **/
   public SpcfcCfgIfNull(boolean b_crashIfNull, StringBuffer sb_ifNull)  {
      throwAXIfNull(sb_ifNull, "sb_ifNull", sCNSTR);
      bCrashIfNull = b_crashIfNull;
      sbIfNull = sb_ifNull;
   }


   /**
      <P>If [the string to be padded/trimmed] is null, should an exception be thrown?</P>

      @return  <B>b_crashIfNull</B>  Exactly as provided to the <A HREF="~JD~scin(b,sb)~EJD~">constructor</A>.
    **/
   public final boolean doCrashIfNull()  {
      return bCrashIfNull;
   }

   /**
      <P>If [the string to be padded/trimmed] is null, what should be returned in its place?</P>

      @return  <B>sb_ifNull</B>  Exactly as provided to the <A HREF="~JD~scin(b,sb)~EJD~">constructor</A>.
    **/
   public final StringBuffer getIfNullSB()  {
      return sbIfNull;
   }

   /**
      <P>Get some information about this SpcfcCfgIfNull.</P>
    **/
   public String toString()  {
      return this.getClass().getName() + ":  doCrashIfNull()=" + doCrashIfNull() + ", getIfNullSB()='" + getIfNullSB().toString() + "'";
   }
}