xbn.string
Class GCIConfig

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.string.GCIConfig

Direct Known Subclasses:

GCICTwo

public class GCIConfig

extends XBNObject

Configuration for UtilSOB.getContainedIdxs. See UtilSOB.getContainedIdxs.

Source code: GCIConfig.java

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

GCIConfig()
Create a GCIConfig with default settings.

GCIConfig(boolean b_equalOk)
Create a GCIConfig.

GCIConfig(boolean b_equalOk, PARSCBad parsc_bad)
Create a GCIConfig.

GCIConfig(PARSCBad parsc_bad)
Create a GCIConfig.

GCIConfig(String s_callingClsFnc)
Create a GCIConfig.

GCIConfig(String s_callingClsFnc, boolean b_equalOk)
Create a GCIConfig.

GCIConfig(String s_callingClsFnc, boolean b_equalOk, PARSCBad parsc_bad)
Create a GCIConfig.

GCIConfig(String s_callingClsFnc, PARSCBad parsc_bad)
Create a GCIConfig.

GCIConfig(String s_callingClsFnc, String[] as_names)
Create a GCIConfig.

GCIConfig(String s_callingClsFnc, String[] as_names, boolean b_equalOk)
Create a GCIConfig.

GCIConfig(String s_callingClsFnc, String[] as_names, boolean b_equalOk, PARSCBad parsc_bad)
Create a GCIConfig.

GCIConfig(String s_callingClsFnc, String[] as_names, PARSCBad parsc_bad)
Create a GCIConfig.

Method Summary

String[]	getAOSNames() Get the array of descriptive names for every element in a_strOrBfr.
String	getCallingClassFunc() Get the name of the class-plus-function for potential error messages.
PARSCBad	getPARSCBad() Get the PARSCBad, which defines extra containment rules.
boolean	isEqualOk() Is equality also considered illegal?
String	toString() Get some information about this GCIConfig.

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

GCIConfig

public GCIConfig()

Create a GCIConfig with default settings.

Equal to GCIConfig(false)

GCIConfig

public GCIConfig(String s_callingClsFnc)

Create a GCIConfig.

Equal to GCIConfig(s_callingClsFnc, false)

GCIConfig

public GCIConfig(boolean b_equalOk)

Create a GCIConfig.

Equal to GCIConfig(null, b_equalOk)

GCIConfig

public GCIConfig(PARSCBad parsc_bad)

Create a GCIConfig.

Equal to GCIConfig(null, parsc_bad)

GCIConfig

public GCIConfig(String s_callingClsFnc,
                 String[] as_names)

Create a GCIConfig.

Equal to GCIConfig(s_callingClsFnc, as_names, false)

GCIConfig

public GCIConfig(String s_callingClsFnc,
                 boolean b_equalOk)

Create a GCIConfig.

Equal to GCIConfig(s_callingClsFnc, null, b_equalOk)

GCIConfig

public GCIConfig(String s_callingClsFnc,
                 PARSCBad parsc_bad)

Create a GCIConfig.

Equal to GCIConfig(s_callingClsFnc, null, parsc_bad)

GCIConfig

public GCIConfig(boolean b_equalOk,
                 PARSCBad parsc_bad)

Create a GCIConfig.

Equal to GCIConfig(null, b_equalOk, parsc_bad)

GCIConfig

public GCIConfig(String s_callingClsFnc,
                 String[] as_names,
                 boolean b_equalOk)

Create a GCIConfig.

Equal to GCIConfig(s_callingClsFnc, as_names, b_equalOk, (new PARSCBad()))

GCIConfig

public GCIConfig(String s_callingClsFnc,
                 String[] as_names,
                 PARSCBad parsc_bad)

Create a GCIConfig.

Equal to GCIConfig(s_callingClsFnc, as_names, false, parsc_bad)

GCIConfig

public GCIConfig(String s_callingClsFnc,
                 boolean b_equalOk,
                 PARSCBad parsc_bad)

Create a GCIConfig.

Equal to GCIConfig(s_callingClsFnc, null, b_equalOk, parsc_bad)

GCIConfig

public GCIConfig(String s_callingClsFnc,
                 String[] as_names,
                 boolean b_equalOk,
                 PARSCBad parsc_bad)

Create a GCIConfig.

This documentation discusses UtilSOB.getContainedIdxs, including it's parameters (a_strOrBfr and gci_config) and returned value (an informational s_s).

Parameters:

s_callingClsFnc - The name of the class-plus-function for potential error messages, when getContainedIdxs detects a containment violation. If null, an informational i_i_i is returned. If non-null, an AssertException is thrown with a message describing the violation (where this class-plus-function is where the error will appear to have been caused). See getCallingClassFunc.

as_names - The array of descriptive names for every element in a_strOrBfr. If non-null, these names are used in potential error messages (element X in as_names is the name of element X in a_strOrBfr). If null, then "a_strOrBfr[INDEX]" is the name assigned to each element. When non-null, this must be exactly the same length as a_strOrBfr. All elements should be non-null and at least one character in length, although this is not enforced. If s_callingClsFnc is null, then this must be null as well. See getAOSNames.

b_equalOk - Should equality also be considered illegal? If true, then containment is illegal, but equality is not. If false, both containment and equality are considered illegal. See isEqualOk.

parsc_bad - Defines extra rules for containment. May not be null. See getPARSCBad.

Method Detail

getCallingClassFunc

public final String getCallingClassFunc()

Get the name of the class-plus-function for potential error messages.

If this returns null, an informational i_i_i is returned by getContainedIdxs. If non-null, an AssertException is thrown with a message describing the violation (where this class-plus-function is where the error will appear to have been caused).

Returns:

s_callingClsFnc Exactly as provided to the constructor.

getAOSNames

public final String[] getAOSNames()

Get the array of descriptive names for every element in a_strOrBfr. See getContainedIdxs for information on the a_strOrBfr parameter.

If this returns a non-null value, it is an array of strings containing the names to be used in potential error messages (element X in this is the name of element X in a_strOrBfr). If null, then "a_strOrBfr[INDEX]" is the name assigned to each element.

When getCallingClassFunc returns null, this also returns null. When getCallingClassFunc is non-null, this may or may not return null.

Returns:

s_callingClsFnc Exactly as provided to the constructor.

isEqualOk

public final boolean isEqualOk()

Is equality also considered illegal?

If this returns true, then containment is illegal, but equality is not. If false, both containment and equality are considered illegal.

Returns:

b_equalOk Exactly as provided to the constructor.

getPARSCBad

public final PARSCBad getPARSCBad()

Get the PARSCBad, which defines extra containment rules.

Returns:

parsc_bad Exactly as provided to the constructor.

toString

public final String toString()

Get some information about this GCIConfig.

Overrides:

toString in class Object