org.ceryle.util
Class VectorMap

java.lang.Object
  org.ceryle.util.VectorMap

All Implemented Interfaces:

Map

Direct Known Subclasses:

ColorLookupTable

public class VectorMap
extends Object
implements Map

VectorMap basically extends Vector to include a Map interface, as a Hashtable-like object with ordered elements (and by extension, a predictable, ordered iteration). The keys for the Hashtable are stored in a Vector in order to obtain ordering.

For more detailed information on each method, consult the documentation for Hashtable and Vector, the two classes from which this class draws.

Since:

JDK1.4

Version:

$Id: VectorMap.java,v 3.3 2007-06-15 12:09:57 altheim Exp $

Author:

Murray Altheim

See Also:

Hashtable, Map, Vector

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

protected Hashtable	m_map
protected Vector	m_vector

Constructor Summary

VectorMap()
Constructs an empty VectorMap.

Method Summary

void	clear() Removes all mappings from this map (optional operation).
boolean	containsKey(Object key) Returns true if this map contains a mapping for the specified key.
boolean	containsValue(Object value) Returns true if this map maps one or more keys to the specified value.
Set	entrySet() Returns a set view of the mappings contained in this map.
boolean	equals(Object o) Compares the specified object with this map for equality.
Object	get(Object key) Returns the value to which this map maps the specified key.
int	hashCode() Returns the hash code value for this map.
boolean	isEmpty() Returns true if this map contains no key-value mappings.
Collection	keys() Returns a Collection view of the keys contained in this map.
Set	keySet() Returns a set view of the keys contained in this map.
Object	put(Object key, Object value) Associates the specified value with the specified key in this map.
void	putAll(Map t) Copies all of the mappings from the specified map to this map (optional operation).
Object	remove(Object key) Removes the mapping for this key from this map if it is present.
int	size() Returns the number of key-value mappings in this map.
Collection	values() Returns a collection view of the values contained in this map.

Methods inherited from class java.lang.Object

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

Field Detail

m_vector

protected Vector m_vector

m_map

protected Hashtable m_map

Constructor Detail

VectorMap

public VectorMap()

Constructs an empty VectorMap.

Method Detail

clear

public void clear()

Removes all mappings from this map (optional operation).

Specified by:

clear in interface Map

containsKey

public boolean containsKey(Object key)

Returns true if this map contains a mapping for the specified key.

Specified by:

containsKey in interface Map

containsValue

public boolean containsValue(Object value)

Returns true if this map maps one or more keys to the specified value.

Specified by:

containsValue in interface Map

entrySet

public Set entrySet()

Returns a set view of the mappings contained in this map. This does not preserve iteration order.

Specified by:

entrySet in interface Map

equals

public boolean equals(Object o)

Compares the specified object with this map for equality.

Specified by:

equals in interface Map

Overrides:

equals in class Object

get

public Object get(Object key)

Returns the value to which this map maps the specified key.

Specified by:

get in interface Map

hashCode

public int hashCode()

Returns the hash code value for this map.

Specified by:

hashCode in interface Map

Overrides:

hashCode in class Object

isEmpty

public boolean isEmpty()

Returns true if this map contains no key-value mappings.

Specified by:

isEmpty in interface Map

keySet

public Set keySet()

Returns a set view of the keys contained in this map. This does not preserve iteration order. If this is desired, use keys().

Specified by:

keySet in interface Map

keys

public Collection keys()

Returns a Collection view of the keys contained in this map. This preserves iteration order, and is backed by the internal Vector.

put

public Object put(Object key,
                  Object value)

Associates the specified value with the specified key in this map. In terms of order, this places the new key at the end of the list.

Specified by:

put in interface Map

Returns:

the previous value of the specified key in this hashtable, or null if it did not have one.

putAll

public void putAll(Map t)

Copies all of the mappings from the specified map to this map (optional operation).

Unsupported Operation

Specified by:

putAll in interface Map

remove

public Object remove(Object key)

Removes the mapping for this key from this map if it is present.

Specified by:

remove in interface Map

size

public int size()

Returns the number of key-value mappings in this map.

Specified by:

size in interface Map

values

public Collection values()

Returns a collection view of the values contained in this map. This will be in the order maintained by the internal Vector.

Specified by:

values in interface Map