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

   import java.util.Arrays;

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

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

   /**
      <P>Create an APInt.</P>
    **/
   public APInt(int[] a_int)  {
      this(a_int, false);
   }

   /**
      <P>Create an APInt.</P>
    **/
   public APInt(int[] a_int, boolean b_shallowCloneAOS)  {
      ai = a_int;

      if(b_shallowCloneAOS)  {
         ai = getAOIClone();
         //Now aiClone is set, too.
      }
   }


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


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

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

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

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

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


   public final String getString(int i_dx)  {
      return (new Integer(getInt(i_dx))).toString();
   }

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

      @return  <CODE>(<A HREF="~JD~api#binarySearch(i)~EJD~">binarySearch</A>(i_nt) &gt; -1)</CODE>
    **/
   public final boolean doesExistInSrtd(int i_nt)  {
      return (binarySearch(i_nt) > -1);
   }

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

      <P><I>You must ensure that the a_char <A HREF="~JD~api(i[],b)~EJD~">constructor</A> parameter is properly <A HREF="~JD~jua#sort(i[])~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(i[],i)~EJD~">binarySearch</A>([INT-ARRAY-BEING-PROTECTED], i_nt)</CODE>
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> equals true.
    **/
   public final int binarySearch(int i_nt)  {
      try  {
         return Arrays.binarySearch(ai, i_nt);
      }  catch(NullPointerException npx)  {
         throwAX("binarySearch:  isNull() equals true.");
      }

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

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

   /**
      <P>Add the int-array-being-protected to the provided VWInt.</P>

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

      @param  ac_int  The VWInt to add to.  May not be null.
    **/
   public final void addToACInt(VWInt ac_int)  {
      if(isNull())  {
         return;
      }

      try  {
         ac_int.addArray(ai);
      }  catch(NullPointerException npx)  {
         throwAX("addToACInt:  ac_int is null.");
      }
   }


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

      @return  <CODE>(new <A HREF="~JD~utila~EJD~">UtilArray</A>()).<A HREF="~JD~utila#getAOIClone(i[])~EJD~">getAOIClone</A>(a_int)</CODE>  Where a_int is exactly as provided to the <A HREF="~JD~api(i[],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 int[] getAOIClone()  {
      if(bCloneMade)  {
         return ai;
      }

      ai = (new UtilArray()).getAOIClone(ai);
      bCloneMade = true;
      return ai;
   }


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

      @return  <CODE>(new <A HREF="~JD~paii#paii(i[],b)~EJD~">PAIInt</A>(<A HREF="#getAOIClone()">getAOIClone</A>(), true))</CODE>
    **/
   public final PAIInt getPAIInt()  {
      return (new PAIInt(getAOIClone(), true));
   }

   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(getPAIInt().getList("', '")).append("']");

      return sb.toString();
   }

   //Cloning...START
      /**
         <P>Get a full (deep) copy of this APInt.</P>

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

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

      /**
         <P>Get a full (deep) copy of this APInt as an Object.</P>

         @return <CODE>(new APInt(a_int))</CODE>  Where a_int is exactly as provided to the <A HREF="~JD~api(i[],b)~EJD~">constructor</A>.
       **/
      protected final Object clone() throws CloneNotSupportedException  {
         return new APInt(ai);
      }
   //Cloning...END


   final int[] getAOInt()  {
      return ai;
   }
}