ArrayType

Overview

ArrayType forms the base class for all array types defined in your RODL library. You will usually not instantiate instances of this class itself, but use the descendant classes that will be auto-generated in your _Intf source module for every array defined in your RODL file. These descendant classes will contain strongly-typed properties and methods to access the array elements as defined in your RODL.

Location


Instance Methods

constructor

Creates array.

 

constructor

 

ArrayType()

constructor (Object[])

 

constructor(aArray: array of Object)

 

ArrayType(Object[] aArray)

Parameters:

  • aArray:

constructor (Integer)

Creates array with given capacity.

 

constructor(aCapacity: Integer)

 

ArrayType(Integer aCapacity)

Parameters:

  • aCapacity: Given capacity.

constructor (Collection)

Creates array with given collection.

 

constructor(aCollection: Collection)

 

ArrayType(Collection aCollection)

Parameters:

  • aCollection: Given collection.

addItem

Adds the given element to the array.

 

method addItem(anItem: Object): Boolean

 

Boolean addItem(Object anItem)

Parameters:

  • anItem: Incoming object.

containsItem

Check for belonging item to the array.

 

method containsItem(anItem: Object): Boolean

 

Boolean containsItem(Object anItem)

Parameters:

  • anItem: Incoming object.

count

The size of the array.

 

method count: Integer

 

Integer count()

defineNewCapacity

Define new capacity.

 

method defineNewCapacity(aCapacity: Integer)

 

void defineNewCapacity(Integer aCapacity)

Parameters:

  • aCapacity: Incoming capacity.

getAttributeValue

 

method getAttributeValue(aName: String): String

 

String getAttributeValue(String aName)

Parameters:

  • aName:

getItemAtIndex

Get an item by index.

 

method getItemAtIndex(anIndex: Integer): Object

 

Object getItemAtIndex(Integer anIndex)

Parameters:

  • anIndex: Incoming index.

indexOfItem

Identify index of the item.

 

method indexOfItem(anItem: Object): Integer

 

Integer indexOfItem(Object anItem)

Parameters:

  • anItem: Incoming object.

insertItem

Inserting an item to the specific position.

 

method insertItem(anItem: Object; anIndex: Integer)

 

void insertItem(Object anItem, Integer anIndex)

Parameters:

  • anItem: Incoming object.
  • anIndex: Incoming index.

itemsTypeName

Return the list of types.

 

method itemsTypeName: array of String

 

String[] itemsTypeName()

itemTypeNameAtIndex

Return the type name of the object at a specific position.

 

method itemTypeNameAtIndex(anIndex: Integer): String

 

String itemTypeNameAtIndex(Integer anIndex)

Parameters:

  • anIndex: Incoming index.

readFromMessage

For internal use, used by the RO/J framework to stream the array contents from a message packet.

 

method readFromMessage(aName: String; aMessage: Message; aCount: Integer)

 

void readFromMessage(String aName, Message aMessage, Integer aCount)

Parameters:

  • aName: Incoming name.
  • aMessage: Incoming message.
  • aCount: Incoming count.

readItemFromMessage

For internal use, used by the RO/J framework to stream the individual items from a message packet.

 

method readItemFromMessage(aMessage: Message; anIndex: Integer)

 

void readItemFromMessage(Message aMessage, Integer anIndex)

Parameters:

  • aMessage: Incoming message.
  • anIndex: Incoming index.

removeAllItems

Remove all item in the array.

 

method removeAllItems

 

void removeAllItems()

removeItem

Remove specific item from the array.

 

method removeItem(anItem: Object)

 

void removeItem(Object anItem)

Parameters:

  • anItem: Incoming object.

removeItemAtIndex

Remove item at specific index from the array.

 

method removeItemAtIndex(anIndex: Integer)

 

void removeItemAtIndex(Integer anIndex)

Parameters:

  • anIndex: Incoming index.

removeLastItem

Remove last item from the array.

 

method removeLastItem

 

void removeLastItem()

replaceItemAtIndex

Replace item at specific index.

 

method replaceItemAtIndex(anItem: Object; anIndex: Integer)

 

void replaceItemAtIndex(Object anItem, Integer anIndex)

Parameters:

  • anItem: Incoming object.
  • anIndex: Incoming index.

writeItemToMessage

For internal use, used by the RO/J framework to stream the individual items to a message packet.

 

method writeItemToMessage(aMessage: Message; anIndex: Integer)

 

void writeItemToMessage(Message aMessage, Integer anIndex)

Parameters:

  • aMessage: Incoming message.
  • anIndex: Incoming index.

writeToMessage

For internal use, used by the RO/J framework to stream the individual items to a message packet.

 

method writeToMessage(aName: String; aMessage: Message)

 

void writeToMessage(String aName, Message aMessage)

Parameters:

  • aName: Incoming name.
  • aMessage: Incoming message.