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

/**
   <P>Configuration for a Template.</P>

   <P><CODE><I><B>Source code:</B> &nbsp;<A HREF="../../../CODE/xbn/template/GapConfig.java">GapConfig.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 GapConfig extends XBNObject  {
   private char cTagDelimiter = ' ';
   private String sTagTextStart = null;
   private String sTagTextEnd = null;
   private char cEscape = ' ';

   /**
      <P>Create an GapConfig with default settings.</P>

      <P>Equal to <CODE><A HREF="~JD~gc(c)~EJD~">GapConfig</A>(<A HREF="~JD~tcd~EJD~">TConfigDefaults</A>.<A HREF="~JD~tcd~EJD~#getTagDelimiter()">getTagDelimiter</A>())</CODE></P>
    **/
   public GapConfig()  {
      this(TConfigDefaults.getTagDelimiter());
   }

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

      <P>Equal to <CODE><A HREF="~JD~gc(c,c)~EJD~">GapConfig</A>(c_tagDelimiter, '\\')</CODE></P>
    **/
   public GapConfig(char c_tagDelimiter)  {
      this(c_tagDelimiter, '\\');
   }

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

      <P>Equal to <CODE><A HREF="~JD~gc(c,s,s)~EJD~">GapConfig</A>(<A HREF="~JD~tcd~EJD~">TConfigDefaults</A>.<A HREF="~JD~tcd~EJD~#getTagDelimiter()">getTagDelimiter</A>(), s_tagTextStart, s_tagTextEnd)</CODE></P>
    **/
   public GapConfig(String s_tagTextStart, String s_tagTextEnd)  {
      this(TConfigDefaults.getTagDelimiter(), s_tagTextStart, s_tagTextEnd);
   }

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

      <P>Equal to <CODE><A HREF="~JD~gc(c,s,s,c)~EJD~">GapConfig</A>(c_tagDelimiter, <A HREF="~JD~tcd~EJD~">TConfigDefaults</A>.<A HREF="~JD~tcd~EJD~#getTagTxtStart()">getTagTxtStart</A>(), <A HREF="~JD~tcd~EJD~">TConfigDefaults</A>.<A HREF="~JD~tcd~EJD~#getTagTxtEnd()">getTagTxtEnd</A>(), c_escape)</CODE></P>
    **/
   public GapConfig(char c_tagDelimiter, char c_escape)  {
      this(c_tagDelimiter, TConfigDefaults.getTagTxtStart(), TConfigDefaults.getTagTxtEnd(), c_escape);
   }

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

      <P>Equal to <CODE><A HREF="~JD~gc(c,s,s,c)~EJD~">GapConfig</A>(<A HREF="~JD~tcd~EJD~">TConfigDefaults</A>.<A HREF="~JD~tcd~EJD~#getTagDelimiter()">getTagDelimiter</A>(), s_tagTextStart, s_tagTextEnd, , c_escape)</CODE></P>
    **/
   public GapConfig(String s_tagTextStart, String s_tagTextEnd, char c_escape)  {
      this(TConfigDefaults.getTagDelimiter(), s_tagTextStart, s_tagTextEnd, c_escape);
   }

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

      <P>Equal to <CODE><A HREF="~JD~gc(c,s,s,c)~EJD~">GapConfig</A>(c_tagDelimiter, s_tagTextStart, s_tagTextEnd, '\\')</CODE></P>
    **/
   public GapConfig(char c_tagDelimiter, String s_tagTextStart, String s_tagTextEnd)  {
      this(c_tagDelimiter, s_tagTextStart, s_tagTextEnd, '\\');
   }


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

      @param  c_tagDelimiter  The tag delimiter character.  A single copy of this character precedes and follows both the tag start and end texts, to form a full gap tag part.  May not equal c_escape.
      @param  s_tagTextStart  The text for the gap start tag.  The entire start tag is considered to be a <A HREF="#getTagDelimiter()">tag delimiter character</A>, the value of this parameter, and then another tag delimiter character.  Must be valid according to <A HREF="~JD~utilt~EJD~">UtilTemplate</A><A HREF="~JD~utilg#getTag(s)~EJD~">getTag</A>, and different than s_tagTextEnd.  VALIDATED IN TLAObjects constructor.
      @param  s_tagTextEnd  The text for the gap end tag.  Has the same rules as s_tagTextStart, and this parameter must have a different value than it.  VALIDATED IN TLAObjects constructor.
      @param  c_escape  The escape character, to display a c_tagDelimiter literally.  May not equal c_tagDelimiter.
    **/
   public GapConfig(char c_tagDelimiter, String s_tagTextStart, String s_tagTextEnd, char c_escape)  {
      if(c_tagDelimiter == c_escape)  {
         throwAX("constructor:  c_tagDelimiter equals c_escape.  Currently '" + c_tagDelimiter + "'.");
      }

      cTagDelimiter = c_tagDelimiter;
      sTagTextStart = s_tagTextStart;
      sTagTextEnd = s_tagTextEnd;
      cEscape = c_escape;
   }


   /**
      <P>Get the character delimiter that starts and ends all tag parts.</P>

      <P>To display a tag delimiter literally, precede it by the <A HREF="#getEscapeChar()">escape character</A>.</P>

      @return <B>c_tagDelimiter</B>  Exactly as provided to the <A HREF="~JD~gc(c,s,s,c)~EJD~">constructor</A>.
    **/
   public final char getTagDelimiter()  {
      return cTagDelimiter;
   }

   /**
      <P>Get the text for the gap start tag.</P>

      @return  <B>s_tagTextStart</B>, exactly as provided to the <A HREF="~JD~gc(c,s,s,c)~EJD~">constructor</A>.
    **/
   public final String getTagTextStart()  {
      return sTagTextStart;
   }

   /**
      <P>Get the text for the gap end tag.</P>

      @return  <B>s_tagTextEnd</B>, as provided to the <A HREF="~JD~gc(c,s,s,c)~EJD~">constructor</A>.
    **/
   public final String getTagTextEnd()  {
      return sTagTextEnd;
   }

   /**
      <P>Get the escape character.</P>

      <P>To display a <A HREF="#getTagDelimiter()">tag delimiter</A> literally, precede it by the escape character.</P>

      @return <B>c_escape</B>  Exactly as provided to the <A HREF="~JD~gc(c,s,s,c)~EJD~">constructor</A>.
    **/
   public final char getEscapeChar()  {
      return cEscape;
   }

   /**
      <P>Get some information about this GapConfig.</P>
    **/
   public String toString()  {
      return this.getClass().getName() + ":  getTagDelimiter()='" + getTagDelimiter() + "', getTagTextStart()='" + getTagTextStart() + "', getTagTextEnd()='" + getTagTextEnd() + "', getEscapeChar()='" + getEscapeChar() + "'";
   }
}