Add (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (syntax diagram, tags and links)
Line 1: Line 1:
{{Template:Arraylist:Add subtitle}}
{{Template:Arraylist:Add subtitle}}
<p>This callable function adds an item to the end of an Arraylist.</p>


==Syntax==
==Syntax==
Line 5: Line 7:
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%num</i></th>
<tr><th><i>%count</i></th>
<td>A numeric variable to contain the number of items in the indicated <var>Arraylist</var> after the item has been added. ''%num'' is also the item number associated with the added item in the <var>Arraylist</var>. </td></tr>
<td>An, optional, numeric variable that returns the number of items in the indicated <var>Arraylist</var> after the item has been added. <var class="term">%count</var> is also the item number associated with the added item in the <var>Arraylist</var>. </td></tr>
<tr><th><i><var class="term">al</var></i></th>
<tr><th><i>al</i></th>
<td>An <var>Arraylist</var> object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th><i>item</i></th>
<tr><th><i>collectionItem</i></th>
<td>A value or variable of the same type as specified on the ''<var class="term">al</var>'' declaration, or a value or variable convertible to that type.</td></tr>
<td>A value or variable of the same type as specified on the <var class="term">al</var> declaration, or a value or variable convertible to that type.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==

Revision as of 09:42, 29 January 2011

Add Arraylist items (Arraylist class)


This callable function adds an item to the end of an Arraylist.

Syntax

[%count =] al:Add( itemList)

Syntax terms

%count An, optional, numeric variable that returns the number of items in the indicated Arraylist after the item has been added. %count is also the item number associated with the added item in the Arraylist.
al An Arraylist object.
collectionItem A value or variable of the same type as specified on the al declaration, or a value or variable convertible to that type.

Usage notes

  • For examples of Add calls, see Arraylist class.
  • The Push and Enqueue functions are the same as the Add function:
    • Push was designed as a convenience for use with the Pop function.
    • Enqueue was designed as a convenience for use with the Dequeue function.

See also