xbn.template
Class TDOSArray

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.named.NamedArray
              |
              +--xbn.template.TDOSArray

All Implemented Interfaces:

Named

public class TDOSArray

extends NamedArray

Manage multiple TemplateDataOrStrings. See TemplateDataOrStrings.

Source code: TDOSArray.java

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

TDOSArray(String s_name, TemplateDataOrString[] a_tdos)
Create a TDOSArray.

TDOSArray(String s_name, TemplateDataOrString[] a_tdos, boolean b_listNames)
Create a TDOSArray.

TDOSArray(TemplateDataOrString[] a_tdos)
Create a TDOSArray.

Method Summary

String	getString(int i_dx) Get the string from the requested TemplateDataOrString.
TemplateData	getTemplateData(int i_dx) Get the TemplateData from the requested TemplateDataOrString.
TemplateDataOrString	getTemplateDataOrString(int i_dx) Get the requested TemplateDataOrString for direct manipulation.
TemplateDataOrString	getTemplateDataOrString(String s_name) Get the requested TemplateDataOrString for direct manipulation.
boolean	isString(int i_dx) Does the requested TemplateDataOrString have no gaps?
boolean	isTemplate(int i_dx) Does the requested TemplateDataOrString have a gap?

Methods inherited from class xbn.named.NamedArray

doesExist, getAOSLHashtable, getAOSLookup, getAPNamed, getArrIdx, getLength, getName, getName, getNamed, getNamed, getNameList, getNameList, getNameList, getNameList, throwAXWithName, toString, toString

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

TDOSArray

public TDOSArray(TemplateDataOrString[] a_tdos)

Create a TDOSArray.

Equal to NamedArray(null, a_tdos)

TDOSArray

public TDOSArray(String s_name,
                 TemplateDataOrString[] a_tdos)

Create a TDOSArray.

Equal to NamedArray(s_name, a_tdos)

TDOSArray

public TDOSArray(String s_name,
                 TemplateDataOrString[] a_tdos,
                 boolean b_listNames)

Create a TDOSArray.

Equal to NamedArray(s_name, a_tdos, b_listNames)

Method Detail

getTemplateDataOrString

public TemplateDataOrString getTemplateDataOrString(String s_name)

Get the requested TemplateDataOrString for direct manipulation.

Equal to (TemplateDataOrString)getNamed(s_name)

Parameters:

s_name - The name of the desired level. Must equal the name of an existing TemplateDataOrString contained in this TDOSArray.

getTemplateDataOrString

public TemplateDataOrString getTemplateDataOrString(int i_dx)

Get the requested TemplateDataOrString for direct manipulation.

Equal to (TemplateDataOrString)getNamed(i_dx)

Parameters:

i_dx - The array index of the TemplateDataOrString object. Must be between 0 and [NamedArray.getCount - 1], inclusive.

isTemplate

public final boolean isTemplate(int i_dx)

Does the requested TemplateDataOrString have a gap?

Returns:

getTemplateDataOrString(i_dx).isTemplate()

isString

public final boolean isString(int i_dx)

Does the requested TemplateDataOrString have no gaps?

Returns:

getTemplateDataOrString(i_dx).isString()

getTemplateData

public final TemplateData getTemplateData(int i_dx)

Get the TemplateData from the requested TemplateDataOrString.

Returns:

getTemplateDataOrString(i_dx).getTemplateData()

getString

public final String getString(int i_dx)

Get the string from the requested TemplateDataOrString.

Returns:

getTemplateDataOrString(i_dx).getString()