xbn.config
Class CRConfig

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

Direct Known Subclasses:

CRCFileActual

public class CRConfig

extends XBNObject

Configuration for ConfigReader. See ConfigReader.

Source code: CRConfig.java

There are two parts to a CRConfig: CRCDelimiters and CRCVariable.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

CRConfig(CRCDelimiters crc_delimiters)
Create a CRConfig.

CRConfig(CRCDelimiters crc_delimiters, CRCVariable crc_variable)
Create a CRConfig.

Method Summary

APChar	getAll2BEscNotVD() Get an APChar containing every character that needs to be escaped, except variable delimiters.
CRCDelimiters	getCRCDelimiters() Get the CRCDelimiters, which defines variable and comment delimiters.
CRCVariable	getCRCVariable() Get the CRCVariable, which defines variable-related things.
String	toString() Get information about this CRConfig.

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

CRConfig

public CRConfig(CRCDelimiters crc_delimiters)

Create a CRConfig.

Equal to CRConfig(crc_delimiters, (new CRCVariable()))

CRConfig

public CRConfig(CRCDelimiters crc_delimiters,
                CRCVariable crc_variable)

Create a CRConfig.

Rules for all characters contained within these parameters: They...

• ...must be unique.
• ...may not be invisible.
• ...may not exist in crc_variable.getNullValue().
• ...must not be specifically ignored, meaning crcv_unescape.getUSCIgnore().isSpcfcIgnored(THE_CHAR) must equal false.

Some of these restrictions are enforced in the CRCDelimiter constructor and CRCVariable constructor. This is a summary of all those restrictions.

Parameters:

crc_delimiters - Defines variable and comment delimiters. May not be null. See getCRCDelimiters.

crc_variable - The configuration for variables. May not be null. See getCRCVariable.

Method Detail

getCRCDelimiters

public final CRCDelimiters getCRCDelimiters()

Get the CRCDelimiters, which defines variable and comment delimiters.

Returns:

crc_delimiters Exactly as provided to the constructor.

getCRCVariable

public final CRCVariable getCRCVariable()

Get the CRCVariable, which defines variable-related things.

Returns:

crc_variable Exactly as provided to the constructor.

getAll2BEscNotVD

public final APChar getAll2BEscNotVD()

Get an APChar containing every character that needs to be escaped, except variable delimiters.

In order to display any of these characters literally (in the name or value) it must be escaped.

Specifically, this contains:

• All comment delimiters: getCRCDelimiters().getMLCStart(), getMLCEnd() and getSingleLineCmt().
• The escape character: getCRCVariable().getCRCVUnescape().getEscapeChar()
• If used, the special empty-string character: getCRCVariable().getCRCVTrim().getESChar()

Returns:

An APChar Containing c_mlcStart, c_mlcEnd and c_singleLineCmt, exactly as provided to the CRCDelimiters constructor. The APChar is created only once.

toString

public String toString()

Get information about this CRConfig.

Overrides:

toString in class Object