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

/**
   <P>Holds and manages configuration for a PadChopString.  See <A HREF="~JD~pcs~EJD~">PadChopString</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/string/padchop/PCSConfig.java">PCSConfig.java</A>.</I></CODE></P>

   @version  0.9b
   @author  Jeff Epstein, <http://sourceforge.net/projects/xbnjava">http://sourceforge.net/projects/xbnjava</A>.
 **/
public class PCSConfig extends XBNObject  {
   private int iLength = -1;
   private SpcfcCfgChop scc = null;
   private SpcfcCfgPad scp = null;
   private SpcfcCfgIfNull scin = null;


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

      <P>Equal to <CODE><A HREF="~JD~pcsc(i,scc,scp)~EJD~">PCSConfig</A>(i_length, (new <A HREF="~JD~scc#scc()~EJD~">SpcfcCfgChop</A>()), (new <A HREF="~JD~scp#scp()~EJD~">SpcfcCfgPad</A>()))</CODE></P>
    **/
   public PCSConfig(int i_length)  {
      this(i_length, (new SpcfcCfgChop()), (new SpcfcCfgPad()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~pcsc(i,scc,scp,scin)~EJD~">PCSConfig</A>(i_length, sc_chop, sc_pad, (new <A HREF="~JD~scin#scin()~EJD~">SpcfcCfgIfNull</A>()))</CODE></P>
    **/
   public PCSConfig(int i_length, SpcfcCfgChop sc_chop, SpcfcCfgPad sc_pad)  {
      this(i_length, sc_chop, sc_pad, (new SpcfcCfgIfNull()));
   }


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

      @param  i_length  The length to chop or pad to.  Must be greater than zero.  See <A HREF="#getLength()">getLength</A> and <A HREF="#setLength(int)">setLength</A>.
      @param  sc_chop  The chop-specific configuration.  If null, chopping does not occur.  See <A HREF="#getSpcfcCfgChop()">getSpcfcCfgChop</A> and <A HREF="~JD~setSpcfcCfgChop(scc)~EJD~">setSpcfcCfgChop</A>.
      @param  sc_pad  The pad-specific configuration.  If null, padding does not occur.  See <A HREF="#getSpcfcCfgPad()">getSpcfcCfgPad</A> and <A HREF="~JD~setSpcfcCfgPad(scp)~EJD~">setSpcfcCfgPad</A>.
      @param  sc_ifNull  The crash-if-null-specific configuration.  May not be null.  See <A HREF="#getSpcfcCfgIfNull()">getSpcfcCfgIfNull</A> and <A HREF="~JD~setSpcfcCfgIfNull(scin)~EJD~">setSpcfcCfgIfNull</A>.
    **/
   public PCSConfig(int i_length, SpcfcCfgChop sc_chop, SpcfcCfgPad sc_pad, SpcfcCfgIfNull sc_ifNull)  {
      setLength(i_length);
      setSpcfcCfgChop(sc_chop);
      setSpcfcCfgPad(sc_pad);
      setSpcfcCfgIfNull(sc_ifNull);
   }

   /**
      <P>What is the length to pad/chop to?</P>

      @return  <B>i_length</B>  Exactly as provided to <A HREF="#setLength(int)">setLength</A>.
    **/
   public final int getLength()  {
      return iLength;
   }

   /**
      <P>If the string's length exceeds getLength, should it it be chopped?.  See <A HREF="#getLength()">getLength</A></P>

      @return  <CODE>(<A HREF="#getSpcfcCfgChop()">getSpcfcCfgChop</A>() != null)</CODE>
    **/
   public final boolean doChop()  {
      return (getSpcfcCfgChop() != null);
   }

   /**
      <P>If the string's length does not meet getLength, should it it be padded?.  See <A HREF="#getLength()">getLength</A></P>

      @return  <CODE>(<A HREF="#getSpcfcCfgPad()">getSpcfcCfgPad</A>() != null)</CODE>
    **/
   public final boolean doPad()  {
      return (getSpcfcCfgPad() != null);
   }

   /**
      <P>Get the SpcfcCfgChop for direct manipulation.</P>

      <P>The existence of this object declares that chopping will take place.  See <A HREF="#doChop()">doChop</A>.</P>

      @return sc_chop  Exactly as provided to <A HREF="~JD~setSpcfcCfgChop(scc)~EJD~">setSpcfcCfgChop</A>.
    **/
   public final SpcfcCfgChop getSpcfcCfgChop()  {
      return scc;
   }

   /**
      <P>Get the SpcfcCfgPad for direct manipulation.</P>

      <P>The existence of this object declares that padding will take place.  See <A HREF="#doPad()">doPad</A>.</P>

      @return sc_pad  Exactly as provided to <A HREF="~JD~setSpcfcCfgPad(scp)~EJD~">setSpcfcCfgPad</A>.
    **/
   public final SpcfcCfgPad getSpcfcCfgPad()  {
      return scp;
   }

   /**
      <P>Get the SpcfcCfgIfNull for direct manipulation.</P>

      @return <B>pcs_IfNullCfg</B>  Exactly as provided to <A HREF="~JD~setSpcfcCfgIfNull(scin)~EJD~">setSpcfcCfgIfNull</A>.
    **/
   public final SpcfcCfgIfNull getSpcfcCfgIfNull()  {
      return scin;
   }

   /**
      <P>Set the SpcfcCfgChop.</P>

      <P><I>Get with <CODE><A HREF="#getSpcfcCfgChop()">getSpcfcCfgChop</A></CODE>.</I></P>

      @param  sc_chop  The chop-specific configuration.  If null, chopping does not occur.
    **/
   public final void setSpcfcCfgChop(SpcfcCfgChop sc_chop)  {
      scc = sc_chop;
   }

   /**
      <P>Set the SpcfcCfgPad.</P>

      <P><I>Get with <CODE><A HREF="#getSpcfcCfgPad()">getSpcfcCfgPad</A></CODE>.</I></P>

      @param  sc_pad  The pad-specific configuration.  If null, padding does not occur.
    **/
   public final void setSpcfcCfgPad(SpcfcCfgPad sc_pad)  {
      scp = sc_pad;
   }

   /**
      <P>Set the SpcfcCfgIfNull.</P>

      <P><I>Get with <CODE><A HREF="#getSpcfcCfgIfNull()">getSpcfcCfgIfNull</A></CODE>.</I></P>

      @param  sc_ifNull  The crash-if-null-specific configuration.  May not be null.
    **/
   public final void setSpcfcCfgIfNull(SpcfcCfgIfNull sc_ifNull)  {
      throwAXIfNull(sc_ifNull, "sc_ifNull", "setSpcfcCfgIfNull");
      scin = sc_ifNull;
   }


   /**
      <P>Set the length to pad/chop to.</P>

      <P><I>Get with <CODE><A HREF="#getLength()">getLength</A></CODE></I></P>

      @param  i_length  The length to chop or pad to.  Must be greater than zero.
    **/
   public final void setLength(int i_length)  {
      if(i_length < 0)  {
         throwAX(".constructor:  i_length must be equal to or greater than zero.");
      }

      iLength = i_length;
   }

   /**
      <P>Get some information about this PadChopString.</P>
    **/
   public String toString()  {
      UtilString uStr = new UtilString();

      String sPCSC = null;
      if(getSpcfcCfgChop() == null)  {
         sPCSC = "getSpcfcCfgChop()=null";
      }  else  {
         sPCSC = uStr.getConditional("[", getSpcfcCfgChop().toString(), "]");
      }

      String sSpcfcCfg = null;
      if(getSpcfcCfgPad() == null)  {
         sSpcfcCfg = "getSpcfcCfgPad()=null";
      }  else  {
         sSpcfcCfg = uStr.getConditional("[", getSpcfcCfgPad().toString(), "]");
      }

      return this.getClass().getName() + ":  getLength()=" + getLength() + ", " + sPCSC + ", " + sSpcfcCfg + ", [" + getSpcfcCfgIfNull().toString() + "]";
   }
}