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

/**
   <P>A RangeConfig where the minimum value is always enforced, and may never be lower than zero.  This class is helpful when validating something that has length.  To manage a number conforming to an RCLength, see <A HREF="RLength.html">RLength</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/util/RCLength.java">RCLength.java</A>. &nbsp;<B>Unit tests:</B> &nbsp;xbn_junit.<A HREF="../../../CODE/xbn_junit/util/JUTRCLength.java">JUTRCLength.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 RCLength extends RangeConfig  {

   /**
      <P>Create a, completely unrestricted, RCLength object.</P>

      <P>Equal to <CODE><A HREF="~JD~rcl(i,i,b)~EJD~">RCLength</A>(0, -1, false)</CODE></P>
    **/
   public RCLength()  {
      this(0, -1, false);
   }

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

      <P>Equal to <CODE><A HREF="~JD~rcl(i,b)~EJD~">RCLength</A>(i_min, i_max)</CODE></P>
    **/
   public RCLength(int i_max)  {
      this(i_max, true);
   }

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

      <P>Equal to <CODE><A HREF="#RCLength(int, int, boolean)">RCLength</A>(i_min, i_max, true)</CODE></P>
    **/
   public RCLength(int i_min, int i_max)  {
      this(i_min, i_max, true);
   }

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

      <P>Equal to <CODE><A HREF="~JD~rcl(i,i,b)~EJD~">RCLength</A>(0, i_max, b_nfrcMax)</CODE></P>
    **/
   public RCLength(int i_max, boolean b_nfrcMax)  {
      this(0, i_max, b_nfrcMax);
   }


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

      <P>Equal to <CODE><A HREF="~JD~rc#rc(i,b,i,b)~EJD~">RangeConfig</A>(i_min, true, i_max, b_nfrcMax)</CODE>.  After this super call is successful, it is then verified that i_min is less than zero.</P>
    **/
   public RCLength(int i_min, int i_max, boolean b_nfrcMax)  {
      super(i_min, true, i_max, b_nfrcMax);

      if(i_min < 0)  {
         throwAX("constructor:  i_min must be greater than -1.");
      }
   }

   /**
      <P>Create a copy of the provided RCLength.</P>

      <P>Equal to <CODE><A HREF="~JD~rc#rc(rc)~EJD~">RangeConfig</A>(rc_length)</CODE></P>
    **/
   public RCLength(RCLength rc_length)  {
      super(rc_length);
   }


   /**
      <P>Are there any restrictions imposed by this RCLength?</P>

      @return  <CODE>(<A HREF="~JD~rc~EJD~#getMin()">getMin</A>() &gt; 0  ||  <A HREF="~JD~rc~EJD~#isMaxEnforced()">isMaxEnforced</A>())</CODE>
    **/
   public boolean isRestricted()  {
      return (getMin() > 0  ||  isMaxEnforced());
   }


   /**
      <P>Get some information about this RCLength.</P>

      <P>Equal to <CODE><A HREF="#toString(boolean)">toString</A>(true)</CODE></P>
    **/
   public String toString()  {
      return toString(true);
   }


   /**
      <P>Get some information about this RCLength.</P>

      @param  b_className  If true, display the class name at the beginning of the returned string.  If false, don't.
    **/
   public String toString(boolean b_className)  {
      if(!isRestricted())  {
         return this.getClass().getName() + ":  UNRESTRICTED";
      }

      String sMaxEnforced = "not enforced";
      if(isMaxEnforced())  {
         sMaxEnforced = "enforced";
      }

      String sCN = sES;
      if(b_className)  {
         sCN = this.getClass().getName() + ":  ";
      }


      return sCN + "getMin()=" + getMin() + " (enforced), getMax()=" + getMax() + " (" + sMaxEnforced + ")";
   }
}