xbn.template
Class TParseConfig

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

public class TParseConfig

extends XBNObject

Configuration for when parsing the source text for a single Template. See the constructor for TemplateDataOrString.

Source code: TParseConfig.java.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

TParseConfig()
Create a TParseConfig with default settings.

TParseConfig(boolean b_ignoreSurrTxt)
Create a TParseConfig.

TParseConfig(boolean b_ignoreSurrTxt, Outputter optr_dbg)
Create a TParseConfig.

TParseConfig(boolean b_ignoreSurrTxt, USCIgnore euscu_ignore)
Create a TParseConfig.

TParseConfig(boolean b_ignoreSurrTxt, USCIgnore euscu_ignore, Outputter optr_dbg)
Create a TParseConfig.

TParseConfig(GapConfig gap_config)
Create a TParseConfig.

TParseConfig(GapConfig gap_config, boolean b_ignoreSurrTxt)
Create a TParseConfig.

TParseConfig(GapConfig gap_config, boolean b_ignoreSurrTxt, Outputter optr_dbg)
Create a TParseConfig.

TParseConfig(GapConfig gap_config, boolean b_ignoreSurrTxt, USCIgnore euscu_ignore)
Create a TParseConfig.

TParseConfig(GapConfig gap_config, boolean b_ignoreSurrTxt, USCIgnore euscu_ignore, Outputter optr_dbg)
Create an TParseConfig.

TParseConfig(GapConfig gap_config, Outputter optr_dbg)
Create a TParseConfig.

TParseConfig(GapConfig gap_config, USCIgnore euscu_ignore)
Create a TParseConfig.

TParseConfig(GapConfig gap_config, USCIgnore euscu_ignore, Outputter optr_dbg)
Create a TParseConfig.

TParseConfig(Outputter optr_dbg)
Create a TParseConfig.

TParseConfig(USCIgnore euscu_ignore)
Create a TParseConfig.

TParseConfig(USCIgnore euscu_ignore, Outputter optr_dbg)
Create a TParseConfig.

Method Summary

boolean	doIgnoreSurrTxt() Should surrounding text be ignored?
GapConfig	getGapConfig() Get the GapConfig for direct manipulation.
Outputter	getOptrDebug() Get the Outputter used for debugging for direct manipulation.
USCIgnore	getUSCIgnore() Get the USCIgnore for direct manipulation.
String	toString() Get some information about this TParseConfig.

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

TParseConfig

public TParseConfig()

Create a TParseConfig with default settings.

Equal to TParseConfig(false)

TParseConfig

public TParseConfig(GapConfig gap_config)

Create a TParseConfig.

Equal to TParseConfig(gap_config, false)

TParseConfig

public TParseConfig(boolean b_ignoreSurrTxt)

Create a TParseConfig.

Equal to TParseConfig((new GapConfig()), b_ignoreSurrTxt)

TParseConfig

public TParseConfig(USCIgnore euscu_ignore)

Create a TParseConfig.

Equal to TParseConfig(false, euscu_ignore)

TParseConfig

public TParseConfig(Outputter optr_dbg)

Create a TParseConfig.

Equal to TParseConfig(false, optr_dbg)

TParseConfig

public TParseConfig(GapConfig gap_config,
                    boolean b_ignoreSurrTxt)

Create a TParseConfig.

Equal to TParseConfig(gap_config, b_ignoreSurrTxt, (new Outputter()))

TParseConfig

public TParseConfig(GapConfig gap_config,
                    USCIgnore euscu_ignore)

Create a TParseConfig.

Equal to TParseConfig(gap_config, false, euscu_ignore)

TParseConfig

public TParseConfig(GapConfig gap_config,
                    Outputter optr_dbg)

Create a TParseConfig.

Equal to TParseConfig(gap_config, false, optr_dbg)

TParseConfig

public TParseConfig(boolean b_ignoreSurrTxt,
                    USCIgnore euscu_ignore)

Create a TParseConfig.

Equal to TParseConfig((new GapConfig()), b_ignoreSurrTxt, euscu_ignore)

TParseConfig

public TParseConfig(boolean b_ignoreSurrTxt,
                    Outputter optr_dbg)

Create a TParseConfig.

Equal to TParseConfig((new GapConfig()), b_ignoreSurrTxt, optr_dbg)

TParseConfig

public TParseConfig(USCIgnore euscu_ignore,
                    Outputter optr_dbg)

Create a TParseConfig.

Equal to TParseConfig(false, euscu_ignore, optr_dbg)

TParseConfig

public TParseConfig(GapConfig gap_config,
                    boolean b_ignoreSurrTxt,
                    USCIgnore euscu_ignore)

Create a TParseConfig.

Equal to TParseConfig(gap_config, b_ignoreSurrTxt, euscu_ignore, (new Outputter()))

TParseConfig

public TParseConfig(GapConfig gap_config,
                    boolean b_ignoreSurrTxt,
                    Outputter optr_dbg)

Create a TParseConfig.

Equal to TParseConfig(gap_config, b_ignoreSurrTxt, (new USCIgnore()), optr_dbg)

TParseConfig

public TParseConfig(GapConfig gap_config,
                    USCIgnore euscu_ignore,
                    Outputter optr_dbg)

Create a TParseConfig.

Equal to TParseConfig(gap_config, false, euscu_ignore, optr_dbg)

TParseConfig

public TParseConfig(boolean b_ignoreSurrTxt,
                    USCIgnore euscu_ignore,
                    Outputter optr_dbg)

Create a TParseConfig.

Equal to TParseConfig((new GapConfig()), b_ignoreSurrTxt, euscu_ignore, optr_dbg)

TParseConfig

public TParseConfig(GapConfig gap_config,
                    boolean b_ignoreSurrTxt,
                    USCIgnore euscu_ignore,
                    Outputter optr_dbg)

Create an TParseConfig.

Parameters:

gap_config - The configuration defining a gap. May not be null.

b_ignoreSurroundingText - If true, then surrounding text is ignored, which saves memory when you don't need it anyway.

euscu_ignore - Configuration determiting how to deal with characters--other than c_escape and the tag delimiter--that are escaped. May not be null and both euscu_ignore.isSpcfcIgnored(gap_config.getTagDelimiter()) and euscu_ignore.isSpcfcIgnored(gap_config.getEscapeChar()) must equal false.

optr_dbg - The Outputter used for debugging purposes. May not be null.

Method Detail

getGapConfig

public final GapConfig getGapConfig()

Get the GapConfig for direct manipulation.

Returns:

gap_config Exactly as provided to the constructor.

doIgnoreSurrTxt

public final boolean doIgnoreSurrTxt()

Should surrounding text be ignored?

Returns:

b_ignoreSurrTxt, as provided to the constructor.

getUSCIgnore

public final USCIgnore getUSCIgnore()

Get the USCIgnore for direct manipulation.

Returns:

euscu_ignore Exactly as provided to the constructor.

getOptrDebug

public Outputter getOptrDebug()

Get the Outputter used for debugging for direct manipulation.

Returns:

optr_dbg, as provided to the constructor.

toString

public String toString()

Get some information about this TParseConfig.

Overrides:

toString in class Object