Add (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (apply Dave's suggestions)
m (call that consistent, this is consistent)
Line 1: Line 1:
{{Template:Arraylist:Add subtitle}}
{{Template:Arraylist:Add subtitle}}
 
<var>Add</var> adds an item to the end of an <var>Arraylist</var>.
<p>This callable function adds an item to the end of an Arraylist.</p>


==Syntax==
==Syntax==
Line 12: Line 11:
<td>An <var>Arraylist</var> object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th>collectionItem</th>
<tr><th>collectionItem</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;to be added to the <var class="term">al</var> <var>Arraylist</var> object.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
<ul><li>The <var>[[Push (Arraylist function)|Push]]</var> and <var>[[Enqueue (Arraylist function)|Enqueue]]</var> functions are the same as the <var>Add</var> function:
<ul><li>The <var>[[Push (Arraylist function)|Push]]</var> and <var>[[Enqueue (Arraylist function)|Enqueue]]</var> functions are the same as the <var>Add</var> function:

Revision as of 06:37, 11 March 2011

Add Arraylist items (Arraylist class)

Add 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;to be added to the al Arraylist object.

Usage notes

  • 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.

Examples

For examples of Add calls, see Arraylist class.

See also