com.portal.pcm

Class AssocArray

java.lang.Object

com.portal.pcm.AssocArray

Direct Known Subclasses:

SparseArray

public class AssocArray
extends java.lang.Object

The AssocArray (or Associative Array)

Version:

1.0 1/5/98

Author:

Larry Lynch-Freshner

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AssocArray.Pair
class	AssocArray.PairEnumeration

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Vector<java.lang.Integer>	keys
protected java.util.Vector<FList>	values

Constructor Summary

Constructors

Constructor and Description
AssocArray() Constructs an Associative Array.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all keys and values from the array.
boolean	containsKey(java.lang.Object key) Returns true if the array contains the value of a specific key.
java.util.Enumeration<FList>	elements() Get an enumeration of values.
java.lang.Object	get(java.lang.Object key) Returns a value from the array given its associative key.
AssocArray.PairEnumeration	getPairs()
boolean	isEmpty() Returns true if the array is empty.
java.util.Enumeration<java.lang.Integer>	keys() Get an enumeration of keys.
java.lang.Object	put(java.lang.Integer key, FList value) Adds a key:value association to the array.
java.lang.Object	remove(java.lang.Object key) Removes the first instance of key and its associated value.
int	size() Returns the number of keys in the associative array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

keys

protected java.util.Vector<java.lang.Integer> keys

values

protected java.util.Vector<FList> values

Constructor Detail

AssocArray

public AssocArray()

Constructs an Associative Array.

Method Detail

elements

public java.util.Enumeration<FList> elements()

Get an enumeration of values.

Returns:

an Enumeration object for the array values.

get

public java.lang.Object get(java.lang.Object key)

Returns a value from the array given its associative key. If multiple identical keys exist, returns first instance.

Parameters:

key - - Key object associated with value to lookup.

Returns:

the value object associated with key.

isEmpty

public boolean isEmpty()

Returns true if the array is empty.

keys

public java.util.Enumeration<java.lang.Integer> keys()

Get an enumeration of keys.

Returns:

an Enumeration object for the array keys.

put

public java.lang.Object put(java.lang.Integer key,
                            FList value)
                     throws java.lang.NullPointerException

Adds a key:value association to the array.

Parameters:

key - New associative key.

value - New value to associate with key.

Returns:

If key was present already, returns old value object.

Throws:

java.lang.NullPointerException - is thrown if value is null.

remove

public java.lang.Object remove(java.lang.Object key)

Removes the first instance of key and its associated value.

Parameters:

key - the key to remove.

Returns:

The value associated with key.

size

public int size()

Returns the number of keys in the associative array.

Returns:

The number of keys stored in the array.

clear

public void clear()

Removes all keys and values from the array.

containsKey

public boolean containsKey(java.lang.Object key)

Returns true if the array contains the value of a specific key.

Parameters:

key - Key to look for.

Returns:

true if key exists in array.

getPairs

public AssocArray.PairEnumeration getPairs()