xbn.array.primitive
Class PrimitiveArrayString

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.util.XBNLocked
              |
              +--xbn.array.primitive.PrimitiveArray
                    |
                    +--xbn.array.primitive.PrimitiveArrayString

Direct Known Subclasses:

PASAOObject, PASInt, PASObject

public abstract class PrimitiveArrayString

extends PrimitiveArray

A PrimitiveArray for strings.

Source code: PrimitiveArrayString.java.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

protected

PrimitiveArrayString(String s_fqExtendingClass, PARString par_string) Create an PrimitiveArrayString.

Method Summary

boolean	areLmntsEqual(int i_idxThis, PrimitiveArray pa_other, int i_idxOther) Are the two elements equal?
boolean	areLmntsEqual(int i_idxThis, PrimitiveArrayString pas_other, int i_idxOther) Is an element in this PrimitiveArrayString equal to an element in another?
PARString	getPARString() Get the PARString for direct manipulation.
boolean	isValid(String s_callingClsFnc, String s_varName) Is the [object wrapped to look like an array of strings] legal?

Methods inherited from class xbn.array.primitive.PrimitiveArray

areLmntsEqual, crashIfBad, crashIfBad, declareNoViolation, getFQClassName, getLength, getList, getList, getList, getList, getNewAOSOBString, getNewAOSOBStringBuffer, getNewAOString, getPAViolation, getPrimitiveArrayRule, getSOBString, getSOBStringBuffer, getString, isNull, isNull, isValid, setPAViolation, throwAXIllegal, throwLmntsEqualAioobx, wasValidated

Methods inherited from class xbn.util.XBNLocked

throwLX, throwLX, throwLXIfLocked, throwLXIfLocked, throwLXIfLocked, throwLXIfUnlocked

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, toString, wait, wait, wait

Constructor Detail

PrimitiveArrayString

protected PrimitiveArrayString(String s_fqExtendingClass,
                               PARString par_string)

Create an PrimitiveArrayString.

Equal to PrimitiveArray(s_fqExtendingClass, par_string)

Method Detail

areLmntsEqual

public final boolean areLmntsEqual(int i_idxThis,
                                   PrimitiveArray pa_other,
                                   int i_idxOther)

Description copied from class: PrimitiveArray

Are the two elements equal?

Overrides:

areLmntsEqual in class PrimitiveArray

Following copied from class: xbn.array.primitive.PrimitiveArray

Parameters:

i_idxThis - The array index. Must range 0..[getLength() - 1], inclusive

pa_other - The PrimitiveArray to retrieve element i_idxOther from. May not be null.

i_idxOther - The array index of the desired element in pa_other. Must be valid for pa_other.

areLmntsEqual

public boolean areLmntsEqual(int i_idxThis,
                             PrimitiveArrayString pas_other,
                             int i_idxOther)

Is an element in this PrimitiveArrayString equal to an element in another?

For documentation on this function, see PrimitiveArray.areLmntsEqual.

getPARString

public final PARString getPARString()

Get the PARString for direct manipulation.

Returns:

(PARString)getPrimitiveArrayRule().

isValid

public final boolean isValid(String s_callingClsFnc,
                             String s_varName)

Is the [object wrapped to look like an array of strings] legal?

Overrides:

isValid in class PrimitiveArray

Parameters:

s_callingClsFnc - The name of the class-dot-function for use in potential error messages only. This is the place where the error message should appear that it was generated from. For example: xbn.array.primitive.PrimitiveArrayString.crashIfInvalid.

s_varName - The descriptive name of the string array, for potential error messages only.

Returns:

true If all rules configured into the PARString are followed by the [object wrapped to look like an array of strings].
false If any rules are violated.