xbn.string.escape
Class USConfig

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.string.escape.ESConfig
              |
              +--xbn.string.escape.USConfig

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

USCSpecific

public class USConfig

extends ESConfig

implements Cloneable

Configuration for UnescapeString. See UnescapeString.

Source code: USConfig.java

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

USConfig()
Create an USConfig with default values.

USConfig(char c_escape)
Create an USConfig.

USConfig(char[] ac_toEscape)
Create an USConfig.

USConfig(char[] ac_toEscape, USCIgnore euscu_ignore)
Create an USConfig.

USConfig(char c_escape, char[] ac_toEscape)
Create an USConfig.

USConfig(char c_escape, char[] ac_toEscape, USCIgnore euscu_ignore)
Create an USConfig.

USConfig(char c_escape, USCIgnore euscu_ignore)
Create an USConfig.

USConfig(USCIgnore euscu_ignore)
Create an USConfig.

USConfig(USConfig us_config)
Create a full (deep) copy of the provided USConfig.

Method Summary

USCIgnore	getUSCIgnore() Get the USCIgnore for direct manipulation.
String	toString() Get some information about this EUSCUsescape.

Methods inherited from class xbn.string.escape.ESConfig

getAPCToEscape, getEscapeChar, getEscapeCharAsString, getEscapeCharDefault, isToBeEscaped

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

USConfig

public USConfig()

Create an USConfig with default values.

Equal to USConfig(getEscapeCharDefault())

USConfig

public USConfig(char c_escape)

Create an USConfig.

Equal to USConfig(c_escape, (new char[] {}))

USConfig

public USConfig(char[] ac_toEscape)

Create an USConfig.

Equal to USConfig(getEscapeCharDefault(), ac_toEscape)

USConfig

public USConfig(USCIgnore euscu_ignore)

Create an USConfig.

Equal to USConfig(getEscapeCharDefault(), euscu_ignore)

USConfig

public USConfig(char c_escape,
                char[] ac_toEscape)

Create an USConfig.

Equal to USConfig(c_escape, ac_toEscape, (new USCIgnore()))

USConfig

public USConfig(char c_escape,
                USCIgnore euscu_ignore)

Create an USConfig.

Equal to USConfig(c_escape, (new char[] {}), euscu_ignore)

USConfig

public USConfig(char[] ac_toEscape,
                USCIgnore euscu_ignore)

Create an USConfig.

Equal to USConfig(getEscapeCharDefault(), ac_toEscape, euscu_ignore)

USConfig

public USConfig(char c_escape,
                char[] ac_toEscape,
                USCIgnore euscu_ignore)

Create an USConfig.

The first line of this constructor calls ESConfig(c_escape, ac_toEscape)

Parameters:

euscu_ignore - The exception characters to ignore. May not be null. If euscu_ignore.getAPCIgnore() is greater than zero elements, then no element may equal c_escape, nor any character in ac_toEscape.

USConfig

public USConfig(USConfig us_config)

Create a full (deep) copy of the provided USConfig.

The first line of this constructor calls ESConfig(us_config)

Method Detail

getUSCIgnore

public final USCIgnore getUSCIgnore()

Get the USCIgnore for direct manipulation.

Returns:

euscu_ignore Exactly as provided to the constructor.

toString

public String toString()

Get some information about this EUSCUsescape.

Overrides:

toString in class ESConfig