Insert (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:Arraylist:Insert subtitle}} | {{Template:Arraylist:Insert subtitle}} | ||
[[Category:Arraylist methods|Insert function]] | [[Category:Arraylist methods|Insert function]] | ||
<!--DPL?? Category:Arraylist methods|<var>Insert</var> function: <var>Insert</var> item into Arraylist--> | <!--DPL?? Category:<var>Arraylist</var> methods|<var>Insert</var> function: <var>Insert</var> item into <var>Arraylist</var>--> | ||
<p> | <p> | ||
<var>Insert</var> is a member of the [[Arraylist class]]. | <var>Insert</var> is a member of the [[Arraylist class]]. | ||
| Line 7: | Line 7: | ||
This callable function | This callable function | ||
inserts an item before the ''number'' item in the Arraylist. | inserts an item before the ''number'' item in the <var>Arraylist</var>. | ||
==Syntax== | ==Syntax== | ||
{{Template:Arraylist:Insert syntax}} | {{Template:Arraylist:Insert syntax}} | ||
| Line 13: | Line 13: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><i>%num</i></th> | <tr><th><i>%num</i></th> | ||
<td>A numeric variable to contain the number of items in the indicated Arraylist after the item has been inserted. </td></tr> | <td>A numeric variable to contain the number of items in the indicated <var>Arraylist</var> after the item has been inserted. </td></tr> | ||
<tr><th><i> | <tr><th><i><var class="term">al</var></i></th> | ||
<td>An Arraylist object. </td></tr> | <td>An <var>Arraylist</var> object. </td></tr> | ||
<tr><th><i>number</i></th> | <tr><th><i>number</i></th> | ||
<td>A whole number greater than 0 to identify an '' | <td>A whole number greater than 0 to identify an ''<var class="term">al</var>'' item. </td></tr> | ||
<tr><th><i>item</i></th> | <tr><th><i>item</i></th> | ||
<td>A value or variable of the same type as specified on the '' | <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== | ||
<ul> | <ul> | ||
<li>If ''number'' is less than or equal to the number of items | <li>If ''number'' is less than or equal to the number of items | ||
in the Arraylist, the new item is inserted before the indicated item. | in the <var>Arraylist</var>, the new item is inserted before the indicated item. | ||
<li>If ''number'' is equal to the number of items in the Arraylist | <li>If ''number'' is equal to the number of items in the <var>Arraylist</var> | ||
plus one, the new item is added to the end of the Arraylist. | plus one, the new item is added to the end of the <var>Arraylist</var>. | ||
<li>If ''number'' is greater than the number of items in the Arraylist | <li>If ''number'' is greater than the number of items in the <var>Arraylist</var> | ||
plus one, or less than or equal to zero, the request is cancelled. | plus one, or less than or equal to zero, the request is cancelled. | ||
<li>For an example using the <var>Insert</var> method, see [[Arraylist class]]. | <li>For an example using the <var>Insert</var> method, see [[Arraylist class]]. | ||
</ul> | </ul> | ||
Revision as of 02:29, 20 January 2011
Insert items into Arraylist (Arraylist class)
Insert is a member of the Arraylist class.
This callable function inserts an item before the number item in the Arraylist.
Syntax
[%count =] al:Insert( number, itemList)
Syntax terms
| %num | A numeric variable to contain the number of items in the indicated Arraylist after the item has been inserted. |
|---|---|
| al | An Arraylist object. |
| number | A whole number greater than 0 to identify an al item. |
| item | 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
- If number is less than or equal to the number of items in the Arraylist, the new item is inserted before the indicated item.
- If number is equal to the number of items in the Arraylist plus one, the new item is added to the end of the Arraylist.
- If number is greater than the number of items in the Arraylist plus one, or less than or equal to zero, the request is cancelled.
- For an example using the Insert method, see Arraylist class.