org.PingOO.DLAI.lib.util
Class ValueHashtable

java.lang.Object
  |
  +--org.PingOO.DLAI.lib.util.ValueHashtable

public final class ValueHashtable

extends java.lang.Object

This hashtable is derived from the basic Hashtable, so it can be used with only String keys and can only contain String or ValueHashtable values.

Since:

PingOO 2.0

Version:

2.0

Author:

Fabrice Bouyé (bouye@cur-archamps.fr)

See Also:

Hashtable

Field Summary

private java.util.Hashtable

hashtable A private inner Hashtable to which the job is delegated.

Constructor Summary

ValueHashtable()
Creates a new ValueHashtable for the given module and the given function.

Method Summary

void	clear() Clears this hashtable so that it contains no keys.
java.lang.Object	clone() Get a copy of this object.
boolean	contains(java.lang.Object value) Tests if some key maps into the specified value in this hashtable.
boolean	containsKey(java.lang.String key) Tests if the specified object is a key in this hashtable.
boolean	containsValue(java.lang.Object value) Returns true if this Hashtable maps one or more keys to this value.
java.util.Enumeration	elements() Returns an enumeration of the values in this hashtable.
java.lang.Object	get(java.lang.String key) Returns the value to which the specified key is mapped in this hashtable.
boolean	isEmpty() Tests if this hashtable maps no keys to values.
java.util.Enumeration	keys() Returns an enumeration of the keys in this hashtable.
java.lang.Object	put(java.lang.String key, java.lang.String value) Maps the specified key to the specified value in this hashtable.
java.lang.Object	put(java.lang.String key, ValueHashtable value) Maps the specified key to the specified value in this hashtable.
java.lang.Object	remove(java.lang.String key) Removes the key (and its corresponding value) from this hashtable.
int	size() Returns the number of keys in this hashtable.
java.lang.String	toString() Returns a String representation of this MessageHashtable and of the included values.

Methods inherited from class java.lang.Object

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

Field Detail

hashtable

private final java.util.Hashtable hashtable

A private inner Hashtable to which the job is delegated.

Constructor Detail

ValueHashtable

public ValueHashtable()

Creates a new ValueHashtable for the given module and the given function.
Cannot be sent directly to the server.

Method Detail

clear

public final void clear()

Clears this hashtable so that it contains no keys.

contains

public final boolean contains(java.lang.Object value)
                       throws java.lang.NullPointerException

Tests if some key maps into the specified value in this hashtable.

Returns:

true if and only if some key maps to the value argument in this hashtable as determined by the equals method; false otherwise.

Throws:

java.lang.NullPointerException - If the value is null.

containsKey

public final boolean containsKey(java.lang.String key)

Tests if the specified object is a key in this hashtable.

Returns:

true if and only if the specified object is a key in this hashtable, as determined by the equals method; false otherwise.

containsValue

public final boolean containsValue(java.lang.Object value)

Returns true if this Hashtable maps one or more keys to this value.

Returns:

true if and only if some key maps to the value argument in this hashtable as determined by the equals method; false otherwise.

elements

public final java.util.Enumeration elements()

Returns an enumeration of the values in this hashtable.

Returns:

An enumeration of the values in this hashtable.

get

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

Returns the value to which the specified key is mapped in this hashtable.

Returns:

The value to which the key is mapped in this hashtable; null if the key is not mapped to any value in this hashtable.

isEmpty

public final boolean isEmpty()

Tests if this hashtable maps no keys to values.

Returns:

true if this hashtable maps no keys to values; false otherwise.

keys

public final java.util.Enumeration keys()

Returns an enumeration of the keys in this hashtable.

Returns:

An enumeration of the keys in this hashtable.

put

public final java.lang.Object put(java.lang.String key,
                                  java.lang.String value)
                           throws java.lang.NullPointerException

Maps the specified key to the specified value in this hashtable. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters:

key - The hashtable key.

value - The String value.

Returns:

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

Throws:

java.lang.NullPointerException - If the key or value is null.

put

public final java.lang.Object put(java.lang.String key,
                                  ValueHashtable value)
                           throws java.lang.NullPointerException

Maps the specified key to the specified value in this hashtable. Neither the key nor the value can be null.

The value can be retrieved by calling the get method with a key that is equal to the original key.

Parameters:

key - The hashtable key.

value - The ValueHashtable value.

Returns:

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

Throws:

java.lang.NullPointerException - If the key or value is null.

remove

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

Removes the key (and its corresponding value) from this hashtable. This method does nothing if the key is not in the hashtable.

Parameters:

key - the key that needs to be removed.

Returns:

The value to which the key had been mapped in this hashtable, or null if the key did not have a mapping.

size

public final int size()

Returns the number of keys in this hashtable.

Returns:

The number of keys in this hashtable.

clone

public java.lang.Object clone()

Get a copy of this object.

Returns:

A copy of this object.

Overrides:

clone in class java.lang.Object

toString

public final java.lang.String toString()

Returns a String representation of this MessageHashtable and of the included values.

Returns:

A String representation of this MessageHashtable and of the included values.

Overrides:

toString in class java.lang.Object