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

/**
   <P>PrimitiveArrayRule configuration regarding duplicates, null-ness and element length.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/array/primitive/PARDupNullLen.java">PARDupNullLen.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 PARDupNullLen extends XBNObject  {
   private boolean bDupsOk = false;
   private boolean bNullOk = false;
   private RCLength rcl = null;

   /**
      <P>Create an unrestricted PARDupNullLen.</P>

      <P>Equal to <CODE><A HREF="~JD~pardnl(b)~EJD~">PARDupNullLen</A>(true)</CODE></P>
    **/
   public PARDupNullLen()  {
      this(true);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pardnl(b,b)~EJD~">PARDupNullLen</A>(b_dupsOk, true)</CODE></P>
    **/
   public PARDupNullLen(boolean b_dupsOk)  {
      this(b_dupsOk, true);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pardnl(b,rcl)~EJD~">PARDupNullLen</A>(true, rc_length)</CODE></P>
    **/
   public PARDupNullLen(RCLength rc_length)  {
      this(true, rc_length);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pardnl(b,b,rcl)~EJD~">PARDupNullLen</A>(b_dupsOk, b_nullOk, (new <A HREF="~JD~rcl#rcl()~EJD~">RCLength</A>()))</CODE></P>
    **/
   public PARDupNullLen(boolean b_dupsOk, boolean b_nullOk)  {
      this(b_dupsOk, b_nullOk, (new RCLength()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~pardnl(b,b,rcl)~EJD~">PARDupNullLen</A>(b_dupsOk, true, rc_length)</CODE></P>
    **/
   public PARDupNullLen(boolean b_dupsOk, RCLength rc_length)  {
      this(b_dupsOk, true, rc_length);
   }

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

      @param  b_dupsOk  If true, there may be duplicate values in the array.  If false, all values must be unique.  See <A HREF="#areDupsOk()">areDupsOk</A>.
      @param  b_nullOk  If true, <A HREF="~JD~pa~EJD~">PrimitiveArray</A>.<A HREF="~JD~pa~EJD~#isNull()">isNull</A> may be true.  If false, isNull may not be true.  See <A HREF="#isNullOk()">isNullOk</A>.
      @param  rc_length  The range that the array's length must conform to.  See <A HREF="#getRCLength()">getRCLength</A>.
    **/
   public PARDupNullLen(boolean b_dupsOk, boolean b_nullOk, RCLength rc_length)  {
      bDupsOk = b_dupsOk;
      bNullOk = b_nullOk;
      rcl = rc_length;
   }

   /**
      <P>Create a full (deep) copy of the provided PARDupNullLen.</P>

      @param  par_dupNullLen  The object to copy.  May not be null.
    **/
   public PARDupNullLen(PARDupNullLen par_dupNullLen)  {
      try  {
         bDupsOk = par_dupNullLen.bDupsOk;
      }  catch(NullPointerException npx)  {
         throwAX("constructor:  par_dupNullLen is null.");
      }

      bNullOk = par_dupNullLen.bNullOk;
      rcl = new RCLength(par_dupNullLen.rcl);
   }

   /**
      <P>Is it okay for the array to have duplicate values?</P>

      @return  <B>b_dupsOk</B>  Exactly as provided to the <A HREF="~JD~pardnl(b,b,rcl)~EJD~">constructor</A>.
    **/
   public final boolean areDupsOk()  {
      return bDupsOk;
   }

   /**
      <P>Is it okay for the array to be null (as a whole)?</P>

      @return  <B>b_nullOk</B>  Exactly as provided to the <A HREF="~JD~pardnl(b,b,rcl)~EJD~">constructor</A>.
    **/
   public final boolean isNullOk()  {
      return bNullOk;
   }

   /**
      <P>Get the RCLength defining the legal range of lengths for the array.</P>

      @return  <B>rc_length</B>  Exactly as provided to the <A HREF="~JD~pardnl(b,b,rcl)~EJD~">constructor</A>.
    **/
   public final RCLength getRCLength()  {
      return rcl;
   }

   /**
      <P>Does this PARDupNullLen have <I>any</I> restrictions?</P>

      @return  <CODE>(!<A HREF="#areDupsOk()">areDupsOk</A>()&nbsp; ||&nbsp; !<A HREF="#isNullOk()">isNullOk</A>()&nbsp; ||&nbsp; <A HREF="#getRCLength()">getRCLength</A>().<A HREF="~JD~rcl~EJD~#isRestricted()">isRestricted</A>())</CODE>
    **/
   public boolean isRestricted()  {
      return (!areDupsOk()  ||  !isNullOk()  ||  getRCLength().isRestricted());
   }

   /**
      <P>Is this PARDupNullLen as restricted as possible?</P>

      @return  <CODE>(!<A HREF="#areDupsOk()">areDupsOk</A>()&nbsp; ||&nbsp; !<A HREF="#isNullOk()">isNullOk</A>()&nbsp; ||&nbsp; (<A HREF="#getRCLength()">getRCLength</A>().<A HREF="~JD~rc~EJD~#getMin()">getMin</A>() &gt; 0))</CODE>
    **/
   public boolean isStrict()  {
      return (!areDupsOk()  &&  !isNullOk()  &&  (getRCLength().getMin() > 0));
   }

   /**
      <P>Get some information about this PARDupNullLen.</P>
    **/
   public String toString()  {
      return this.getClass().getName() + ":  areDupsOk()=" + areDupsOk() + ", isNullOk()=" + isNullOk() + ", getRCLength()=[" + getRCLength() + "]";
   }
}