/*
   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>As PrimitiveArrayString that wraps around an array of ints.</P>

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

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

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


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

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

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

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

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

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

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

      <P>Equal to <CODE><A HREF="~JD~pasi(s,i[],pars)~EJD~">PASInt</A>(<A HREF="#sPASI">sPASI</A>, a_int, par_string)</CODE></P>
    **/
   public PASInt(int[] a_int, PARString par_string)  {
      this(sPASI, a_int, par_string);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasi(s,i[],pars,b)~EJD~">PASInt</A>(s_fqExtendingClass, a_int, par_string, false)</CODE></P>
    **/
   public PASInt(String s_fqExtendingClass, int[] a_int, PARString par_string)  {
      this(s_fqExtendingClass, a_int, par_string, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pasi(s,i[],pars,b)~EJD~">PASInt</A>(<A HREF="#sPASI">sPASI</A>, a_int, (new <A HREF="~JD~pars#pars()~EJD~">PARString</A>()), b_lock)</CODE></P>
    **/
   public PASInt(int[] a_int, boolean b_lock)  {
      this(sPASI, a_int, (new PARString()), b_lock);
   }

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

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

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

      <P>The first line of this constructor calls <CODE><A HREF="~JD~pas#pas(s,pars)~EJD~">PrimitiveArrayInt</A>(s_fqExtendingClass, par_string)</CODE></P>

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

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

      @return  <B>a_int</B>  Exactly as provided to the <A HREF="~JD~pasi(s,i[],b)~EJD~">constructor</A>.
      @exception  LockedException  If <A HREF="#isLocked()">isLocked</A> equals true.
    **/
   public final int[] getAOInt()  {
      throwLXIfLocked(isLocked(), "getAOInt");
      return aInt;
   }

   /**
      <P>Get the (int translated to a) string at the requested array index.</P>

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

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

   /**
      <P>How many elements exist in this PASInt?</P>

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

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

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

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

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

      @return  <B>false</B>  An int can never be null.
    **/
   public final boolean isNull(int i_dx)  {
      return false;
   }

   /**
      <P>Get a new PAIInt from the internally held int array.</P>

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

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

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