net.rim.device.api.collection
Interface ReadableSet

All Superinterfaces:

Collection

All Known Implementing Classes:

LongHashtableCollection, AutoText

public interface ReadableSet
extends Collection

Provides read access to a set-type collection.

Method Summary
boolean	contains(Object element) Determines if this collection contains an element.
Enumeration	getElements() Retrieves an enumeration of this collection's elements.
int	getElements(Object[] elements) Retrieves this collection's elements.
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.

contains

boolean contains(Object element)

Determines if this collection contains an element.

Parameters:

element - Element to look for.

Returns:

True if this collection contains the element; otherwise, false.

getElements

Enumeration getElements()

Retrieves an enumeration of this collection's elements.

Returns:

Enumeration of this collection's elements.

getElements

int getElements(Object[] elements)

Retrieves this collection's elements.

The array you provide to contain the collection's elements must be large enough to contain them. Accordingly, you should synchronize on this collection, invoke ReadableSet.size(), create an array of the required size, and then invoke this method. This ensures that the collection's size won't change by the time you get to actually retrieving its elements.

This method also completely erases the current contents of your object array out-parameter.

Parameters:

elements - Object array to contain returned elements; must be large enough to retrieve the collection's elements.

Returns:

Number of elements actually retrieved.