List (Arraylist function) - Revision history

JAL: /* Examples */

2012-11-01T16:08:10Z

Examples

← Older revision		Revision as of 16:08, 1 November 2012
Line 46:		Line 46:

	==Examples==		==Examples==
	===Creating an Arraylist of numbers===		====Creating an Arraylist of numbers====
	The following <var>List</var> method call creates a new <var>Arraylist</var> instance of 11 integer items that begins with 1 and whose subsequent items are, respectively, the sum of the preceding two integers:		The following <var>List</var> method call creates a new <var>Arraylist</var> instance of 11 integer items that begins with 1 and whose subsequent items are, respectively, the sum of the preceding two integers:
	<p class="code">%fib is collection arraylist of float		<p class="code">%fib is collection arraylist of float
	%fib = list(1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89)		%fib = list(1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89)
	</p>		</p>
	===Creating an Arraylist of objects===
			====Creating an Arraylist of objects====
	The following <var>List</var> call creates a new <var>Arraylist</var> instance whose items are objects of user class <var class="term">freight</var>:		The following <var>List</var> call creates a new <var>Arraylist</var> instance whose items are objects of user class <var class="term">freight</var>:
	<p class="code">class freight		<p class="code">class freight
Line 66:		Line 67:
	newf(-7, 1234))		newf(-7, 1234))
	</p>		</p>
	===Creating an Arraylist from objects and Arraylists===
			====Creating an Arraylist from objects and Arraylists====
	Under <var clas="product">Sirius Mods</var> 7.9 and later it is possible to include collections in the list of items being added. If a collection is in the list, each item in the collection is added to the target <var>Arraylist</var>.		Under <var clas="product">Sirius Mods</var> 7.9 and later it is possible to include collections in the list of items being added. If a collection is in the list, each item in the collection is added to the target <var>Arraylist</var>.
	The following <var>List</var> call creates a new <var>Arraylist</var> instance whose items are objects of user class <var class="term">freight</var>, some of them from existing <var>Arraylists</var> <code>%ark1</code> and <code>%ark2</code> and some newly created objects.		The following <var>List</var> call creates a new <var>Arraylist</var> instance whose items are objects of user class <var class="term">freight</var>, some of them from existing <var>Arraylists</var> <code>%ark1</code> and <code>%ark2</code> and some newly created objects.

JAL2: /* Syntax terms */

2012-07-20T20:57:35Z

Syntax terms

← Older revision		Revision as of 20:57, 20 July 2012
Line 8:		Line 8:
	<tr><th>%newlist</th>		<tr><th>%newlist</th>
	<td>A declared or existing <var>Arraylist</var> object. </td></tr>		<td>A declared or existing <var>Arraylist</var> object. </td></tr>

	<tr><th nowrap="true"><var>[%(Arraylist Of </var>itemType<var>):]</var></th>		<tr><th nowrap="true"><var>[%(Arraylist Of </var>itemType<var>):]</var></th>
	<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>		<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>

	<tr><th>itemList</th>		<tr><th>itemList</th>
	<td>A comma-delimited set of ~~values~~ or variables of the same type as specified on the <var class="term">al</var> declaration ~~or collections~~ of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>. The ability to include a ~~collections~~ in <var class="term">itemList</var> was added in Sirius Mods 7.9.</td></tr>		<td>A comma-delimited set of a combination of one or more of these:
			<ul>
			<li>Values or variables of the same type as specified on the <var class="term">al</var> declaration
			<li>Collections of objects of the same type as specified on the <var class="term">al</var> declaration
			</ul>

			Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>.

			The ability to include a collection in <var class="term">itemList</var> was added in <var class="product">Sirius Mods</var> 7.9.</td></tr>
	</table>		</table>

JALWiccan: 1 revision

2011-11-30T20:24:03Z

1 revision

← Older revision	Revision as of 20:24, 30 November 2011
(No difference)

Dme: /* Syntax terms */

2011-11-30T20:24:02Z

Syntax terms

