xbn.array.primitive
Class PrimitiveArrayRule

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.array.primitive.PrimitiveArrayRule

Direct Known Subclasses:

PARChar, PARInt, PARString

public abstract class PrimitiveArrayRule

extends XBNObject

Defines the rules to be enforced by PrimitiveArray.isValid. See PrimitiveArray.isValid.

Source code: PrimitiveArrayRule.java.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

protected	PrimitiveArrayRule(PARDupNullLen par_dupNullLen, PAROrderDir par_orderDir) Create an PrimitiveArrayRule.
protected	PrimitiveArrayRule(PrimitiveArrayRule pa_rule) Create a full (deep) copy of the provided PrimitiveArrayRule.

Method Summary

PARDupNullLen	getPARDupNullLen() Get the PARDupNullLen for direct manipulation.
PAROrderDir	getPAROrderDir() Get the PAROrderDir for direct manipulation.
boolean	isRestricted() Does this PrimitiveArrayRule have any restrictions?
String	toString() Get some information about this PrimitiveArrayRule.

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

PrimitiveArrayRule

protected PrimitiveArrayRule(PARDupNullLen par_dupNullLen,
                             PAROrderDir par_orderDir)

Create an PrimitiveArrayRule.

Parameters:

par_dupNullLen - Defines whether overall duplicate, null and length rules. May not be null. See getPARDupNullLen.

par_orderDir - Defines ordering requirements to impose onto the array. May not be null. See getPAROrderDir.

PrimitiveArrayRule

protected PrimitiveArrayRule(PrimitiveArrayRule pa_rule)

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

Parameters:

pa_rule - The PrimitiveArrayRule to copy. May not be null.

Method Detail

getPARDupNullLen

public final PARDupNullLen getPARDupNullLen()

Get the PARDupNullLen for direct manipulation.

Returns:

par_dupNullLen Exactly as provided to the constructor.

getPAROrderDir

public final PAROrderDir getPAROrderDir()

Get the PAROrderDir for direct manipulation.

Returns:

par_dupNullLen Exactly as provided to the constructor.

isRestricted

public boolean isRestricted()

Does this PrimitiveArrayRule have any restrictions?

If this function returns false, then there are absolutely no requirements to impose onto the char array (by PrimitiveArray.isValid). If true, there is at least one requirement.

Returns:

(getPARDupNullLen().isRestricted() || getPAROrderDir().isRestricted())

toString

public String toString()

Get some information about this PrimitiveArrayRule.

Overrides:

toString in class Object