xbn.config
Class ConfigReader

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.config.ConfigReader

Direct Known Subclasses:

ConfigReaderFA

public class ConfigReader

extends XBNObject

Analyzes source text that contains zero or more variables.

Source code: ConfigReader.java. Example code: See the example code for ConfigReaderFA

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

ConfigReader()
Create a ConfigReader.

Method Summary

sb_sb_c[]	getAOsb_sb_c(ForLineRetrieval for_lineRetrieval, CRConfig cr_config) Get the VWObject containing all configuration variables read in from the source text.
sb_sb_c[]	getAOsb_sb_c(ForLineRetrieval for_lineRetrieval, CRConfig cr_config, Outputter optr_dbg) Get the VWObject containing all configuration variables read in from the source text.
sb_sb_c[]	getAOsb_sb_c(ForLineRetrieval for_lineRetrieval, CRConfig cr_config, Outputter optr_dbg, VWObject vwoSbsbc_cfgVars, CRFilter cr_filter) Get the sb_sb_c array, containing all configuration variables read in from the source text.
sb_sb_c[]	getAOsb_sb_c(ForLineRetrieval for_lineRetrieval, CRConfig cr_config, VWObject vwoSbsbc_cfgVars, CRFilter cr_filter) Get the VWObject containing all configuration variables read in from the source text.
VWObject	getVWObject(ForLineRetrieval for_lineRetrieval, CRConfig cr_config) Get the VWObject containing all configuration variables read in from the source text.
VWObject	getVWObject(ForLineRetrieval for_lineRetrieval, CRConfig cr_config, Outputter optr_dbg) Get the VWObject containing all configuration variables read in from the source text.
VWObject	getVWObject(ForLineRetrieval for_lineRetrieval, CRConfig cr_config, Outputter optr_dbg, VWObject vwoSbsbc_cfgVars, CRFilter cr_filter) Get the VWObject containing all configuration variables read in from the source text.
VWObject	getVWObject(ForLineRetrieval for_lineRetrieval, CRConfig cr_config, VWObject vwoSbsbc_cfgVars, CRFilter cr_filter) Get the VWObject containing all configuration variables read in from the source text.

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

ConfigReader

public ConfigReader()

Create a ConfigReader. This constructor does nothing.

Method Detail

getAOsb_sb_c

public sb_sb_c[] getAOsb_sb_c(ForLineRetrieval for_lineRetrieval,
                              CRConfig cr_config)
                       throws ConfigFormatException

Get the VWObject containing all configuration variables read in from the source text.

Returns:

[UtilConfig].getAOsb_sb_c((for_lineRetrieval, cr_config))

getAOsb_sb_c

public sb_sb_c[] getAOsb_sb_c(ForLineRetrieval for_lineRetrieval,
                              CRConfig cr_config,
                              Outputter optr_dbg)
                       throws ConfigFormatException

Get the VWObject containing all configuration variables read in from the source text.

Returns:

[UtilConfig].getAOsb_sb_c((for_lineRetrieval, cr_config, optr_dbg))

getAOsb_sb_c

public sb_sb_c[] getAOsb_sb_c(ForLineRetrieval for_lineRetrieval,
                              CRConfig cr_config,
                              VWObject vwoSbsbc_cfgVars,
                              CRFilter cr_filter)
                       throws ConfigFormatException

Get the VWObject containing all configuration variables read in from the source text.

Returns:

[UtilConfig].getAOsb_sb_c((for_lineRetrieval, cr_config, optr_dbg, cr_filter))

getAOsb_sb_c

public sb_sb_c[] getAOsb_sb_c(ForLineRetrieval for_lineRetrieval,
                              CRConfig cr_config,
                              Outputter optr_dbg,
                              VWObject vwoSbsbc_cfgVars,
                              CRFilter cr_filter)
                       throws ConfigFormatException

Get the sb_sb_c array, containing all configuration variables read in from the source text.

Returns:

[UtilConfig].getAOsb_sb_c((for_lineRetrieval, cr_config, optr_dbg, vwoSbsbc_cfgVars, cr_filter))

getVWObject

public VWObject getVWObject(ForLineRetrieval for_lineRetrieval,
                            CRConfig cr_config)
                     throws ConfigFormatException

Get the VWObject containing all configuration variables read in from the source text.

Returns:

getVWObject(for_lineRetrieval, cr_config, (new Outputter()))

getVWObject

public VWObject getVWObject(ForLineRetrieval for_lineRetrieval,
                            CRConfig cr_config,
                            Outputter optr_dbg)
                     throws ConfigFormatException

Get the VWObject containing all configuration variables read in from the source text.

Returns:

getVWObject(for_lineRetrieval, cr_config, optr_dbg, (new VWObject()), null)

getVWObject

public VWObject getVWObject(ForLineRetrieval for_lineRetrieval,
                            CRConfig cr_config,
                            VWObject vwoSbsbc_cfgVars,
                            CRFilter cr_filter)
                     throws ConfigFormatException

Get the VWObject containing all configuration variables read in from the source text.

Returns:

getVWObject(for_lineRetrieval, cr_config, (new Outputter()), vwoSbsbc_cfgVars, cr_filter)

getVWObject

public VWObject getVWObject(ForLineRetrieval for_lineRetrieval,
                            CRConfig cr_config,
                            Outputter optr_dbg,
                            VWObject vwoSbsbc_cfgVars,
                            CRFilter cr_filter)
                     throws ConfigFormatException

Get the VWObject containing all configuration variables read in from the source text.

Known issue, Regarding errors stating 'unescaped [whatever]': [whatever] may be incorrect. Just check all delimiters (in CRCVTrim and CRCDelimiters) are escaped (or not) as applicable.

Parameters:

for_lineRetrieval - The source text. May not be null.

cr_config - Configuration defining a ConfigReader. May not be null.

optr_dbg - Used for debugging output. May not be null.

vwoSbsbc_cfgVars - The VWObject to add read-in variables to (each being held in an sb_sb_c). May not be null. Use this when you have previous variables to append to, or when you need the VWObject to be ordered (by variable names).

cr_filter - If non-null, this determines which variables should be accepted, and which should be ignored. If null, all variables are accepted.

Returns:

An VWObject, where zero or more sb_sb_cs (each representing a read-in configuration variable) have been added to it. Within each sb_sb_c:

• sb1 is the variable's name.
• sb2 is the value.
• c is the variable delimiter.