org.freehep.util
Class DoubleHashtable

java.lang.Object
  java.util.AbstractCollection
      org.freehep.util.DoubleHashtable

All Implemented Interfaces:

Serializable, Iterable, Collection

public class DoubleHashtable
extends AbstractCollection
implements Serializable

Stores a hashtable of hashtables, which can be indexed by a key and a subkey. Keys and Values can be null.

Version:

$Id: DoubleHashtable.java 8584 2006-08-10 23:06:37Z duns $

Author:

Mark Donszelmann

See Also:

Serialized Form

Constructor Summary

DoubleHashtable()
creates a hashtable of hashtables

Method Summary

void	clear() removes all entries and sub-tables
void	clear(Object key) removes all entries from a subtable
Object	clone()
boolean	contains(Object value)
boolean	containsKey(Object key)
boolean	containsKey(Object key, Object subKey)
Enumeration	elements()
Hashtable	get(Object key)
Object	get(Object key, Object subKey)
boolean	isEmpty()
Iterator	iterator()
Enumeration	keys()
Enumeration	keys(Object key)
Object	put(Object key, Object subKey, Object value) puts a value in sub-table specified by key and subkey.
Object	remove(Object key, Object subKey) removes value from sub-table specified by key and subkey.
int	size()
String	toString()

Methods inherited from class java.util.AbstractCollection

add, addAll, containsAll, remove, removeAll, retainAll, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode

Constructor Detail

DoubleHashtable

public DoubleHashtable()

creates a hashtable of hashtables

Method Detail

clear

public void clear()

removes all entries and sub-tables

Specified by:

clear in interface Collection

Overrides:

clear in class AbstractCollection

clear

public void clear(Object key)

removes all entries from a subtable

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

contains

public boolean contains(Object value)

Specified by:

contains in interface Collection

Overrides:

contains in class AbstractCollection

Returns:

true if value exists in some sub-table

containsKey

public boolean containsKey(Object key)

Returns:

true if sub-table exists for key

containsKey

public boolean containsKey(Object key,
                           Object subKey)

Returns:

true if value exists for key and subkey

elements

public Enumeration elements()

Returns:

enumeration over all values in all sub-tables

iterator

public Iterator iterator()

Specified by:

iterator in interface Iterable

Specified by:

iterator in interface Collection

Specified by:

iterator in class AbstractCollection

Returns:

iterator over all values in all sub-tables

get

public Hashtable get(Object key)

Returns:

sub-table for key

get

public Object get(Object key,
                  Object subKey)

Returns:

value for key and subkey, null in non-existent or null value was stored

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection

Overrides:

isEmpty in class AbstractCollection

Returns:

true if table is empty

keys

public Enumeration keys()

Returns:

enumeration of keys in table

keys

public Enumeration keys(Object key)

Returns:

enumeration in subkeys of sub-table pointed by key, and empty if sub-table does not exist

put

public Object put(Object key,
                  Object subKey,
                  Object value)

puts a value in sub-table specified by key and subkey.

Returns:

previous value

remove

public Object remove(Object key,
                     Object subKey)

removes value from sub-table specified by key and subkey.

Returns:

previous value

size

public int size()

Specified by:

size in interface Collection

Specified by:

size in class AbstractCollection

Returns:

size of all tables

toString

public String toString()

Overrides:

toString in class AbstractCollection

Returns:

a string representation of the table