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

/**
   <P>A PrimitiveArrayInt that wraps around an array of ints.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/array/primitive/PAIInt.java">PAIInt.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 PAIInt extends PrimitiveArrayInt implements LockOneWay  {
   /**
      <P>To shorten code and Javadoc.</P>

      <P>Equal to <B>"xbn.array.primitive.PAIInt"</B></P>
    **/
   public static final String sPAII = "xbn.array.primitive.PAIInt";

   private int[] aInt = null;
   private boolean bLocked = false;

   /**
      <P>Create a PAIInt with default values.</P>

      <P>Equal to <CODE><A HREF="~JD~paii(i[])~EJD~">PAIInt</A>(null)</CODE></P>
    **/
   public PAIInt()  {
      this(null);
   }

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

      <P>Equal to <CODE><A HREF="~JD~paii(s,i[])~EJD~">PAIInt</A>(<A HREF="#sPAII">sPAII</A>, a_int)</CODE></P>
    **/
   public PAIInt(int[] a_int)  {
      this(sPAII, a_int);
   }

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

      <P>Equal to <CODE><A HREF="~JD~paii(s,i[],pari)~EJD~">PAIInt</A>(s_fqExtendingClass, a_int, (new <A HREF="~JD~pari#pari()~EJD~">PARInt</A>()))</CODE></P>
    **/
   public PAIInt(String s_fqExtendingClass, int[] a_int)  {
      this(s_fqExtendingClass, a_int, (new PARInt()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~paii(s,i[],pari)~EJD~">PAIInt</A>(<A HREF="#sPAII">sPAII</A>, a_int)</CODE></P>
    **/
   public PAIInt(int[] a_int, PARInt par_int)  {
      this(sPAII, a_int, par_int);
   }

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

      <P>Equal to <CODE><A HREF="~JD~paii(s,i[],pari,b)~EJD~">PAIInt</A>(s_fqExtendingClass, a_int, par_int)</CODE></P>
    **/
   public PAIInt(String s_fqExtendingClass, int[] a_int, PARInt par_int)  {
      this(s_fqExtendingClass, a_int, par_int, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~paii(s,i[],pari,b)~EJD~">PAIInt</A>(<A HREF="#sPAII">sPAII</A>, a_int, (new <A HREF="~JD~pari#pari()~EJD~">PARInt</A>()), b_lock)</CODE></P>
    **/
   public PAIInt(int[] a_int, boolean b_lock)  {
      this(sPAII, a_int, (new PARInt()), b_lock);
   }

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

      <P>Equal to <CODE><A HREF="~JD~paii(s,i[],pari,b)~EJD~">PAIInt</A>(s_fqExtendingClass, a_int, (new <A HREF="~JD~pari#pari()~EJD~">PARInt</A>()), b_lock)</CODE></P>
    **/
   public PAIInt(String s_fqExtendingClass, int[] a_int, boolean b_lock)  {
      this(s_fqExtendingClass, a_int, (new PARInt()), b_lock);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pai#pai(s,pari)~EJD~">PrimitiveArrayInt</A>(s_fqExtendingClass, par_int)</CODE></P>

      @param  a_int  The array of ints to analyze.
      @param  b_lock  Should the int array be directly accessible, via <A HREF="#getAOInt()">getAOInt</A>?  If true, yes.  If false, no.
    **/
   public PAIInt(String s_fqExtendingClass, int[] a_int, PARInt par_int, boolean b_lock)  {
      super(s_fqExtendingClass, par_int);
      aInt = a_int;
      bLocked = b_lock;
   }

   /**
      <P>Get the array of ints for direct manipulation.</P>

      @return  <B>a_int</B>  Exactly as provided to the <A HREF="~JD~paii(s,i[],pari,b)~EJD~">constructor</A>.
    **/
   public int[] getAOInt()  {
      throwLXIfLocked(isLocked(), "getAOInt");
      return aInt;
   }

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

      @param  i_dx  The array index.  Must range 0..<CODE>[<A HREF="#getLength()">getLength</A>() - 1]</CODE>, inclusive
      @exception  AssertException  If <A HREF="#isNull()">isNull</A> equals true.
    **/
   public int getInt(int i_dx)  {
      try  {
         return aInt[i_dx];
      }  catch(NullPointerException npx)  {
         throwAX("getInt:  isNull() equals true.");
      }  catch(ArrayIndexOutOfBoundsException aioobx)  {
         throwAX("getInt:  i_dx (" + i_dx + ") is invalid.  getLength()=" + getLength() + ".");
      }

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

   /**
      <P>How many elements are in this PAIInt?</P>

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

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

   /**
      <P>Is the int array null?</P>

      @return  <CODE>(a_int == null)</CODE>  Where a_int is exactly as passed into the <A HREF="~JD~paii(s,i[],pari,b)~EJD~">constructor</A>.
    **/
   public boolean isNull()  {
      return (aInt == null);
   }

   /**
      <P>Is the char at the requested array index null?</P>

      @return  <B>false</B>  It is not possible for a char to be null.
    **/
   public boolean isNull(int i_dx)  {
      return false;
   }


   /**
      <P>Get a PASInt containing the same int array as exists in this class.</P>

      @return  <CODE>(new <A HREF="~JD~pasi#pasi(i[],b)~EJD~">PASInt</A>(a_int, <A HREF="#isLocked()">isLocked</A>()))</CODE>  Where a_int is exactly as passed into the <A HREF="~JD~paii(i[],pari)~EJD~">constructor</A>.
    **/
   public final PASInt getPASInt()  {
      return (new PASInt(aInt, isLocked()));
   }


   //Required by LockOneWay...START
      public final void lock()  {
         bLocked = true;
      }

      public final boolean isLocked()  {
         return bLocked;
      }
   //Required by LockOneWay...END
}