net.rim.device.api.collection.util
Class LongHashtableCollection

java.lang.Object
  |
  +--net.rim.device.api.collection.util.LongHashtableCollection
All Implemented Interfaces:
Collection, Persistable, ReadableLongMap, ReadableSet, WritableLongMap

public final class LongHashtableCollection
extends Object
implements Persistable, ReadableSet, ReadableLongMap, WritableLongMap

Hashtable collection using long integeres as keys.

With this collection write operations occur as a map; read operations occur as a map or as a set.


Constructor Summary
LongHashtableCollection()
          Constructs a new LongHashTableCollection instance.
 
Method Summary
 boolean contains(long key)
          Determines if this collection contains an element with provided long integer key.
 boolean contains(Object element)
          Determines if this collection contains an element.
 Object get(long key)
          Retrieves element by lnog integer key.
 Enumeration getElements()
          Retrieves an enumeration of this collection's elements.
 int getElements(Object[] elements)
          Retrieves this collection's elements.
 long getKey(Object element)
          Retrieves long integer key by element.
 LongEnumeration getKeys()
          Retrieves an enumeration of this collection's keys.
 void put(long key, Object element)
          Assigns a key to an element, and places it in the collection.
 void remove(long key)
          Removes element by key.
 void removeAll()
          Removes all elements.
 int size()
          Retrieves the number of elements in this collection.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LongHashtableCollection

public LongHashtableCollection()
Constructs a new LongHashTableCollection instance.
Method Detail

contains

public boolean contains(long key)
Determines if this collection contains an element with provided long 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.

contains

public boolean contains(Object element)
Determines if this collection contains an element.

Parameters:
obj - Element to look for.
Returns:
True if this collection contains the element; otherwise, false.

get

public Object get(long key)
Retrieves element by lnog integer key.

Parameters:
uid - Key for desired element.

getElements

public Enumeration getElements()
Retrieves an enumeration of this collection's elements.

Returns:
Enumeration of this collection's elements.

getElements

public 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 colection, invoke 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 this collection's elements.
Returns:
Number of elements actually retrieved.

getKey

public long getKey(Object element)
Retrieves long integer key by element.

Parameters:
obj - Element for which you want the key.
Returns:
Key associated with your element, or -1 if no such element exists in this colleciton (and thus has no key).

getKeys

public LongEnumeration getKeys()
Retrieves an enumeration of this collection's keys.

Returns:
Enumeration of this collection's keys.
Since:
JDE 4.0.0

put

public void put(long key,
                Object element)
Assigns a key to an element, and places it in the collection.

Parameters:
key - Long integer key for new element.
element - New element to add to collection.

remove

public void remove(long key)
Removes element by key.

Parameters:
key - Key associated with element you want to retrieve.

removeAll

public void removeAll()
Removes all elements.


size

public int size()
Retrieves the number of elements in this collection.

Returns:
Number of elements in this collection.



Copyright 1999-2008 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark or registered trademark of Sun Microsystems, Inc. in the US and other countries.