/*
   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.template;
   import xbn.util.ForLineRetrieval;



/**
   <P>A TemplateOrderedGaps where there are always three gaps.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/template/TOGThree.java">TOGThree.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 TOGThree extends TemplateOrderedGaps  {

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

      <P>Equal to <CODE><A HREF="~JD~tog3(flr,ogc3)~EJD~">TOGThree</A>(flr_srcTxt, (new <A HREF="~JD~ogc3#ogc3(s,s,s)~EJD~">OGCThree</A>(s_gap1, s_gap2, s_gap3)))</CODE></P>
    **/
   public TOGThree(ForLineRetrieval flr_srcTxt, String s_gap1, String s_gap2, String s_gap3) throws TemplateFormatException  {
      this(flr_srcTxt, (new OGCThree(s_gap1, s_gap2, s_gap3)));
   }

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

      <P>Equal to <CODE><A HREF="~JD~tog3(flr,ogc3,tpc)~EJD~">TOGThree</A>(flr_srcTxt, (new <A HREF="~JD~ogc3#ogc3(s,s,s)~EJD~">OGCThree</A>(s_gap1, s_gap2, s_gap3)), tp_config)</CODE></P>
    **/
   public TOGThree(ForLineRetrieval flr_srcTxt, TParseConfig tp_config, String s_gap1, String s_gap2, String s_gap3) throws TemplateFormatException  {
      this(flr_srcTxt, (new OGCThree(s_gap1, s_gap2, s_gap3)), tp_config);
   }

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

      <P>Equal to <CODE><A HREF="~JD~tog3(s,flr,ogc3)~EJD~">TOGThree</A>(s_name, flr_srcTxt, (new <A HREF="~JD~ogc3#ogc3(s,s,s)~EJD~">OGCThree</A>(s_gap1, s_gap2, s_gap3)))</CODE></P>
    **/
   public TOGThree(String s_name, ForLineRetrieval flr_srcTxt, String s_gap1, String s_gap2, String s_gap3) throws TemplateFormatException  {
      this(s_name, flr_srcTxt, (new OGCThree(s_gap1, s_gap2, s_gap3)));
   }

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

      <P>Equal to <A HREF="~JD~tog3(s,flr,ogc3,tpc)~EJD~">TOGThree</A>(s_name, flr_srcTxt, (new <A HREF="~JD~ogc3#ogc3(s,s,s)~EJD~">OGCThree</A>(s_gap1, s_gap2, s_gap3)), tp_config)</P>
    **/
   public TOGThree(String s_name, ForLineRetrieval flr_srcTxt, TParseConfig tp_config, String s_gap1, String s_gap2, String s_gap3) throws TemplateFormatException  {
      this(s_name, flr_srcTxt, (new OGCThree(s_gap1, s_gap2, s_gap3)), tp_config);
   }




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

      <P>Equal to <CODE><A HREF="~JD~tog3(s,flr,ogc3)~EJD~">TOGThree</A>(null, flr_srcTxt, ogc_three)</CODE></P>
    **/
   public TOGThree(ForLineRetrieval flr_srcTxt, OGCThree ogc_three) throws TemplateFormatException  {
      this(null, flr_srcTxt, ogc_three);
   }

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

      <P>Equal to <CODE><A HREF="~JD~tog3(s,flr,ogc3,tpc)~EJD~">TOGThree</A>(null, flr_srcTxt, ogc_three, tp_config)</CODE></P>
    **/
   public TOGThree(ForLineRetrieval flr_srcTxt, OGCThree ogc_three, TParseConfig tp_config) throws TemplateFormatException  {
      this(null, flr_srcTxt, ogc_three, tp_config);
   }

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

      <P>Equal to <CODE><A HREF="~JD~tog3(s,flr,ogc3,tpc)~EJD~">TOGThree</A>(s_name, flr_srcTxt, ogc_three, (new <A HREF="~JD~tpc#tpc()~EJD~">TParseConfig</A>()))</CODE></P>
    **/
   public TOGThree(String s_name, ForLineRetrieval flr_srcTxt, OGCThree ogc_three) throws TemplateFormatException  {
      this(s_name, flr_srcTxt, ogc_three, (new TParseConfig()));
   }

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

      <P>Equal to <A HREF="~JD~tog#tog(s,flr,ogc,tpc)~EJD~">TemplateOrderedGaps</A>(s_name, flr_srcTxt, ogc_three, tp_config)</P>

      <P>The only difference between this constructor and the super version, is that ogc_three (the TFilter) may not be null</P>
    **/
   public TOGThree(String s_name, ForLineRetrieval flr_srcTxt, OGCThree ogc_three, TParseConfig tp_config) throws TemplateFormatException  {
      super(s_name, flr_srcTxt, ogc_three, tp_config);
      throwAXIfNull(ogc_three, "ogc_three", sCNSTR);
   }

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

      <P>Equal to <CODE><A HREF="~JD~tog#tog(tog)~EJD~">TemplateOrderedGaps</A>(tog_one)</CODE></P>
    **/
   public TOGThree(TOGThree tog_one)  {
      super(tog_one);
   }

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

      @return  <CODE>(<A HREF="~JD~ogc3~EJD~">OGCThree</A>)<A HREF="~JD~tog~EJD~#getOGConfig()">getOGConfig</A>()</CODE>
    **/
   public final OGCThree getOGCThree()  {
      return (OGCThree)getOGConfig();
   }
}