List (Arraylist function)

Construct and populate a new Arraylist (Arraylist class)

List is a member of the Arraylist class.

This shared function is a virtual constructor, or factory method, for Arraylists. The List method invokes the creation of a new Arraylist instance, then populates that instance with items that are, respectively, the values of the method arguments.

List is available in Sirius Mods version 7.3 and later.

Syntax

%newList = [%(Arraylist Of itemType):]List( itemList)

Syntax terms

al	A declared or existing Arraylist object.
itemlist	A comma-delimited set of values or variables of the same type as specified on the al declaration. Each of these, from left to right, becomes an item in the resultant new Arraylist, al.

Usage notes

• For more information about factory methods, see ?? refid=vconst..
• The maximum number of itemlist values is 62.
• List 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:

      <var class="term">al</var> = <var>List</var>(&'italic(itemlist))
      <var class="term">al</var> = %(<var>Arraylist</var>):<var>List</var>(&'italic(itemlist))
      <var class="term">al</var> = <var class="term">al</var>:<var>List</var>(&'italic(itemlist))
  

  note

  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:

      <var class="term">al</var>  is collection <var>Arraylist</var> of longstring
      <var class="term">al</var>  = %(<var>Arraylist</var> of longstring):<var>List</var>(&'italic(itemlist))
  

• You can also use the List method in contexts where an Arraylist object is a method parameter.

Examples

• The following List method call creates a new Arraylist instance of 11 integer items that begins with 1 and whose subsequent items are, respectively, the sum of the preceding two integers:

      %fib    is collection arraylist of float
      %fib = list(1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89)
  

• The following List call creates a new Arraylist instance whose items are objects of user class Freight:

      class freight
        public
           variable a is float
           variable b is float
           constructor newf(%a is float, %b is float)
        end public
         ...
      end class
         ...
      %ark is arraylist of object freight
      %ark = list(newf(11, 14), newf(4, 6), newf(9, 77),   -
                  newf(-7, 1234))