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

/**
   <P>Configuration for UnescapeString.  See <A HREF="~JD~us~EJD~">UnescapeString</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/string/escape/USConfig.java">USConfig.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 USConfig extends ESConfig implements Cloneable  {
   private USCIgnore usci = null;


   /**
      <P>Create an USConfig with default values.</P>

      <P>Equal to <CODE><A HREF="~JD~usc(c)~EJD~">USConfig</A>(<A HREF="~JD~esc~EJD~#getEscapeCharDefault()">getEscapeCharDefault</A>())</CODE></P>
    **/
   public USConfig()  {
      this(getEscapeCharDefault());
   }

   /**
      <P>Create an USConfig.</P>

      <P>Equal to <CODE><A HREF="~JD~usc(c,c[])~EJD~">USConfig</A>(c_escape, (new char[] {}))</CODE></P>
    **/
   public USConfig(char c_escape)  {
      this(c_escape, (new char[] {}));
   }

   /**
      <P>Create an USConfig.</P>

      <P>Equal to <CODE><A HREF="~JD~usc(c,c[])~EJD~">USConfig</A>(<A HREF="~JD~esc~EJD~#getEscapeCharDefault()">getEscapeCharDefault</A>(), ac_toEscape)</CODE></P>
    **/
   public USConfig(char[] ac_toEscape)  {
      this(getEscapeCharDefault(), ac_toEscape);
   }

   /**
      <P>Create an USConfig.</P>

      <P>Equal to <CODE><A HREF="~JD~usc(c,usci)~EJD~">USConfig</A>(<A HREF="~JD~esc~EJD~#getEscapeCharDefault()">getEscapeCharDefault</A>(), euscu_ignore)</CODE></P>
    **/
   public USConfig(USCIgnore euscu_ignore)  {
      this(getEscapeCharDefault(), euscu_ignore);
   }

   /**
      <P>Create an USConfig.</P>

      <P>Equal to <CODE><A HREF="~JD~usc(c,c[],usci)~EJD~">USConfig</A>(c_escape, ac_toEscape, (new <A HREF="~JD~usci#usci()~EJD~">USCIgnore</A>()))</CODE></P>
    **/
   public USConfig(char c_escape, char[] ac_toEscape)  {
      this(c_escape, ac_toEscape, (new USCIgnore()));
   }

   /**
      <P>Create an USConfig.</P>

      <P>Equal to <CODE><A HREF="~JD~usc(c,c[],usci)~EJD~">USConfig</A>(c_escape, (new char[] {}), euscu_ignore)</CODE></P>
    **/
   public USConfig(char c_escape, USCIgnore euscu_ignore)  {
      this(c_escape, (new char[] {}), euscu_ignore);
   }

   /**
      <P>Create an USConfig.</P>

      <P>Equal to <CODE><A HREF="~JD~usc(c,c[],usci)~EJD~">USConfig</A>(<A HREF="~JD~esc~EJD~#getEscapeCharDefault()">getEscapeCharDefault</A>(), ac_toEscape, euscu_ignore)</CODE></P>
    **/
   public USConfig(char[] ac_toEscape, USCIgnore euscu_ignore)  {
      this(getEscapeCharDefault(), ac_toEscape, euscu_ignore);
   }


   /**
      <P>Create an USConfig.</P>

      <P>The first line of this constructor calls <CODE><A HREF="~JD~esc#esc(c,c[])~EJD~">ESConfig</A>(c_escape, ac_toEscape)</CODE></P>

      @param  euscu_ignore  The exception characters to ignore.  May not be null.  If <CODE>euscu_ignore.<A HREF="~JD~usci~EJD~#getAPCIgnore()">getAPCIgnore</A>()</CODE> is greater than zero elements, then no element may equal c_escape, nor any character in ac_toEscape.
    **/
   public USConfig(char c_escape, char[] ac_toEscape, USCIgnore euscu_ignore)  {
      super(c_escape, ac_toEscape);

      throwAXIfNull(euscu_ignore, "euscu_ignore", sCNSTR);

      boolean bAPCINotEmpty = false;
      try  {
         bAPCINotEmpty = (euscu_ignore.getAPCIgnore().getLength() > 0);
      }  catch(NullPointerException npx)  {
         throwAX("constructor:  euscu_ignore is null.");
      }

      if(bAPCINotEmpty)  {
         if(euscu_ignore.isSpcfcIgnored(c_escape))  {
            throwAX("constructor:  euscu_ignore.getAPCIgnore() contains c_escape ('" + c_escape + "').");
         }

         for(int i = 0; i < ac_toEscape.length; i++)  {
            if(euscu_ignore.isSpcfcIgnored(ac_toEscape[i]))  {
               throwAX("constructor:  euscu_ignore.getAPCIgnore() contains ac_toEscape[" + i + "] ('" + ac_toEscape[i] + "').");
            }
         }
      }


      usci = euscu_ignore;
   }

   /**
      <P>Create a full (deep) copy of the provided USConfig.</P>

      <P>The first line of this constructor calls <CODE><A HREF="~JD~esc#esc(esc)~EJD~">ESConfig</A>(us_config)</CODE></P>
    **/
   public USConfig(USConfig us_config)  {
      super(us_config);
      usci = us_config.usci.getEUSCUIClone();
   }

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

      @return <B>euscu_ignore</B>  Exactly as provided to the <A HREF="~JD~usc(c,c[],usci)~EJD~">constructor</A>.
    **/
   public final USCIgnore getUSCIgnore()  {
      return usci;
   }

   /**
      <P>Get some information about this EUSCUsescape.</P>
    **/
   public String toString()  {
      return super.toString() + ", [" + getUSCIgnore().toString() + "]";
   }
}