xbn.config
Class CRCVUnescape

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

public class CRCVUnescape

extends XBNObject

Configuration related to unescaping configuration variable names and values. Provided to ConfigReader via CRConfig.

Source code: CRCVUnescape.java

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

CRCVUnescape()
Create a CRCVUnescape with default values.

CRCVUnescape(char c_escape)
Create a CRCVUnescape.

CRCVUnescape(USCIgnore usc_ignore)
Create a CRCVUnescape.

CRCVUnescape(USCIgnore usc_ignore, char c_escape)
Create a CRCVUnescape.

Method Summary

char	getEscapeChar() What is the character used to escape other characters?
USCIgnore	getUSCIgnore() Get the USCIgnore for direct manipulation.
String	toString() Get some information about this CRCVUnescape.

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

CRCVUnescape

public CRCVUnescape()

Create a CRCVUnescape with default values.

Equal to CRCVUnescape('\\')

CRCVUnescape

public CRCVUnescape(USCIgnore usc_ignore)

Create a CRCVUnescape.

Equal to CRCVUnescape(usc_ignore, '\\')

CRCVUnescape

public CRCVUnescape(char c_escape)

Create a CRCVUnescape.

Equal to CRCVUnescape((new USCIgnore()), '\\')

CRCVUnescape

public CRCVUnescape(USCIgnore usc_ignore,
                    char c_escape)

Create a CRCVUnescape.

The restrictions on these parameters are verified in the CRConfig constructor and CRLAObjects constructor.

Parameters:

usc_ignore - Defines how to deal with escaped characters other than...

• ...delimiters defined in CRCVDelimiters
• ...CRCVTrim's special empty-space character
• ...c_escape

. May not be null and no character in usc_ignore.getAPCIgnore() may equal to any in CRCVDelimiters, CRCVTrim, or c_escape. See getUSCIgnore.

c_escape - The escape character. May not equal any character in usc_ignore getAPCIgnore, nor any characters in crc_variable or crc_comment.

Method Detail

getUSCIgnore

public final USCIgnore getUSCIgnore()

Get the USCIgnore for direct manipulation.

Returns:

usc_ignore Exactly as provided to the constructor.

getEscapeChar

public final char getEscapeChar()

What is the character used to escape other characters?

When this procedes another character, it is said to be "escaped". The escape character is traditionally the 'up-left' slash ('\').

Returns:

c_escape Exactly as provided to the constructor.

toString

public String toString()

Get some information about this CRCVUnescape.

Overrides:

toString in class Object