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

/**
   <P>Defines the rules to be enforced by PrimitiveArrayString.isValid.  See <A HREF="~JD~pas~EJD~">PrimitiveArrayString</A>.<A HREF="~JD~pas#isValid(s,s)~EJD~">isValid</A>.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../../CODE/xbn/array/primitive/PARString.java">PARString.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 PARString extends PrimitiveArrayRule  {
   private PARSContain parsc = null;
   private PARSElement parse = null;

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl)~EJD~">PARString</A>(new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>())</CODE></P>

      <P><I>Note:  Using this constructor causes <A HREF="#isRestricted()">isRestricted</A> to equal true.</I></P>
    **/
   public PARString()  {
      this(new PARDupNullLen());
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parod)~EJD~">PARString</A>(par_dupNullLen, (new <A HREF="~JD~parod#parod()~EJD~">PAROrderDir</A>()))</CODE></P>
    **/
   public PARString(PARDupNullLen par_dupNullLen)  {
      this(par_dupNullLen, (new PAROrderDir()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parod)~EJD~">PARString</A>((new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>()), par_orderDir)</CODE></P>
    **/
   public PARString(PAROrderDir par_orderDir)  {
      this((new PARDupNullLen()), par_orderDir);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parsc)~EJD~">PARString</A>((new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>()), pars_contain)</CODE></P>
    **/
   public PARString(PARSContain pars_contain)  {
      this((new PARDupNullLen()), pars_contain);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parse)~EJD~">PARString</A>((new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>()), pars_element)</CODE></P>
    **/
   public PARString(PARSElement pars_element)  {
      this((new PARDupNullLen()), pars_element);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parod,parse)~EJD~">PARString</A>(par_dupNullLen, par_orderDir, (new <A HREF="~JD~parse#parse()~EJD~">PARSElement</A>()))</CODE></P>
    **/
   public PARString(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir)  {
      this(par_dupNullLen, par_orderDir, (new PARSElement()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parsc,parse)~EJD~">PARString</A>(par_dupNullLen, pars_contain, (new <A HREF="~JD~parse#parse()~EJD~">PARSElement</A>()))</CODE></P>
    **/
   public PARString(PARDupNullLen par_dupNullLen, PARSContain pars_contain)  {
      this(par_dupNullLen, pars_contain, (new PARSElement()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parod,parse)~EJD~">PARString</A>(par_dupNullLen, (new <A HREF="~JD~parod#parod()~EJD~">PAROrderDir</A>()), pars_element)</CODE></P>
    **/
   public PARString(PARDupNullLen par_dupNullLen, PARSElement pars_element)  {
      this(par_dupNullLen, (new PAROrderDir()), pars_element);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parod,parse)~EJD~">PARString</A>((new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>()), par_orderDir, pars_element)</CODE></P>
    **/
   public PARString(PAROrderDir par_orderDir, PARSElement pars_element)  {
      this((new PARDupNullLen()), par_orderDir, pars_element);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parsc,parse)~EJD~">PARString</A>((new <A HREF="~JD~pardnl#pardnl()~EJD~">PARDupNullLen</A>()), pars_contain, pars_element)</CODE></P>
    **/
   public PARString(PARSContain pars_contain, PARSElement pars_element)  {
      this((new PARDupNullLen()), pars_contain, pars_element);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parod,parsc,parse)~EJD~">PARString</A>(par_dupNullLen, par_orderDir, pars_contain, (new <A HREF="~JD~parse#parse()~EJD~">PARSElement</A>()))</CODE></P>
    **/
   public PARString(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir, PARSContain pars_contain)  {
      this(par_dupNullLen, par_orderDir, pars_contain, (new PARSElement()));
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parod,parsc,parse)~EJD~">PARString</A>(par_dupNullLen, par_orderDir, (new <A HREF="~JD~parsc#parsc()~EJD~">PARSContain</A>()), pars_element)</CODE></P>
    **/
   public PARString(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir, PARSElement pars_element)  {
      this(par_dupNullLen, par_orderDir, (new PARSContain()), pars_element);
   }

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

      <P>Equal to <CODE><A HREF="~JD~pars(pardnl,parod,parsc,parse)~EJD~">PARString</A>(par_dupNullLen, (new <A HREF="~JD~parod#parod()~EJD~">PAROrderDir</A>()), pars_contain, pars_element)</CODE></P>
    **/
   public PARString(PARDupNullLen par_dupNullLen, PARSContain pars_contain, PARSElement pars_element)  {
      this(par_dupNullLen, (new PAROrderDir()), pars_contain, pars_element);
   }

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

      <P>The first line of this constructor calls <CODE><A HREF="~JD~par#par(pardnl,parod)~EJD~">PrimitiveArrayRule</A>(par_dupNullLen, par_orderDir)</CODE>.</P>

      @param pars_element  Defines element-specific rules.  May not be null.
    **/
   public PARString(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir, PARSContain pars_contain, PARSElement pars_element)  {
      super(par_dupNullLen, par_orderDir);
      throwAXIfNull(pars_contain, "pars_contain", sCNSTR);
      throwAXIfNull(pars_element, "pars_element", sCNSTR);
      parsc = pars_contain;
      parse = pars_element;
   }

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

      <P>The first line of this constructor calls <CODE><A HREF="~JD~par#par(par)~EJD~">PrimitiveArrayRule</A>(par_string)</CODE></P>
    **/
   public PARString(PARString par_string)  {
      super(par_string);
      parse = par_string.parse.getPARSEClone();
   }

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

      @return <B>pars_contain</B>  Exactly as provided to the <A HREF="~JD~pars(pardnl,parod,parsc,parse)~EJD~">constructor</A>.
    **/
   public final PARSContain getPARSContain()  {
      return parsc;
   }

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

      @return <B>pars_element</B>  Exactly as provided to the <A HREF="~JD~pars(pardnl,parod,parsc,parse)~EJD~">constructor</A>.
    **/
   public final PARSElement getPARSElement()  {
      return parse;
   }

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

      @return  <CODE>(<A HREF="~JD~par~EJD~">super</A>.<A HREF="~JD~par~EJD~#isRestricted()">isRestricted</A>()&nbsp; ||
<BR>&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp; &nbsp;&nbsp; &nbsp;<A HREF="#getPARSContain()">getPARSContain</A>().<A HREF="~JD~parsc~EJD~#isRestricted()">isRestricted</A>()&nbsp; ||
<BR>&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp; &nbsp; &nbsp;&nbsp; &nbsp;<A HREF="#getPARSElement()">getPARSElement</A>().<A HREF="~JD~parse~EJD~#isRestricted()">isRestricted</A>())</CODE>
    **/
   public boolean isRestricted()  {
      return (super.isRestricted()  ||
              getPARSContain().isRestricted()  ||
              getPARSElement().isRestricted());
   }

   /**
      <P>Get some information about this PARString.</P>
    **/
   public String toString()  {
      return super.toString() + ", [" + getPARSContain().toString() + "], [" + getPARSElement().toString() + "]";
   }
}