net.rim.device.api.collection
Interface ReadableList

All Superinterfaces:

Collection

All Known Subinterfaces:

List, FilteredList

All Known Implementing Classes:

BasicFilteredList, BigSortedReadableList, BigUnsortedReadableList, IntSortedReadableList, LongSortedReadableList, ReadableListCombiner, SortedReadableList, UnsortedReadableList, MapDataModel

public interface ReadableList
extends Collection

Provides array-like read access to a collection of object elements.

Method Summary
Object	getAt(int index) Retrieves element by index.
int	getAt(int index, int count, Object[] elements, int destIndex) Retrieves range of elements starting at provided index.
int	getIndex(Object element) Retrieves index by element.
int	size() Retrieves the number of elements in this collection.

Method Detail

size

int size()

Retrieves the number of elements in this collection.

Returns:

Number of elements in the collection.

getAt

Object getAt(int index)

Retrieves element by index.

Parameters:

index - Index of the element to retrieve.

Returns:

Element at provided index.

Throws:

ArrayIndexOutOfBoundsException - If index parameter is not valid.

getAt

int getAt(int index,
          int count,
          Object[] elements,
          int destIndex)

Retrieves range of elements starting at provided index.

Parameters:

index - Index of first element to retrieve.

count - Number of elements to retrieve.

elements - Object array to contain returned elements; this array must have enough space to hold the number of elements you expect to receive.

destIndex - Index within destination array to contain the first element retrieved (the destination array must therefore be at least destIndex + count elements long).

Returns:

Number of elements actually retrieved.

Throws:

ArrayIndexOutOfBoundsException - If index parameter is not valid.

getIndex

int getIndex(Object element)

Retrieves index by element.

Note: this operation may be linear with respect to the number of elements in the list.

Parameters:

element - Element to locate.

Returns:

Index of provided element, or -1 if the element isn't contained in this collection.