/*
   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.AssertException;
   import xbn.util.RangeConfig;
   import xbn.util.RCLength;

/**
   <P>A PrimitiveArray for ints.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/array/primitive/PrimitiveArrayInt.java">PrimitiveArrayInt.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 abstract class PrimitiveArrayInt extends PrimitiveArray  {

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

      <P>The first line of this constructor calls <CODE><A HREF="~JD~pa#pa(s,par)~EJD~">PrimitiveArray</A>(s_fqExtendingClass, par_int)</CODE></P>

      @param  par_int  Defines the rules to be enforced by <A HREF="~JD~pa~EJD~#isValid()">isValid</A>.  May not be null.  See <A HREF="#getPARInt()">getPARInt</A>.
    **/
   protected PrimitiveArrayInt(String s_fqExtendingClass, PARInt par_int)  {
      super(s_fqExtendingClass, par_int);
   }

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

      @param  i_dx  The array index.  Must range 0..<CODE>[<A HREF="~JD~pa~EJD~#getLength()">getLength</A>() - 1]</CODE>, inclusive.
      @exception  AssertException  If <A HREF="~JD~pa~EJD~#isNull()">isNull</A> equals true.
    **/
   public abstract int getInt(int i_dx);

   /**
      @return  <CODE>(new <A HREF="~JD~I#I(i)~EJD~">Integer</A>(<A HREF="#getInt(int)">getInt</A>(i_dx))).<A HREF="~JD~I~EJD~#toString()">toString</A>()</CODE>
    **/
   public final String getString(int i_dx)  {
      return (new Integer(getInt(i_dx))).toString();
   }

   //Documented via super
   public final boolean areLmntsEqual(int i_idxThis, PrimitiveArray pa_other, int i_idxOther)  {
      return areLmntsEqual(i_idxThis, (PrimitiveArrayInt)pa_other, i_idxOther);
   }

   /**
      <P>Is an element in <I>this</I> PrimitiveArrayInt equal to an element in another?</P>

      <P>For documentation on this function, see <A HREF="~JD~pa~EJD~">PrimitiveArray</A>.<A HREF="~JD~pa#areLmntsEqual(i,pa,i)~EJD~">areLmntsEqual</A>.</P>
    **/
   public final boolean areLmntsEqual(int i_idxThis, PrimitiveArrayInt pai_other, int i_idxOther)  {
      try  {
         //Must get other first.  throwLmntsEqualAioobx will crash
         //if it is passed a null pai_other.
         int iOther = pai_other.getInt(i_idxOther);
         return (getInt(i_idxThis) == iOther);

      }  catch(NullPointerException npx)  {
         throwAX("areLmntsEqual:  pai_other is null.");
      }  catch(ArrayIndexOutOfBoundsException aioobx)  {
         throwLmntsEqualAioobx(i_idxThis, "pai_other", pai_other, i_idxOther);
      }

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

   /**
      <P>Get the PARInt for direct manipulation.</P>

      @return (<A HREF="PARInt.html">PARInt</A>)<A HREF="~JD~pai(s,pari)~EJD~">constructor</A>.
    **/
   public final PARInt getPARInt()  {
      return (PARInt)getPrimitiveArrayRule();
   }

   /**
      <P>Is the [object wrapped to look like an array of ints] legal?</P>

      @param  s_callingClsFnc  The name of the class-dot-function for use in potential error messages only.  This is the place where the error message should appear that it was generated from.  For example:  <CODE>xbn.util.PrimitiveArrayInt.crashIfInvalid</CODE>.
      @param  s_varName  The descriptive name of the int array, for potential error messages only.
      @return  <B>true</B>  If all rules configured into the <A HREF="#getPARInt()">PARInt</A> are followed by the [object wrapped to look like an array of ints].
      <BR><B>false</B>  If any rules are violated.
    **/
   public final boolean isValid(String s_callingClsFnc, String s_varName)  {
      if(wasValidated())  {
         return true;
      }

      if(!getPARInt().isRestricted())  {
         //There are no restrictions.  Everything is legal.
         declareNoViolation();
         return true;
      }

      //To make the below code a bit more consice...START
         boolean bNullOk = getPARInt().getPARDupNullLen().isNullOk();
         RCLength rclArray = getPARInt().getPARDupNullLen().getRCLength();
         boolean bDupsOk = getPARInt().getPARDupNullLen().areDupsOk();
         boolean bOrdered = getPARInt().getPAROrderDir().isOrdered();
         RangeConfig rcLmnt = getPARInt().getPARIElement().getRangeConfig();

         boolean bAXIfBad = (s_callingClsFnc != null  ||  s_varName != null);
      //To make the below code a bit more consice...END

      if(!bNullOk)  {
         if(isNull())  {
            setPAViolation(new PAViolation(PAViolation.getType_NULL()));
            if(bAXIfBad)  {
               throwAXIllegal(s_callingClsFnc, s_varName, "isNull() equals true.");
            }
            return false;
         }

      }  else if(isNull())  {
         //A null array cannot be analyzed further.
         declareNoViolation();
         return true;
      }
      //The array is not null.

      if(!rclArray.isValid(getLength()))  {
         setPAViolation(new PAViolation(PAViolation.getType_LENGTH()));
         if(bAXIfBad)  {
            throwAXIllegal(s_callingClsFnc, s_varName, "the number of elements in the array (" + getLength() + ") is illegal according to getPARInt().getArrayRCL().isValid().");
         }
         return false;

      }  else if(getLength() < 1)  {
         //The array is zero elements in length, and this is okay.
         //An empty array can, but does not need to be analyzed further.
         declareNoViolation();
         return true;
      }
      //The string array has at least one element.

      final String sLMNT = "element ";

      for(int i = 0; i < getLength(); i++)  {
         if(!rcLmnt.isValid(getInt(i)))  {
            setPAViolation(new PAViolation(PAViolation.getType_ILMNT_OOBOUNDS(), i));
            if(bAXIfBad)  {
               throwAXIllegal(s_callingClsFnc, s_varName, sLMNT + i + " ('" + getInt(i) + "') is illegal according to getPARInt().getRCLength().isValid().");
            }
            return false;
         }
         //Element i is valid according to the range.

         if(getPARInt().getPARIElement().hasIllegalInts())  {
            //There is at least one int considered illegal

            if(getPARInt().getPARIElement().isIllegal(getInt(i)))  {
               setPAViolation(new PAViolation(PAViolation.getType_LMNT_ILLEGAL(), i));
               if(bAXIfBad)  {
                  throwAXIllegal(s_callingClsFnc, s_varName, sLMNT + i + " (" + getInt(i) + ") is illegal.  getPARInt().getPARIElement().isIllegal(" + getInt(i) + ") equals true.");
               }
               return false;
            }
         }
         //Element i is not equal to any of the illegal characters, or there
         //are no illegal chars.

         //Compare this element with every element after this one (i + 1)
         for(int j = (i + 1); j < getLength(); j++)  {
            if(!bDupsOk)  {
               //Duplicates are not good.
               if(getInt(i) == getInt(j))  {
                  setPAViolation(new PAViolation(PAViolation.getType_LMNT_DUPLICATE(), i, j));
                  if(bAXIfBad)  {
                     throwAXIllegal(s_callingClsFnc, s_varName, "elements " + i + " and " + j + " are equal ('" + getInt(i) + "').");
                  }
               return false;
               }
            }  //ELSE:  It is okay for elements to equal one
               //       another.

            //I don't care if ints are contained in one another.
            //If you want to test for this, then use a
            //PrimitiveArrayString (like PASInt).

            if(bOrdered)  {
               //Ordering is required.

               if(getPARInt().getPAROrderDir().getDirectionAscDesc())  {
                  //Order direction is ascending
                  if(getInt(i) > getInt(j))  {
                     setPAViolation(new PAViolation(PAViolation.getType_LMNT_OOORDER(), i, j));
                     if(bAXIfBad)  {
                        throwAXIllegal(s_callingClsFnc, s_varName, sLMNT + i + "  (" + getInt(i) + ") is greater than " + j + " (" + getInt(j) + ").");
                     }
                     return false;
                  }
                  //i is less than j.  GOOD.
                  continue;

               }
               //Order direction is descending

               if(getInt(i) < getInt(j))  {
                  setPAViolation(new PAViolation(PAViolation.getType_LMNT_OOORDER(), i, j));
                  if(bAXIfBad)  {
                     throwAXIllegal(s_callingClsFnc, s_varName, sLMNT + i + "  (" + getInt(i) + ") is less than " + j + " (" + getInt(j) + ").");
                  }
                  return false;
               }
               //i is greater than j.  GOOD.
               continue;
            }
            //Ordering is not required.
         }
      }


//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS
//LMNT OUT OF BOUNDS


      //We've gotten this far, everything is good!
      declareNoViolation();
      return true;
   }

   /**
      <P>What is the maximum value contained in the array?</P>

      @exception  AssertException  If <A HREF="~JD~pa~EJD~#isNull()">isNull</A> equals true.
    **/
   public final int getMaximum()  {
      int iLength = -1;
      try  {
         iLength = getLength();
      }  catch(AssertException ax)  {
         throwAX("getMaximum:  isNull() equals true.");
      }

      int iMax = getInt(0);
      for(int i = 1; i < iLength; i++)  {
         if(iMax < getInt(i))  {
            iMax = getInt(i);
         }
      }

      return iMax;
   }

   /**
      <P>What is the minimum value contained in the array?</P>

      @exception  AssertException  If <A HREF="~JD~pa~EJD~#isNull()">isNull</A> equals true.
    **/
   public final int getMinimum()  {
      int iLength = -1;
      try  {
         iLength = getLength();
      }  catch(AssertException ax)  {
         throwAX("getMinimum:  isNull() equals true.");
      }

      int iMin = getInt(0);
      for(int i = 1; i < iLength; i++)  {
         if(iMin > getInt(i))  {
            iMin = getInt(i);
         }
      }

      return iMin;
   }
}