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

   import java.util.Arrays;

/**
   <P>An ArrayProtector for chars.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/array/APChar.java">APChar.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 APChar extends ArrayProtector  {
   private char[] ac = null;
   private boolean bCloneMade = false;

   /**
      <P>Create an APChar.</P>
    **/
   public APChar(char[] a_char)  {
      this(a_char, false);
   }

   /**
      <P>Create an APChar.</P>
    **/
   public APChar(char[] a_char, boolean b_cloneAOC)  {
      ac = a_char;

      if(b_cloneAOC)  {
         ac = getAOCClone();
         //Now acShallowClone is set, too.
      }
   }


   /**
      @return  <CODE>(a_char == null)</CODE>  Where a_char is exactly as provided to the <A HREF="~JD~apc(c[],b)~EJD~">constructor</A>.
    **/
   public final boolean isNull()  {
      return (ac == null);
   }

   /**
      @return  <CODE>a_char.length</CODE>  Where a_char is exactly as provided to the <A HREF="~JD~apc(c[],b)~EJD~">constructor</A>.
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> is true.
    **/
   public final int getLength()  {
      try  {
         return ac.length;
      }  catch(NullPointerException npx)  {
         throwAX("getLength:  isNull() equals true.");
      }

      //Never reached.  Required for compile.
      return -1;
   }

   /**
      <P>Get the char at the requested array index.</P>

      @return  <CODE>a_char[i_dx]</CODE>  Where a_char is exactly as provided to the <A HREF="~JD~apc(c[],b)~EJD~">constructor</A>.
    **/
   public final char getChar(int i_dx)  {
      try  {
         return ac[i_dx];
      }  catch(NullPointerException npx)  {
         throwAX("getChar:  isNull() equals true.");
      }  catch(IndexOutOfBoundsException ioobx)  {
         throwAX("getChar:  i_dx (" + i_dx + ") is invalid.  getLength()=" + getLength() + ".");
      }

      //Never reached.  Required for compile.
      return ' ';
   }

   public final String getString(int i_dx)  {
      return (new Character(getChar(i_dx))).toString();
   }

   public final boolean isNull(int i_dx)  {
      return false;
   }


   /**
      <P>Does the provided character exist in the <I>sorted</I> char-array-being-protected?</P>

      @return  <CODE>(<A HREF="#binarySearch(char)">binarySearch</A>(c_har) &gt; -1)</CODE>
    **/
   public final boolean doesExistInSrtd(char c_har)  {
      return (binarySearch(c_har) > -1);
   }

   /**
      <P>Return the array index at which the provided character exists.</P>

      <P><I>You must ensure that the a_char <A HREF="~JD~apc(c[],b)~EJD~">constructor</A> parameter is properly <A HREF="~JD~jua#sort(c[])~EJD~">sorted</A>.  Otherwise this function provides unpredictable results</I></P>

      @return  <CODE><A HREF="~JD~jua~EJD~">Arrays</A>.<A HREF="~JD~jua#binarySearch(c[],c)~EJD~">binarySearch</A>([CHAR-ARRAY-BEING-PROTECTED], c_har)</CODE>
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> equals true.
    **/
   public final int binarySearch(char c_har)  {
      try  {
         return Arrays.binarySearch(ac, c_har);
      }  catch(NullPointerException npx)  {
         throwAX("binarySearch:  isNull() equals true.");
      }

      //Never reached.  Required for compile.
      return -1;
   }

   /**
      <P>Add the char-array-being-protected to the provided VWChar.</P>

      <P>If <A HREF="#isNull()">isNull</A> equals true, nothing is done.  If false, then <CODE>ac_char.<A HREF="~JD~vwc#addArray(c[])~EJD~">addArray</A>([INTERNAL CHAR ARRAY])</CODE> is called.</P>

      @param  ac_char  The VWChar to add to.  May not be null.
    **/
   public final void addToACChar(VWChar ac_char)  {
      if(isNull())  {
         return;
      }

      try  {
         ac_char.addArray(ac);
      }  catch(NullPointerException npx)  {
         throwAX("addToACChar:  ac_char is null.");
      }
   }

   /**
      <P>Get a full (deep) copy of the char-array-being-wrapped.</P>

      @return  <CODE>(new <A HREF="~JD~utila~EJD~">UtilArray</A>()).<A HREF="~JD~utila#getAOCClone(c[])~EJD~">getAOCClone</A>(a_char)</CODE>  Where a_char is exactly as provided to the <A HREF="~JD~apc(c[],b)~EJD~">constructor</A>.  <I>Note that this function only creates the clone once.  Once created, the copy is then internally stored, and returned for all subsequent calls.</I>
    **/
   public final synchronized char[] getAOCClone()  {
      if(bCloneMade)  {
         return ac;
      }

      ac = (new UtilArray()).getAOCClone(ac);
      bCloneMade = true;
      return ac;
   }

   /**
      <P>Get a new PACChar wrapping around the char-array-being-protected.</P>

      @return  <CODE>(new <A HREF="~JD~pacc#pacc(c[],b)~EJD~">PACChar</A>(<A HREF="#getAOCClone()">getAOCClone</A>(), true))</CODE>
    **/
   public final PACChar getPACChar()  {
      return (new PACChar(getAOCClone(), true));
   }
   //Cloning...START
      /**
         <P>Get a full (deep) copy of this APChar.</P>

         @return  <CODE>(APChar)<A HREF="#clone()">clone</A>()</CODE>
       **/
      public final APChar getAPCClone()  {
         try  {
            return (APChar)clone();
         }  catch(CloneNotSupportedException cnsx)  {
            throwAX("getAPCClone [SHOULD NEVER HAPPEN!]:  " + cnsx.toString());
         }

         //Never reached.  Required for compile.
         return null;
      }

      /**
         <P>Get a full (deep) copy of this APChar as an Object.</P>
       **/
      protected final Object clone() throws CloneNotSupportedException  {
         return (new APChar(getAOCClone()));
      }
   //Cloning...END

   public String toString()  {
      StringBuffer sb = new StringBuffer(this.getClass().getName() + ":  ");

      if(isNull())  {
         sb.append("isNull()=true");
         return sb.toString();
      }
      //It's not null.

      sb.append("['").append(getPACChar().getList("', '")).append("']");

      return sb.toString();
   }


   final char[] getAOChar()  {
      return ac;
   }
}