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

/**
   <P>Ensure an array of objects is valid, according to the rules existing in an AOOVConfig.  See <A HREF="AOOVConfig.html">AOOVConfig</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/array/AOOValid.java">AOOValid.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 AOOValid extends XBNObject  {
   private AOOVConfig aoovc = null;
   private boolean bValidated = false;

   /**
      <P>Create a completely unrestricted AOOValid.</P>

      <P>Equal to <CODE><A HREF="~JD~aoov(aoovc)~EJD~">AOOValid</A>(new <A HREF="~JD~aoovc#aoovc()~EJD~">AOOVConfig</A>())</CODE></P>
    **/
   public AOOValid()  {
      this(new AOOVConfig());
   }

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

      @param  aoov_config  The configuration defining "valid".  May not be null.
    **/
   public AOOValid(AOOVConfig aoov_config)  {
      throwAXIfNull(aoov_config, "aoov_config", sCNSTR);
      aoovc = aoov_config;
   }

   /**
      <P>Was the object array validated?</P>

      @return  <B>true</B>  If <A HREF="~JD~isValid(s,s,o[])~EJD~">isValid</A> was called at least once, and it returned true.
      <BR><B>false</B>  If isValid was never called, or it was called, but returned false.
    **/
   public final boolean wasValidated()  {
      return bValidated;
   }

   /**
      <P>When extending the isValid function, you must call this immediately before your function returns true.</P>
    **/
   protected final void declareNoViolation()  {
      bValidated = true;
   }

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

      @return  <B>aoov_config</B>  Exactly as provided to the <A HREF="~JD~aoov(aoovc)~EJD~">constructor</A>.
    **/
   public final AOOVConfig getAOOVConfig()  {
      return aoovc;
   }

   /**
      <P>Is the provided array of objects legal according to the rules existing in the AOOVConfig?</P>

      @return  <CODE><A HREF="~JD~isValid(s,s,o[])~EJD~">isValid</A>(null, null, a_object)</CODE>
    **/
   public boolean isValid(Object[] a_object)  {
      return isValid(null, null, a_object);
   }

   /**
      <P>Is the provided array of objects legal according to the rules existing in the AOOVConfig?</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.array.primitive.PrimitiveArrayChar.crashIfInvalid</CODE>.
      @param  s_varName  The descriptive name of the char array, for potential error messages only.
      @param  a_object  The object array to analyze.
      @return  <B>true</B>  If all rules configured into the <A HREF="#getAOOVConfig()">AOOVConfig</A> are followed.
      <BR><B>false</B>  If any rules are violated.  Note, when either s_callingClsFnc and/or s_varName are non-null, this instead will throw an <A HREF="~JD~ax~EJD~">AssertException</A>.
    **/
   public boolean isValid(String s_callingClsFnc, String s_varName, Object[] a_object)  {
      boolean bXIfBad = false;
      if(s_callingClsFnc != null  ||  s_varName != null)  {
         bXIfBad = true;
      }

      if(!getAOOVConfig().isNullOk())  {
         if(a_object == null)  {
            if(bXIfBad)  {
               throwAXBad(s_callingClsFnc, s_varName, "a_object is null");
            }
            return false;
         }

      }  else if(a_object == null)  {
         //It is null, and this is okay.  A null array cannot be analyzed
         //further.
         declareNoViolation();
         return true;
      }
      //a_object is not null.

      if(getAOOVConfig().getRCLength().isRestricted()  &&
         	!getAOOVConfig().getRCLength().isValid(a_object.length))  {
         if(bXIfBad)  {
            throwAXBad(s_callingClsFnc, s_varName, "a_object's length (" + a_object.length + ") is invalid according to getAOOVConfig().getRCLength().isValid()");
         }
         return false;
      }

      if(getAOOVConfig().isNullLmntOk())  {
         declareNoViolation();
         return true;
      }
      //Null elements are not okay.

      for(int i = 0; i < a_object.length; i++)  {
         if(a_object[i] == null)  {
            if(bXIfBad)  {
               throwAXBad(s_callingClsFnc, s_varName, "a_object[" + i + "] is null");
            }
            return false;
         }
      }

      //We've made it to the end of our journey.  I'm glad we've come
      //this far together.
      declareNoViolation();
      return true;
   }

   /**
      <P>If the provided object array is invalid, throw a descriptive error message.</P>

      <P>Equal to <CODE><A HREF="~JD~crashIfBad(s,s,o[])~EJD~">crashIfBad</A>("xbn.array.AOOValid", "a_object", a_object)</CODE></P>
    **/
   public final void crashIfBad(Object[] a_object)  {
      crashIfBad("xbn.array.AOOValid", "a_object", a_object);
   }

   /**
      <P>If the provided object array is invalid, throw a descriptive error message.</P>

      <P>Equal to <CODE><A HREF="~JD~isValid(s,s,o[])~EJD~">isValid</A>(s_callingClsFnc, s_varName, a_object)</CODE>  (<I>supressing the error message</I>)</P>

      <P>Note that before isValid is called, both s_callingClsFnc and s_varName are validated to be both non-null and at least one character in length.</P>
    **/
   public final void crashIfBad(String s_callingClsFnc, String s_varName, Object[] a_object)  {
      throwAXIfBadStr(s_callingClsFnc, "s_callingClsFnc", "crashIfBad");
      throwAXIfBadStr(s_varName, "s_varName", "crashIfBad");

      //We don't care what it returns, this is just to indicate that it *does* return something.
      boolean bUNRTRND = isValid(s_callingClsFnc, s_varName, a_object);
   }

   /**
      <P>Used internally, by isValid.  See the code for <A HREF="~JD~isValid(s,s,o[])~EJD~">isValid</A>.</P>
    **/
   protected final void throwAXBad(String s_callingClsFnc, String s_varName, String s_currently)  {
      throwAX(s_callingClsFnc + ":  " + s_varName + " is invalid according to [" + getAOOVConfig().toString() + "].  Currently, " + s_currently + ".");
   }
}