xbn.array
Class PASArrayProtector

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

public class PASArrayProtector

extends PASObject

A PrimitiveArrayString that wraps around an ArrayProtector. See ArrayProtector.

Source code: PASArrayProtector.java.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

PASArrayProtector()
Create a PASArrayProtector with default values.

PASArrayProtector(ArrayProtector array_protector)
Create a PASArrayProtector.

PASArrayProtector(ArrayProtector array_protector, PARString par_string)
Create a PASArrayProtector.

PASArrayProtector(String s_fqExtendingClass, ArrayProtector array_protector)
Create a PASArrayProtector.

PASArrayProtector(String s_fqExtendingClass, ArrayProtector array_protector, PARString par_string)
Create a PASArrayProtector.

Method Summary

ArrayProtector	getArrayProtector() Get the object for direct manipulation.
int	getLength() How many items exist in this PrimitiveArray?
String	getString(int i_dx) Get the element at the requested array index, as a string.
boolean	isNull(int i_dx) Is the [thing] at the requested array index null?

Methods inherited from class xbn.array.primitive.PASObject

getObject, isNull

Methods inherited from class xbn.array.primitive.PrimitiveArrayString

areLmntsEqual, areLmntsEqual, getPARString, isValid

Methods inherited from class xbn.array.primitive.PrimitiveArray

areLmntsEqual, crashIfBad, crashIfBad, declareNoViolation, getFQClassName, getList, getList, getList, getList, getNewAOSOBString, getNewAOSOBStringBuffer, getNewAOString, getPAViolation, getPrimitiveArrayRule, getSOBString, getSOBStringBuffer, 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

PASArrayProtector

public PASArrayProtector()

Create a PASArrayProtector with default values.

Equal to PASArrayProtector(null)

PASArrayProtector

public PASArrayProtector(ArrayProtector array_protector)

Create a PASArrayProtector.

Equal to PASArrayProtector("xbn.array.primitive.PASArrayProtector", array_protector)

PASArrayProtector

public PASArrayProtector(String s_fqExtendingClass,
                         ArrayProtector array_protector)

Create a PASArrayProtector.

Equal to PASArrayProtector(s_fqExtendingClass, array_protector, (new PARString())))

PASArrayProtector

public PASArrayProtector(ArrayProtector array_protector,
                         PARString par_string)

Create a PASArrayProtector.

Equal to PASArrayProtector("xbn.array.primitive.PASArrayProtector", array_protector, par_string)

PASArrayProtector

public PASArrayProtector(String s_fqExtendingClass,
                         ArrayProtector array_protector,
                         PARString par_string)

Create a PASArrayProtector.

Equal to PrimitiveArrayString(s_fqExtendingClass, par_string)

Method Detail

getArrayProtector

public final ArrayProtector getArrayProtector()

Get the object for direct manipulation.

Returns:

array_protector Exactly as provided to the constructor.

getString

public final String getString(int i_dx)

Description copied from class: PrimitiveArray

Get the element at the requested array index, as a string.

Overrides:

getString in class PrimitiveArray

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

Parameters:

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

AssertException - If isNull equals true.

getLength

public final int getLength()

Description copied from class: PrimitiveArray

How many items exist in this PrimitiveArray?

Overrides:

getLength in class PrimitiveArray

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

Throws:

AssertException - If isNull equals true.

isNull

public final boolean isNull(int i_dx)

Description copied from class: PrimitiveArray

Is the [thing] at the requested array index null?

Overrides:

isNull in class PrimitiveArray

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

Parameters:

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

AssertException - If isNull equals true.