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

/**
   <P>Defines rules regarding containment and equality between array elements.  Containment is defined as "element X fully exists in element Y, but is not equal to element Y".</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/array/primitive/PARSContain.java">PARSContain.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 PARSContain extends XBNObject  {
   private boolean bContainmentOk = true;
   private boolean bMustContainBeOrdered = true;
   private boolean bContainOrderAscDesc = true;

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

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

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

      <P>Equal to <CODE><A HREF="~JD~parsc(b,b,b)~EJD~">PARSContain</A>(b_containmentOk, false, false)</CODE></P>
    **/
   public PARSContain(boolean b_containmentOk)  {
      this(b_containmentOk, false, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~parsc(b,b,b)~EJD~">PARSContain</A>(false, b_rdrdContainment, b_orderDirAscDesc)</CODE></P>
    **/
   public PARSContain(boolean b_rdrdContainment, boolean b_orderDirAscDesc)  {
      this(false, b_rdrdContainment, b_orderDirAscDesc);
   }

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

      @param  b_containmentOk  If true, then values may contain one another.  If false, no value may be contained in another.  See <A HREF="#isContainmentOk()">isContainmentOk</A>.
      @param  b_rdrdContainment  Must containment be ordered?  If true, then yes (direction is defined by b_orderDirAscDesc).  If false, no.  When b_containmentOk is true, this must equal false.  See <a href="#mustBeOrdered()">mustBeOrdered</a>.
      @param  b_orderDirAscDesc  What direction should containment ordering be in?  If true, then ascending (0, 1, 2, ...), otherwise, descending.  When b_rdrdContainment is false, this is ignored.  See <a href="#getOrderDirAscDesc()">getOrderDirAscDesc</a>.
    **/
   protected PARSContain(boolean b_containmentOk, boolean b_rdrdContainment, boolean b_orderDirAscDesc)  {
      if(b_rdrdContainment  &&  b_containmentOk)  {
         throwAX("constructor:  b_rdrdContainment is true but b_containmentOk is true.");
      }
      bContainmentOk = b_containmentOk;
      bMustContainBeOrdered = b_rdrdContainment;

      if(!b_rdrdContainment)  {
         bContainOrderAscDesc = false;
      }  else  {
         bContainOrderAscDesc = b_orderDirAscDesc;
      }
   }


   /**
      <P>Is it okay for the array to have a value that contains another?.  Note that if two elements are equal, they are <I>not</I> "contained" in one another.</P>

      @return  <B>b_containmentOk</B>  Exactly as provided to the <A HREF="~JD~parsc(b,b,b)~EJD~">constructor</A>.
    **/
   public final boolean isContainmentOk()  {
      return bContainmentOk;
   }

   /**
      <P>Must containment be in a certain order?</P>

      <P>If this returns <B>true</B>, then containment is ordered (direction is defined by <a href="#getOrderDirAscDesc()">getOrderDirAscDesc</a>).  If <B>false</B>, containment is not ordered.</P>

      @return  <B>b_rdrdContainment</B>  Exactly as provided to the <A HREF="~JD~parsc(b,b,b)~EJD~">constructor</A>.  <I>Exception:  When <a href="#isContainmentOk()">isContainmentOk</a> equals true, this always returns false.</I>.
    **/
   public final boolean mustBeOrdered()  {
      return bMustContainBeOrdered;
   }

   /**
      <P>What direction should containment be in?</P>

      <P>If this function returns <B>true</B>, then ordering must be ascending (0, 1, 2, ...), meaning element 0 may be contained by element 3, but not vice-versa.  If this function returns <B>false</B>, then containment must be descending.</P>

      @return  <B>b_orderDirAscDesc</B>  Exactly as provided to the <A HREF="~JD~parsc(b,b,b)~EJD~">constructor</A>.  <I>Exception:  When <a href="#mustBeOrdered()">mustBeOrdered</a> equals false, this always returns false.</I>.
    **/
   public final boolean getOrderDirAscDesc()  {
      return bContainOrderAscDesc;
   }

   /**
      <P>Does this PARSContain have any restrictions?</P>

      @return  <CODE>!<a href="#isContainmentOk()">isContainmentOk</a>()</CODE>
    **/
   public final boolean isRestricted()  {
      return !isContainmentOk();
   }

   /**
      <P>Get some information about this PARSContain.</P>
    **/
   public final String toString()  {
      return this.getClass().getName() + ":  isContainmentOk()=" + isContainmentOk() + ", mustBeOrdered()=" + mustBeOrdered() + ", getOrderDirAscDesc()=" + getOrderDirAscDesc();
   }
}