/*
   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;
   import xbn.string.UtilStringBuffer;
   import xbn.string.SOBString;
   import xbn.string.StringOrBuffer;

/**
   <P>Pad and/or chop a string to a specific length.  The configuration for this class is held in a <A HREF="PCSConfig.html">PCSConfig</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/string/padchop/PadChopString.java">PadChopString.java</A>. &nbsp;<B>Example code</B> &nbsp;<A HREF="../../../xbn_examples/string/padchop/XmplPadChopString.html">XmplPadChopString</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 PadChopString extends XBNObject  {
   private UtilString uStr = new UtilString();
   private UtilStringBuffer uSB = new UtilStringBuffer();
   private PCSConfig pcsc = null;

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

      @param  pcs_config  The configuration for this PadChopString.  May not be null.  See <A HREF="~JD~setPCSConfig(pcsc)~EJD~">setPCSConfig</A>.
    **/
   public PadChopString(PCSConfig pcs_config)  {
      setPCSConfig(pcs_config);
   }

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

      @return  <B>pcs_config</B> exactly as provided to <A HREF="~JD~setPCSConfig(pcsc)~EJD~">setPCSConfig</A>.
    **/
   public final PCSConfig getPCSConfig()  {
      return pcsc;
   }

   /**
      <P>Set the configuration defining how the string should be padded/chopped.</P>

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

      @param  pcs_config  The configuration for this PadChopString.  May not be null.
    **/
   public final void setPCSConfig(PCSConfig pcs_config)  {
      throwAXIfNull(pcs_config, "pcs_config", "setPCSConfig");
      pcsc = pcs_config;
   }


   /**
      <P>Get a copy of the boolean after it is padded/chopped.</P>

      @return  The contents of getSOBFromS:  <CODE><A HREF="~JD~padChop(sob)~EJD~">padChop</A>([<A HREF="~JD~utils~EJD~">UtilString</A>].<A HREF="~JD~utils#getSOBS(s,s)~EJD~">getSOBS</A>(new <A HREF="~JD~B#B(b)~EJD~">Boolean</A>(b_oolean).<A HREF="~JD~B~EJD~#toString()">toString</A>(), "get"))</CODE></P>
   **/
   public String get(boolean b_oolean)  {
      SOBString ss = uStr.getSOBS((new Boolean(b_oolean)).toString(), "get");
      padChop(ss);
      return ss.toString();
   }

   /**
      <P>Get a copy of the char after it is padded/chopped.</P>

      @return  The contents of getSOBFromS:  <CODE><A HREF="~JD~padChop(sob)~EJD~">padChop</A>([<A HREF="~JD~utils~EJD~">UtilString</A>].<A HREF="~JD~utils#getSOBS(s,s)~EJD~">getSOBS</A>(new <A HREF="~JD~C#C(c)~EJD~">Character</A>(c_har).<A HREF="~JD~C~EJD~#toString()">toString</A>(), "get"))</CODE></P>
   **/
   public String get(char c_har)  {
      SOBString ss = uStr.getSOBS((new Integer(c_har)).toString(), "get");
      padChop(ss);
      return ss.toString();
   }

   /**
      <P>Get a copy of the int after it is padded/chopped.</P>

      @return  The contents of getSOBFromS:  <CODE><A HREF="~JD~padChop(sob)~EJD~">padChop</A>([<A HREF="~JD~utils~EJD~">UtilString</A>].<A HREF="~JD~utils#getSOBS(s,s)~EJD~">getSOBS</A>(new <A HREF="~JD~I#I(i)~EJD~">Integer</A>(i_nt).<A HREF="~JD~I~EJD~#toString()">toString</A>(), "get"))</CODE></P>
   **/
   public String get(int i_nt)  {
      SOBString ss = uStr.getSOBS((new Integer(i_nt)).toString(), "get");
      padChop(ss);
      return ss.toString();
   }

   /**
      <P>Get a copy of the string after it is padded/chopped.</P>

      @return  The contents of getSOBFromS:  <CODE><A HREF="~JD~padChop(sob)~EJD~">padChop</A>([<A HREF="~JD~utils~EJD~">UtilString</A>].<A HREF="~JD~utils#getSOBS(s,s)~EJD~">getSOBS</A>(s_tr, "get"))</CODE></P>
   **/
   public String get(String s_tr)  {
      SOBString ss = uStr.getSOBS(s_tr, "get");
      padChop(ss);
      return ss.toString();
   }


   /**
      <P>Pad/chop the StringBuffer.</P>

      <P>Equal to <CODE><A HREF="~JD~padChop(sob)~EJD~">padChop</A>([<A HREF="~JD~utilsb~EJD~">UtilStringBuffer</A>].<A HREF="~JD~utilsb#getSOBSB(sb,s)~EJD~">getSOBSB</A>(str_buffer, "get")).<A HREF="~JD~ssb~EJD~#getStringBuffer()">getStringBuffer</A>()</CODE></P>
   **/
   public void padChop(StringBuffer str_buffer)  {
      padChop(uSB.getSOBSB(str_buffer, "get"));
   }

   /**
      <P>Get the padded/chopped StringBuffer, based upon the configuration held in the PCSConfig.  See <A HREF="#getPCSConfig()">getPCSConfig</A>.</P>

      @param  str_buffer  The StringBuffer to pad or chop.
      @return  A StringBuffer padded or chopped, based upon the configuration held in the PCSConfig.
   **/
   public void padChop(StringOrBuffer str_orBfr)  {
      if(str_orBfr == null)  {
         if(getPCSConfig().getSpcfcCfgIfNull().doCrashIfNull())  {
            throwAX("getSB:  str_orBfr is null and getPCSConfig().getSpcfcCfgIfNull().doCrashIfNull() is true.");
         }
         //getPCSConfig().getSpcfcCfgIfNull().doCrashIfNull() is false.  Instead of crashng,
         //just return the if-null string.
         getPCSConfig().getSpcfcCfgIfNull().getIfNullSB();
         return;
      }

      //str_orBfr is not null.

      if(str_orBfr.length() > getPCSConfig().getLength()  &&
         getPCSConfig().doChop())  {

         //The length of this string is greater than the desired
         //length.  We want to cut the string down to its
         //desired length.

         int iMinusDDD = 0;
         if(getPCSConfig().getSpcfcCfgChop().getChopDotDotDot() != null)  {
            iMinusDDD = (getPCSConfig().getSpcfcCfgChop().getChopDotDotDot().length() - getPCSConfig().getSpcfcCfgChop().getCDDDFlush());
         }

         if(getPCSConfig().getSpcfcCfgChop().getChopSideEndStart())  {
            //Delete chars from end
            str_orBfr.setLength(getPCSConfig().getLength() - iMinusDDD);

            if(getPCSConfig().getSpcfcCfgChop().getChopDotDotDot() != null)  {
               str_orBfr.append(getPCSConfig().getSpcfcCfgChop().getChopDotDotDot());
            }

         }  else  {
            //Delete chars from start
            str_orBfr.delete(0, (str_orBfr.length() - getPCSConfig().getLength() - iMinusDDD));

            if(getPCSConfig().getSpcfcCfgChop().getChopDotDotDot() != null)  {
               str_orBfr.insert(0, getPCSConfig().getSpcfcCfgChop().getChopDotDotDot());
            }
         }
      }

      //If the string is less than getLength(), it needs to be
      //padded.

      while(getPCSConfig().doPad()  &&
            str_orBfr.length() < getPCSConfig().getLength())  {
         //They *do* want to pad, and the string is still less
         //than the desired length.

         if(getPCSConfig().getSpcfcCfgPad().getPadSideEndStart())  {
            //We need to pad the right-hand side of this string.
            str_orBfr.append(getPCSConfig().getSpcfcCfgPad().getPadChar());

         }  else  {
            //We need to pad the left-hand side of this string.
            //In other words, insert a character at the zero-th
            //char array index.
            str_orBfr.insert(0, getPCSConfig().getSpcfcCfgPad().getPadChar());
         }
      }
   }



   /**
      <P>Get a copy of the boolean after it is padded/chopped.</P>

      <P>Before returning, this calls</P>

      <P><CODE><a href="#getPCSConfig()">getPCSConfig</a>().<A HREF="~JD~pcsc#setLength(i)~EJD~">setLength</A>(i_length)</CODE></P>

      <P>If you don't need to reset the length every time, then use only <A HREF="~JD~get(b)~EJD~">get</A>.</P>

      @return  <CODE>get(b_oolean)</CODE>
   **/
   public String get(int i_length, boolean b_oolean)  {
      getPCSConfig().setLength(i_length);
      return get(b_oolean);
   }

   /**
      <P>Get a copy of the char after it is padded/chopped.</P>

      <P>Before returning, this calls</P>

      <P><CODE><a href="#getPCSConfig()">getPCSConfig</a>().<A HREF="~JD~pcsc#setLength(i)~EJD~">setLength</A>(i_length)</CODE></P>

      <P>If you don't need to reset the length every time, then use only <A HREF="~JD~get(c)~EJD~">get</A>.</P>

      @return  <CODE>get(c_har)</CODE>
   **/
   public String get(int i_length, char c_har)  {
      getPCSConfig().setLength(i_length);
      return get(c_har);
   }

   /**
      <P>Get a copy of the int after it is padded/chopped.</P>

      <P>Before returning, this calls</P>

      <P><CODE><a href="#getPCSConfig()">getPCSConfig</a>().<A HREF="~JD~pcsc#setLength(i)~EJD~">setLength</A>(i_length)</CODE></P>

      <P>If you don't need to reset the length every time, then use only <A HREF="~JD~get(i)~EJD~">get</A>.</P>

      @return  <CODE>get(i_nt)</CODE>
   **/
   public String get(int i_length, int i_nt)  {
      getPCSConfig().setLength(i_length);
      return get(i_nt);
   }

   /**
      <P>Get a copy of the string after it is padded/chopped.</P>

      <P>Before returning, this calls</P>

      <P><CODE><a href="#getPCSConfig()">getPCSConfig</a>().<A HREF="~JD~pcsc#setLength(i)~EJD~">setLength</A>(i_length)</CODE></P>

      <P>If you don't need to reset the length every time, then use only <A HREF="~JD~get(s)~EJD~">get</A>.</P>

      @return  <CODE>get(s_tr)</CODE>
   **/
   public String get(int i_length, String s_tr)  {
      getPCSConfig().setLength(i_length);
      return get(s_tr);
   }


   /**
      <P>Pad/chop the StringBuffer.</P>

      <P>Before returning, this calls</P>

      <P><CODE><a href="#getPCSConfig()">getPCSConfig</a>().<A HREF="~JD~pcsc#setLength(i)~EJD~">setLength</A>(i_length)</CODE></P>

      <P>If you don't need to reset the length every time, then use only <A HREF="~JD~padChop(sb)~EJD~">padChop</A>.</P>

      @return  <CODE>padChop(str_buffer)</CODE>
   **/
   public void padChop(int i_length, StringBuffer str_buffer)  {
      getPCSConfig().setLength(i_length);
      padChop(str_buffer);
   }

   /**
      <P>Get the padded/chopped StringBuffer, based upon the configuration held in the PCSConfig.</P>

      <P>Before returning, this calls</P>

      <P><CODE><a href="#getPCSConfig()">getPCSConfig</a>().<A HREF="~JD~pcsc#setLength(i)~EJD~">setLength</A>(i_length)</CODE></P>

      <P>If you don't need to reset the length every time, then use only <A HREF="~JD~padChop(sob)~EJD~">padChop</A>.</P>

      @return  <CODE>padChop(str_orBfr)</CODE>
   **/
   public void padChop(int i_length, StringOrBuffer str_orBfr)  {
      getPCSConfig().setLength(i_length);
      padChop(str_orBfr);
   }

   /**
      <P>Get some information about this <CODE>PadChopString</CODE>.</P>
    **/
   public final String toString()  {
      return this.getClass().getName() + ":  getPCSConfig()=[" + getPCSConfig().toString() + "]";
   }
}