xbn.template
Class GapConfig

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.template.GapConfig

public class GapConfig

extends XBNObject

Configuration for a Template.

Source code: GapConfig.java.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

GapConfig()
Create an GapConfig with default settings.

GapConfig(char c_tagDelimiter)
Create an GapConfig.

GapConfig(char c_tagDelimiter, char c_escape)
Create an GapConfig.

GapConfig(char c_tagDelimiter, String s_tagTextStart, String s_tagTextEnd)
Create an GapConfig.

GapConfig(char c_tagDelimiter, String s_tagTextStart, String s_tagTextEnd, char c_escape)
Create an GapConfig.

GapConfig(String s_tagTextStart, String s_tagTextEnd)
Create an GapConfig.

GapConfig(String s_tagTextStart, String s_tagTextEnd, char c_escape)
Create an GapConfig.

Method Summary

char	getEscapeChar() Get the escape character.
char	getTagDelimiter() Get the character delimiter that starts and ends all tag parts.
String	getTagTextEnd() Get the text for the gap end tag.
String	getTagTextStart() Get the text for the gap start tag.
String	toString() Get some information about this GapConfig.

Methods inherited from class xbn.XBNObject

getXMsgPrefix, sop, sopl, sopl, throwAX, throwAXIfBadStr, throwAXIfNull, throwAXSpoof

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GapConfig

public GapConfig()

Create an GapConfig with default settings.

Equal to GapConfig(TConfigDefaults.getTagDelimiter())

GapConfig

public GapConfig(char c_tagDelimiter)

Create an GapConfig.

Equal to GapConfig(c_tagDelimiter, '\')

GapConfig

public GapConfig(String s_tagTextStart,
                 String s_tagTextEnd)

Create an GapConfig.

Equal to GapConfig(TConfigDefaults.getTagDelimiter(), s_tagTextStart, s_tagTextEnd)

GapConfig

public GapConfig(char c_tagDelimiter,
                 char c_escape)

Create an GapConfig.

Equal to GapConfig(c_tagDelimiter, TConfigDefaults.getTagTxtStart(), TConfigDefaults.getTagTxtEnd(), c_escape)

GapConfig

public GapConfig(String s_tagTextStart,
                 String s_tagTextEnd,
                 char c_escape)

Create an GapConfig.

Equal to GapConfig(TConfigDefaults.getTagDelimiter(), s_tagTextStart, s_tagTextEnd, , c_escape)

GapConfig

public GapConfig(char c_tagDelimiter,
                 String s_tagTextStart,
                 String s_tagTextEnd)

Create an GapConfig.

Equal to GapConfig(c_tagDelimiter, s_tagTextStart, s_tagTextEnd, '\')

GapConfig

public GapConfig(char c_tagDelimiter,
                 String s_tagTextStart,
                 String s_tagTextEnd,
                 char c_escape)

Create an GapConfig.

Parameters:

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.

s_tagTextStart - The text for the gap start tag. The entire start tag is considered to be a tag delimiter character, the value of this parameter, and then another tag delimiter character. Must be valid according to UtilTemplategetTag, and different than s_tagTextEnd. VALIDATED IN TLAObjects constructor.

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.

c_escape - The escape character, to display a c_tagDelimiter literally. May not equal c_tagDelimiter.

Method Detail

getTagDelimiter

public final char getTagDelimiter()

Get the character delimiter that starts and ends all tag parts.

To display a tag delimiter literally, precede it by the escape character.

Returns:

c_tagDelimiter Exactly as provided to the constructor.

getTagTextStart

public final String getTagTextStart()

Get the text for the gap start tag.

Returns:

s_tagTextStart, exactly as provided to the constructor.

getTagTextEnd

public final String getTagTextEnd()

Get the text for the gap end tag.

Returns:

s_tagTextEnd, as provided to the constructor.

getEscapeChar

public final char getEscapeChar()

Get the escape character.

To display a tag delimiter literally, precede it by the escape character.

Returns:

c_escape Exactly as provided to the constructor.

toString

public String toString()

Get some information about this GapConfig.

Overrides:

toString in class Object