ArrayList (JanosRuntime JavaDOC)

java.lang.Object
- java.util.ArrayList<E>

Type Parameters:: E - Type

All Implemented Interfaces:: Cloneable, Iterable<E>

public class ArrayList<E>
extends Object
implements Iterable<E>, Cloneable

Constructor Summary

Constructors
Constructor and Description
`ArrayList()` Constructor creates a default empty array list.
`ArrayList(int capacity)` Constructor to create an array list of some initial size
`ArrayList(Object[] arr)` Constructor creates an array list from an existing basic array.
`ArrayList(Object[] arr, int ofs, int len)` Constructor creates an array list from a portion of an existing array.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(E item)` Adds the item to the end of the array list.
`void`	`add(int index, E item)` Inserts the supplied item at the specified position.
`int`	`capacity()` Returns the current capacity of the array list and not the count of elements.
`void`	`clear()` Clears the array list.
`Object`	`clone()` Clones the array list.
`boolean`	`contains(Object item)` Indicates whether or not the item exists in the array list.
`void`	`ensureCapacity(int cnt)` Ensures that the array list has enough capacity.
`void`	`fill(int index, int cnt, E item)` Stores the provided item in a range of the array list.
`E`	`get(int index)` Obtain the element at the provided index.
`int`	`indexOf(Object item)` Returns the index of the first matching item.
`int`	`indexOf(Object item, int index)` Returns the the index of the first matching item located at or after the supplied index.
`Iterator<E>`	`iterator()` Basic requirement to make this class work with for-each.
`int`	`lastIndexOf(Object item)` Returns the last occurrence of the supplied item.
`int`	`lastindexOf(Object item, int index)` Returns the last occurrence of the supplied item up to and including the supplied index.
`E`	`remove(int index)` Removes the item at the specified index.
`boolean`	`remove(Object item)` Removes the first occurrence of an item.
`E`	`set(int index, E item)` Stores a new item at the specified index.
`void`	`setSize(int cnt)` Forces the internal array to a specific size.
`int`	`size()` Returns the count of elements stored in the array list.
`Object[]`	`toArray()` Obtains a copy of the array list.
`void`	`trimToSize()` Trims the array list to fit only the existing data.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ArrayList
```
public ArrayList()
```
    Constructor creates a default empty array list.
  - ArrayList
```
public ArrayList(int capacity)
```
    Constructor to create an array list of some initial size
    
    Parameters:
    
    capacity -
  - ArrayList
```
public ArrayList(Object[] arr)
```
    Constructor creates an array list from an existing basic array. Makes a copy of the supplied array.
    
    Parameters:
    
    arr - existing basic array.
  - ArrayList
```
public ArrayList(Object[] arr,
                 int ofs,
                 int len)
```
    Constructor creates an array list from a portion of an existing array.
    
    Parameters:
    
    arr - existing basic array
    
    ofs - offset into the array
    
    len - length of new array list
- Method Detail
  - clone
```
public Object clone()
```
    Clones the array list.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    new ArrayList object
    
    See Also:
    
    Cloneable
  - size
```
public int size()
```
    Returns the count of elements stored in the array list.
    
    Returns:
    
    number of elements
  - clear
```
public void clear()
```
    Clears the array list. It will be empty.
  - toArray
```
public Object[] toArray()
```
    Obtains a copy of the array list.
    
    Returns:
    
    new basic array containing the array list contents
  - get
```
public E get(int index)
```
    Obtain the element at the provided index.
    
    Parameters:
    
    index - object in the array list to return
    
    Returns:
    
    the object at the specified position
  - fill
```
public void fill(int index,
                 int cnt,
                 E item)
```
    Stores the provided item in a range of the array list. The array list is expanded as needed.
    
    Parameters:
    
    index - staring index for the fill
    
    cnt - total number of item references to store
    
    item - the item to be stored
  - set
```
public E set(int index,
             E item)
```
    Stores a new item at the specified index. The array list is expanded as needed.
    
    Parameters:
    
    index - position to update
    
    item - the item to be stored
    
    Returns:
    
    the prior content of the specified location
  - add
```
public boolean add(E item)
```
    Adds the item to the end of the array list.
    
    Parameters:
    
    item - item to be appended
    
    Returns:
    
    true if successful
  - add
```
public void add(int index,
                E item)
```
    Inserts the supplied item at the specified position.
    
    Parameters:
    
    index - position of insertion
    
    item - item to be stored
  - remove
```
public E remove(int index)
```
    Removes the item at the specified index.
    
    Parameters:
    
    index - position of item to remove
    
    Returns:
    
    the removed item
  - remove
```
public boolean remove(Object item)
```
    Removes the first occurrence of an item.
    
    Parameters:
    
    item - item to be removed
    
    Returns:
    
    true if the item was detected and removed.
  - capacity
```
public int capacity()
```
    Returns the current capacity of the array list and not the count of elements.
    
    Returns:
    
    size of the internal array
  - ensureCapacity
```
public void ensureCapacity(int cnt)
```
    Ensures that the array list has enough capacity.
    
    Parameters:
    
    cnt - requested new size for the array list
  - trimToSize
```
public void trimToSize()
```
    Trims the array list to fit only the existing data. This can be used to save memory.
  - setSize
```
public void setSize(int cnt)
```
    Forces the internal array to a specific size. If this will truncate data if less than the current element count.
    
    Parameters:
    
    cnt - desired size.
  - contains
```
public boolean contains(Object item)
```
    Indicates whether or not the item exists in the array list.
    
    Parameters:
    
    item - the item to look for
    
    Returns:
    
    true if the item exists.
  - indexOf
```
public int indexOf(Object item)
```
    Returns the index of the first matching item.
    
    Parameters:
    
    item - to be matched
    
    Returns:
    
    index of the item or -1 if not found
  - indexOf
```
public int indexOf(Object item,
                   int index)
```
    Returns the the index of the first matching item located at or after the supplied index.
    
    Parameters:
    
    item - to be matched
    
    index - starting point
    
    Returns:
    
    index of the located item or -1 otherwise
  - lastIndexOf
```
public int lastIndexOf(Object item)
```
    Returns the last occurrence of the supplied item.
    
    Parameters:
    
    item - item to search for
    
    Returns:
    
    last position it can be found or -1 otherwise
  - lastindexOf
```
public int lastindexOf(Object item,
                       int index)
```
    Returns the last occurrence of the supplied item up to and including the supplied index.
    
    Parameters:
    
    item - item to search for
    
    index - the position to search back from (inclusive)
    
    Returns:
    
    the index of the item if it exists in the array list at or prior to the supplied index
  - iterator
```
public Iterator<E> iterator()
```
    Basic requirement to make this class work with for-each.
    
    Specified by:
    
    iterator in interface Iterable<E>
    
    Returns:

Class ArrayList<E>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ArrayList

ArrayList

ArrayList

ArrayList

Method Detail

clone

size

clear

toArray

get

fill

set

add

add

remove

remove

capacity

ensureCapacity

trimToSize

setSize

contains

indexOf

indexOf

lastIndexOf

lastindexOf

iterator