Generic ArrayList class for managing lists of items and iterating operations over them. The targeted use for this class is for augmentation onto a class that is responsible for managing multiple instances of another class (e.g. NodeList for Nodes). The recommended use is to augment your class with ArrayList, then use ArrayList.addMethod to mirror the API of the constituent items on the list's API.
The default implementation creates immutable lists, but mutability can be provided via the arraylist-add submodule or by implementing mutation methods directly on the augmented class's prototype.
_itemi
Protected method for optimizations that may be appropriate for API
mirroring. Similar in functionality to item, but is used by
methods added with ArrayList.addMethod().
i
Integer
Index of item to fetch
The item appropriate for pass through API methods
additem
index
Add a single item to the ArrayList. Does not prevent duplicates.
item
Mixed
Item presumably of the same type as others in the ArrayList.
index
Number
(Optional.) Number representing the position at which the item should be inserted.
the instance.
addMethoddest
name
Adds a pass through method to dest (typically the prototype of a list class) that calls the named method on each item in the list with whatever parameters are passed in. Allows for API indirection via list instances.
Accepts a single string name or an array of string names.
list.each( function ( item ) {
item.methodName( 1, 2, 3 );
} );
// becomes
list.methodName( 1, 2, 3 );Additionally, the pass through methods use the item retrieved by the
_item method in case there is any special behavior that is
appropriate for API mirroring.
If the iterated method returns a value, the return value from the added method will be an array of values with each value being at the corresponding index for that item. If the iterated method does not return a value, the added method will be chainable.
eachfn
context
Execute a function on each item of the list, optionally providing a custom execution context. Default context is the item.
The callback signature is callback( item, index ).
fn
Function
the function to execute
context
Mixed
optional override 'this' in the function
this instance
filtervalidator
Create a new ArrayList (or augmenting class instance) from a subset of items as determined by the boolean function passed as the argument. The original ArrayList is unchanged.
The validator signature is validator( item ).
validator
Function
Boolean function to determine in or out.
New instance based on who passed the validator.
indexOfneedle
Finds the first index of the needle in the managed array of items.
needle
Mixed
The item to search for
Array index if found. Otherwise -1
isEmptyIs this instance managing any items?
true if 1 or more items are being managed
itemi
Get an item by index from the list. Override this method if managing a list of objects that have a different public representation (e.g. Node instances vs DOM nodes). The iteration methods that accept a user function will use this method for access list items for operation.
i
Integer
index to fetch
the item at the requested index
itemsAreEquala
b
Default comparator for items stored in this list. Used by remove().
a
Mixed
item to test equivalence with.
b
Mixed
other item to test equivalance.
true if items are deemed equivalent.
removeneedle
all
comparator
Removes first or all occurrences of an item to the ArrayList. If a comparator is not provided, uses itemsAreEqual method to determine matches.
the instance.
sizeHow many items are in this list?
Number of items in the list
somefn
context
Execute a function on each item of the list, optionally providing a custom execution context. Default context is the item.
The callback signature is callback( item, index ).
Unlike each, if the callback returns true, the
iteration will stop.
fn
Function
the function to execute
context
Mixed
optional override 'this' in the function
True if the function returned true on an item