xbn.array
Class CAConfig

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.array.CAConfig

Direct Known Subclasses:

CACAtLeast

public class CAConfig

extends XBNObject

Manges configuration for CompareArrays. See CompareArrays

Source code: CAConfig.java

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

	CAConfig() Create a CAConfig with default settings.
	CAConfig(boolean b_missingOk) Create a CAConfig.
	CAConfig(boolean b_missingOk, boolean b_extraOk) Create a CAConfig.
protected	CAConfig(boolean b_missingOk, boolean b_extraOk, boolean b_orderingRqd, boolean b_orderDirSameOpp) Create a CACAtLeast.

Method Summary

boolean	getOrderDirSameOpp() In which direction should the actual values be ordered?
boolean	isExtraOk() Is it legal for extra values to be provided?
boolean	isMissingOk() Is it legal for required values to be missing?
boolean	isOrderingRqd() Is it required for the actual values to be in the same/opposite order as the required values?
String	toString() Get some information about this CAConfig.

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

CAConfig

public CAConfig()

Create a CAConfig with default settings.

Equal to CAConfig(true)

CAConfig

public CAConfig(boolean b_missingOk)

Create a CAConfig.

Equal to CAConfig(b_missingOk, true)

CAConfig

public CAConfig(boolean b_missingOk,
                boolean b_extraOk)

Create a CAConfig.

Equal to CAConfig(b_missingOk, b_extraOk, false, false)

CAConfig

protected CAConfig(boolean b_missingOk,
                   boolean b_extraOk,
                   boolean b_orderingRqd,
                   boolean b_orderDirSameOpp)

Create a CACAtLeast.

This constructor is publically available in CACExact.

Parameters:

b_missingOk - If any required values are missing, is this okay? If true, yes. If false, no. See isMissingOk.

b_extraOk - If any extra (non-required) values are provided, is this okay? If true, yes. If false, no. See isExtraOk.

b_orderingRqd - Must the actual values be ordered in the same or opposite way as the required values? If true, yes (b_orderDirSameOpp defines the direction). If false, no. When (b_orderDirSameOpp is ignored). See isOrderingRqd.

b_orderDirSameOpp - When ordering is required, which direction--in relation to the required values--should the actual values be? If true, the actual values must be in the same order as the required values. If false, the actual values must be in the opposite order as the required values. When b_orderingRqd equals false, this parameter is ignored. See getOrderDirSameOpp.

Method Detail

isMissingOk

public final boolean isMissingOk()

Is it legal for required values to be missing?

Returns:

b_missingOk Exactly as provided to the constructor.

isExtraOk

public final boolean isExtraOk()

Is it legal for extra values to be provided?

Returns:

b_extraOk Exactly as provided to the constructor.

isOrderingRqd

public final boolean isOrderingRqd()

Is it required for the actual values to be in the same/opposite order as the required values?

When true, the order direction is determined by getOrderDirSameOpp.

Returns:

b_orderingRqd Exactly as provided to the constructor.

getOrderDirSameOpp

public final boolean getOrderDirSameOpp()

In which direction should the actual values be ordered?

This value is ignored when isOrderingRqd equals false.

Returns:

b_orderDirSameOpp Exactly as provided to the constructor.

toString

public String toString()

Get some information about this CAConfig.

Overrides:

toString in class Object