xbn.array
Class UniqueStringAP

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.array.ArrayProtector
              |
              +--xbn.array.APObject
                    |
                    +--xbn.array.UniqueStringAP

All Implemented Interfaces:

Cloneable

public class UniqueStringAP

extends APObject

An APObject for UniqueStrings. See UniqueString.

Source code: UniqueStringAP.java

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

UniqueStringAP(UniqueString[] a_unqStrMD)
Create an UniqueStringAP from the array of UniqueStrings.

Method Summary

protected Object	clone() Get a full (deep) copy ofthis UniqueStringAP as an Object.
UniqueString[]	getAOUSClone() Get a full (deep) copy of the internally-held array of UniqueStrings.
UniqueString[]	getAOUSShallowClone() Get a shallow clone of the internally-held array of UniqueStrings.
UniqueString	getUniqueString(int i_dx) Get the UniqueString at the requested array index.
UniqueStringPAS	getUniqueStringPAS() Get a UniqueStringPAS representing the string within each UniqueString.
UniqueStringPAS	getUniqueStringPAS(PARString par_string) Get a UniqueStringPAS representing the string within each UniqueString.
UniqueStringAP	getUSAPClone() Get a full (deep) copy ofthis UniqueStringAP.

Methods inherited from class xbn.array.APObject

addToVWObject, appendTSList, getAOOShallowClone, getAPOClone, getLength, getObject, getPASAOObject, getString, isNull, isNull, toString

Methods inherited from class xbn.array.ArrayProtector

getList, getList, getList, getList, getPASArrayProtector

Methods inherited from class xbn.XBNObject

getXMsgPrefix, sop, sopl, sopl, throwAX, throwAXIfBadStr, throwAXIfNull, throwAXSpoof

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

UniqueStringAP

public UniqueStringAP(UniqueString[] a_unqStrMD)

Create an UniqueStringAP from the array of UniqueStrings.

Equal to APObject(a_unqStrMD)

Parameters:

a_unqStrMD - The array of UniqueStrings. May not be null.

Method Detail

getUniqueString

public final UniqueString getUniqueString(int i_dx)

Get the UniqueString at the requested array index.

Returns:

(UniqueString)getObject(i_dx)

getAOUSShallowClone

public final UniqueString[] getAOUSShallowClone()

Get a shallow clone of the internally-held array of UniqueStrings. The array is copied, but the elements are the same as provided to the constructor.

For a deep clone, use getAOUSClone.

getAOUSClone

public final UniqueString[] getAOUSClone()

Get a full (deep) copy of the internally-held array of UniqueStrings.

getUniqueStringPAS

public final UniqueStringPAS getUniqueStringPAS()

Get a UniqueStringPAS representing the string within each UniqueString.

Returns:

getUniqueStringPAS(new PARString())

getUniqueStringPAS

public final UniqueStringPAS getUniqueStringPAS(PARString par_string)

Get a UniqueStringPAS representing the string within each UniqueString. See UniqueString.getString.

Returns:

(new UniqueStringPAS(getAOUSShallowClone(), par_string))

getUSAPClone

public final UniqueStringAP getUSAPClone()

Get a full (deep) copy ofthis UniqueStringAP.

Returns:

(UniqueStringAP)clone()

clone

protected Object clone()
                throws CloneNotSupportedException

Get a full (deep) copy ofthis UniqueStringAP as an Object.

Overrides:

clone in class APObject

Returns:

(new UniqueStringAP(getAOUSClone()))