xbn.template
Class UtilGap

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

public class UtilGap

extends XBNObject

Random functions to create, manipulate and analyze template gaps.

Source code: UtilGap.java

The functions in both this and TConfigDefaults were originally in xbn.template.util.UtilTemplate. To avoid circular dependencies, it's all been split into these three pieces.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

UtilGap()
Create a UtilGap.

Method Summary

String	getTag(char c_tagDelimiter, String s_tagText) Get the tag that starts or ends a gap.
String	getTag(String s_tagText) Get the tag that starts or ends a gap.

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, toString, wait, wait, wait

Constructor Detail

UtilGap

public UtilGap()

Create a UtilGap. This constructor does nothing.

Method Detail

getTag

public final String getTag(String s_tagText)

Get the tag that starts or ends a gap.

Returns:

getTag(TConfigDefaults.getTagDelimiter(), s_tagText)

getTag

public final String getTag(char c_tagDelimiter,
                           String s_tagText)

Get the tag that starts or ends a gap.

Parameters:

c_tagDelimiter - The tag delimiter. This character must not be the escape slash ('\'), nor may it exist anywhere in s_tagText.

s_tagText - The text contained inside the start or end tag of a gap. Must be non-null, at least one and no more than TConfigDefaults.getMaxTagTxtLength characters in length, and only contaiTConfigDefaults.htmln letters, digits and underscores, except c_tagDelimiter.

Returns:

c_tagDelimiter (as a string) + s_tagText + c_tagDelimiter