net.rim.device.api.collection
Interface ReadableIntMap

All Superinterfaces:

Collection

All Known Implementing Classes:

SparseList

public interface ReadableIntMap
extends Collection

Provides read access to a collection using integer values as element keys.

Method Summary
boolean	contains(int key) Determines if this collection contains an element with provided integer key.
Object	get(int key) Retrieves element by integer key.
int	getKey(Object element) Retrieves integer key 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 this collection.

get

Object get(int key)

Retrieves element by integer key.

Parameters:

key - Key for desired element.

Returns:

Element associated with the key, or null if no element associated with this key.

getKey

int getKey(Object element)

Retrieves integer key by element.

Note: This operation can be linear with respect to the number of entries in the table.

Parameters:

element - Element for which you want the key.

Returns:

Key associated with your element, or -1 if no such element exists in the collection (and thus has no key).

contains

boolean contains(int key)

Determines if this collection contains an element with provided integer key.

Parameters:

key - Key to locate in this collection.

Returns:

True if this key exists in this collection (has an associated element); otherwise, false.