← Older revision		Revision as of 20:24, 30 November 2011
Line 8:		Line 8:
	<tr><th>%newlist</th>		<tr><th>%newlist</th>
	<td>A declared or existing <var>Arraylist</var> object. </td></tr>		<td>A declared or existing <var>Arraylist</var> object. </td></tr>
	<tr><th nowrap="true"><var>[%(Arraylist Of </var>itemType<var>)]</var></th>		<tr><th nowrap="true"><var>[%(Arraylist Of </var>itemType<var>):]</var></th>
	<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>		<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>
	<tr><th>itemList</th>		<tr><th>itemList</th>

Dme: /* Syntax terms */

2011-08-24T21:27:45Z

Syntax terms

← Older revision		Revision as of 21:27, 24 August 2011
Line 9:		Line 9:
	<td>A declared or existing <var>Arraylist</var> object. </td></tr>		<td>A declared or existing <var>Arraylist</var> object. </td></tr>
	<tr><th nowrap="true"><var>[%(Arraylist Of </var>itemType<var>)]</var></th>		<tr><th nowrap="true"><var>[%(Arraylist Of </var>itemType<var>)]</var></th>
	<td>The optional class name in parentheses denotes a [[Notation conventions for methods#~~Shared methods and constructors~~\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>		<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>
	<tr><th>itemList</th>		<tr><th>itemList</th>
	<td>A comma-delimited set of values or variables of the same type as specified on the <var class="term">al</var> declaration or collections of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>. The ability to include a collections in <var class="term">itemList</var> was added in Sirius Mods 7.9.</td></tr>		<td>A comma-delimited set of values or variables of the same type as specified on the <var class="term">al</var> declaration or collections of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>. The ability to include a collections in <var class="term">itemList</var> was added in Sirius Mods 7.9.</td></tr>

JAL2: /* Syntax terms */

2011-08-24T16:52:15Z

Syntax terms

← Older revision		Revision as of 16:52, 24 August 2011
Line 8:		Line 8:
	<tr><th>%newlist</th>		<tr><th>%newlist</th>
	<td>A declared or existing <var>Arraylist</var> object. </td></tr>		<td>A declared or existing <var>Arraylist</var> object. </td></tr>
	<tr><th nowrap="true"><var>[%(Arraylist Of <i>itemType</i>)]</var></th>		<tr><th nowrap="true"><var>[%(Arraylist Of </var>itemType<var>)]</var></th>
	<td>~~For a shared function, the~~ optional class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>		<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>
	<tr><th>itemList</th>		<tr><th>itemList</th>
	<td>A comma-delimited set of values or variables of the same type as specified on the <var class="term">al</var> declaration or collections of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>. The ability to include a collections in <var class="term">itemList</var> was added in Sirius Mods 7.9.</td></tr>		<td>A comma-delimited set of values or variables of the same type as specified on the <var class="term">al</var> declaration or collections of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>. The ability to include a collections in <var class="term">itemList</var> was added in Sirius Mods 7.9.</td></tr>

JAL2: /* Syntax terms */

2011-08-23T01:49:25Z

Syntax terms

← Older revision		Revision as of 01:49, 23 August 2011
Line 9:		Line 9:
	<td>A declared or existing <var>Arraylist</var> object. </td></tr>		<td>A declared or existing <var>Arraylist</var> object. </td></tr>
	<tr><th nowrap="true"><var>[%(Arraylist Of <i>itemType</i>)]</var></th>		<tr><th nowrap="true"><var>[%(Arraylist Of <i>itemType</i>)]</var></th>
	<td>~~The~~ optional class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>		<td>For a shared function, the optional class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>
	<tr><th>itemList</th>		<tr><th>itemList</th>
	<td>A comma-delimited set of values or variables of the same type as specified on the <var class="term">al</var> declaration or collections of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>. The ability to include a collections in <var class="term">itemList</var> was added in Sirius Mods 7.9.</td></tr>		<td>A comma-delimited set of values or variables of the same type as specified on the <var class="term">al</var> declaration or collections of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>. The ability to include a collections in <var class="term">itemList</var> was added in Sirius Mods 7.9.</td></tr>

JAL2: /* Syntax terms */

2011-08-22T21:29:29Z

Syntax terms

← Older revision		Revision as of 21:29, 22 August 2011
Line 8:		Line 8:
	<tr><th>%newlist</th>		<tr><th>%newlist</th>
	<td>A declared or existing <var>Arraylist</var> object. </td></tr>		<td>A declared or existing <var>Arraylist</var> object. </td></tr>
	<tr><th nowrap="true"><var>[%(Arraylist of <i>itemType</i>)]</var></th>		<tr><th nowrap="true"><var>[%(Arraylist Of <i>itemType</i>)]</var></th>
	<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>		<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>
	<tr><th>itemList</th>		<tr><th>itemList</th>

JAL2: /* Usage notes */

2011-08-22T21:08:59Z

Usage notes

← Older revision		Revision as of 21:08, 22 August 2011
Line 15:		Line 15:

	==Usage notes==		==Usage notes==
	<ul>~~<li>For more information about factory methods, see <var>[[Object variables#Virtual Constructor methods\|Virtual Constructor methods]]</var>.~~		<ul>
	~~<li>The maximum number of <var class="term">items</var> values is 62.~~		<li><var>List</var> is a virtual constructor and as such can be called with no method object, with an explicit class name, or with an object variable, even if that object is null:
	<li><var>List</var> is a constructor and as such can be called with no method object, with an explicit class name, or with an object variable, even if that object is null:
	<p class="code">%al = List(<var class="term">items</var>)		<p class="code">%al = List(<var class="term">items</var>)
	%al = %(Arraylist):List(<var class="term">items</var>)
			%al = %(Arraylist of float):List(<var class="term">items</var>)

	%al = %al:List(<var class="term">items</var>)		%al = %al:List(<var class="term">items</var>)
	</p>		</p>
	<b~~><i~~>Note: ~~</i>~~</b>~~If using the second of these syntax options~~, ~~which~~ explicitly ~~indicates~~ the class, both the collection and item ~~datatypes~~ must be specified ~~exactly~~ as they are on the collection variable's declaration:		<b>Note: </b>
			As shown above, when explicitly indicating the
			class, both the collection and the item datatype must be
			specified just as they are on the collection variable's declaration:
	<p class="code">%al is collection Arraylist of longstring		<p class="code">%al is collection Arraylist of longstring
	%al = %(Arraylist of longstring):List('Jack', 'and', 'Jill')		%al = %(Arraylist of longstring):List('Jack', 'and', 'Jill')
	</p>		</p>
			<li>The maximum number of <var class="term">items</var> values is 62.
	<li>You can also use the <var>List</var> method in contexts where an <var>Arraylist</var> object is a method parameter.		<li>You can also use the <var>List</var> method in contexts where an <var>Arraylist</var> object is a method parameter.
	<li><var>List</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.		<li><var>List</var> is available in <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.3 and later.

JAL2: /* Syntax terms */

2011-08-22T21:01:57Z

Syntax terms

← Older revision		Revision as of 21:01, 22 August 2011
Line 9:		Line 9:
	<td>A declared or existing <var>Arraylist</var> object. </td></tr>		<td>A declared or existing <var>Arraylist</var> object. </td></tr>
	<tr><th nowrap="true"><var>[%(Arraylist of <i>itemType</i>)]</var></th>		<tr><th nowrap="true"><var>[%(Arraylist of <i>itemType</i>)]</var></th>
	<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|virtual constructor]] method. ~~<var>List</var> can also be invoked via an <var>Arraylist</var> object variable~~, ~~which may be null~~.</td></tr>		<td>The optional class name in parentheses denotes a [[Notation conventions for methods#Shared methods and constructors\|virtual constructor]] method. See "Usage notes," below, for more information about invoking a collection constructor.</td></tr>
	<tr><th>itemList</th>		<tr><th>itemList</th>
	<td>A comma-delimited set of values or variables of the same type as specified on the <var class="term">al</var> declaration or collections of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>. The ability to include a collections in <var class="term">itemList</var> was added in Sirius Mods 7.9.</td></tr>		<td>A comma-delimited set of values or variables of the same type as specified on the <var class="term">al</var> declaration or collections of objects of the same type as specified on the <var class="term">al</var> declaration. Each of these, from left to right, becomes an item or items in the resultant new <var>Arraylist</var>, <var class="term">al</var>. The ability to include a collections in <var class="term">itemList</var> was added in Sirius Mods 7.9.</td></tr>