/*
   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.array.primitive;
   import xbn.array.APChar;

   import java.util.Arrays;

/**
   <P>Defines the rules to be enforced by PrimitiveArrayChar.isValid.  See <A HREF="~JD~pac~EJD~">PrimitiveArrayChar</A>.<A HREF="~JD~pac#isValid(s,s)~EJD~">isValid</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/array/primitive/PARChar.java">PARChar.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 PARChar extends PrimitiveArrayRule  {
   private char[] acIllegal = null;
   private APChar apcIllegal = null;

   /**
      <P>Create a completely unrestricted PARChar.</P>

      <P>Equal to <CODE><A HREF="~JD~parc(pardnl)~EJD~">PARChar</A>(new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>())</CODE></P>

      <P>Using this constructor causes <A HREF="#isRestricted()">isRestricted</A> to equal true (until values are subsequently altered).</P>
    **/
   public PARChar()  {
      //OLD, NO LONGER APPLICABLE TO THIS CLASS, BUT STILL INTERESTING
      //NOTE:
         //this(null)
         //results in an "Ambiguous invocation of constructor"
         //compiler error, using Jikes.  I think it is a Jikes bug.
      this(new PARDupNullLen());
   }

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

      <P>Equal to <CODE><A HREF="~JD~parc(pardnl,parod)~EJD~">PARChar</A>(par_dupNullLen, (new <A HREF="~JD~parod#parod()~EJD~">PAROrderDir</A>()))</CODE></P>
    **/
   public PARChar(PARDupNullLen par_dupNullLen)  {
      this(par_dupNullLen, (new PAROrderDir()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~parc(pardnl,parod)~EJD~">PARChar</A>((new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>()), par_orderDir)</CODE></P>
    **/
   public PARChar(PAROrderDir par_orderDir)  {
      this((new PARDupNullLen()), par_orderDir);
   }

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

      <P>Equal to <CODE><A HREF="~JD~parc(pardnl,c[])~EJD~">PARChar</A>((new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>()), ac_illegal)</CODE></P>
    **/
   public PARChar(char[] ac_illegal)  {
      this((new PARDupNullLen()), ac_illegal);
   }

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

      <P>Equal to <CODE><A HREF="~JD~parc(pardnl,parod,c[])~EJD~">PARChar</A>(par_dupNullLen, par_orderDir, (new char[] {}))</CODE></P>
    **/
   public PARChar(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir)  {
      this(par_dupNullLen, par_orderDir, (new char[] {}));
   }

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

      <P>Equal to <CODE><A HREF="~JD~parc(pardnl,parod,c[])~EJD~">PARChar</A>(par_dupNullLen, (new <A HREF="~JD~parod#parod()~EJD~">PAROrderDir</A>()), ac_illegal)</CODE></P>
    **/
   public PARChar(PARDupNullLen par_dupNullLen, char[] ac_illegal)  {
      this(par_dupNullLen, (new PAROrderDir()), ac_illegal);
   }

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

      <P>Equal to <CODE><A HREF="~JD~parc(pardnl,parod,c[])~EJD~">PARChar</A>((new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>()), par_dupNullLen, par_orderDir, ac_illegal)</CODE></P>
    **/
   public PARChar(PAROrderDir par_orderDir, char[] ac_illegal)  {
      this((new PARDupNullLen()), par_orderDir, ac_illegal);
   }

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

      <P>The first line of this constructor calls <CODE><A HREF="~JD~par#par(pardnl,parod)~EJD~">PrimitiveArrayRule</A>(par_dupNullLen, par_orderDir)</CODE>.</P>

      @param  ac_illegal  Contains all chars considered illegal.  Note that this is <A HREF="~JD~jua#sort(c[])~EJD~">sorted</A> in this constructor.  May not be null.  If zero elements in length, no chars are considered illegal.
    **/
   public PARChar(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir, char[] ac_illegal)  {
      super(par_dupNullLen, par_orderDir);

      if(ac_illegal != null)  {
         Arrays.sort(ac_illegal);
      }

      acIllegal = ac_illegal;
      apcIllegal = new APChar(ac_illegal);
   }


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

      <P>The first line of this constructor calls <CODE><A HREF="~JD~par#par(par)~EJD~">PrimitiveArrayRule</A>(par_char)</CODE></P>
    **/
   public PARChar(PARChar par_char)  {
      super(par_char);
      acIllegal = par_char.acIllegal;
      apcIllegal = par_char.apcIllegal;
   }


   /**
      <P>Get the array of chars considered illegal, as an APChar.</P>

      @return  <CODE>(new <A HREF="~JD~apc#apc(c[])~EJD~">APChar</A>(ac_illegal))</CODE>  Where ac_illegal is exactly as provided to the <A HREF="~JD~parc(pardnl,parod,c[])~EJD~">constructor</A> (except that it is <A HREF="~JD~jua#sort(c[])~EJD~">sorted</A>).  Note this object is only created once.
    **/
   public final APChar getAPCIllegal()  {
      return apcIllegal;
   }

   /**
      <P>Is there at least one int considered illegal?</P>

      @return  <CODE>(<A HREF="#getAPCIllegal()">getAPCIllegal</A>().<A HREF="~JD~apc~EJD~#getLength()">getLength</A>() &gt; 0)</CODE>
    **/
   public final boolean hasIllegalChars()  {
      return (getAPCIllegal().getLength() > 0);
   }

   /**
      <P>Is the provided char illegal?</P>

      @param  c_har  The char to determine legality of.  May not be null.
      @return  <CODE>(<A HREF="~JD~jua~EJD~">Arrays</A>.<A HREF="~JD~jua#binarySearch(c[],c)~EJD~">binarySearch</A>(ac_illegal, c_har) &gt; -1)</CODE>  Where ac_illegal is exactly as provided to the <A HREF="~JD~parc(pardnl,parod,c[])~EJD~">constructor</A>.
    **/
   public boolean isIllegal(char c_har)  {
      return (Arrays.binarySearch(acIllegal, c_har) > -1);
   }

   /**
      <P>Does this PARChar have <I>any</I> restrictions?</P>

      @return  <CODE>(<A HREF="~JD~pac~EJD~">super</A>.<A HREF="~JD~par~EJD~#isRestricted()">isRestricted</A>()  ||  <A HREF="#getAPCIllegal()">getAPCIllegal</A>().<A HREF="~JD~apc~EJD~#getLength()">getLength</A>() &gt; 0)</CODE>
    **/
   public boolean isRestricted()  {
      return (super.isRestricted()  ||  getAPCIllegal().getLength() > 0);
   }

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