Nitido Inc.

com.nitido.util
Class OpenAttributeHash

java.lang.Object
  extended by com.nitido.util.OpenAttributeHash
All Implemented Interfaces:
java.io.Serializable

public class OpenAttributeHash
extends java.lang.Object
implements java.io.Serializable

An open implementation of a hashtable where all contents are serializable and all of the keys are String objects.

See Also:
Serialized Form

Constructor Summary
OpenAttributeHash()
          Constructs a new, empty OpenAttributeHash
OpenAttributeHash(java.util.Hashtable hash)
          Constructs a new OpenAttributeHash, copying the contents of the passed in Hashtable object into the OpenAttributeHash.
OpenAttributeHash(OpenHash hash)
          Constructs a new OpenAttributeHash, copying the contents of the passed in OpenHash object into the OpenAttributeHash.
 
Method Summary
 void clear()
          This method removes all entries from the hashtable.
 boolean containsKey(java.lang.String key)
          Returns true if this OpenAttributeHash contains a key equal to the one passed in.
 boolean containsValue(java.io.Serializable value)
          Returns true if this OpenAttributeHash contains the given value
 boolean containsValue(java.lang.String key, java.io.Serializable value)
          Returns true if this OpenAttributeHash contains the given value with the given key
 java.io.Serializable get(java.lang.String key)
          This method retrieves the first value which corresponds to the key given, or null if no value is mapped to that key.
 java.util.Enumeration getKeys()
          Returns an Enumeration of all of the keys in this OpenAttributeHash
 java.util.Enumeration getValues(java.lang.String key)
          Returns an enumeration of values for the given key.
 java.util.Enumeration keys()
          Convenience alias to getKeys() for Hashtable users.
static void main(java.lang.String[] args)
          This method is provided as a test harness for this class
 void put(java.lang.String key, java.io.Serializable value)
          This method maps a key to a value in the hashtable.
 java.util.Vector remove(java.lang.String key)
          Removes all the values that are associated with the given key.
 java.io.Serializable remove(java.lang.String key, java.io.Serializable value)
          Removes the key/value pair specified.
 int size()
          Returns the number of keys in this OpenAttributeHash
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

OpenAttributeHash

public OpenAttributeHash()
Constructs a new, empty OpenAttributeHash


OpenAttributeHash

public OpenAttributeHash(java.util.Hashtable hash)
Constructs a new OpenAttributeHash, copying the contents of the passed in Hashtable object into the OpenAttributeHash. Any items that are in the Hashtable that are not Serializable will be ignored.

Parameters:
hash - The Hashtable whose contents are copied into this OpenAttributeHash

OpenAttributeHash

public OpenAttributeHash(OpenHash hash)
Constructs a new OpenAttributeHash, copying the contents of the passed in OpenHash object into the OpenAttributeHash. Any items that are in the OpenHash that are not Serializable will be ignored.

Parameters:
hash - The Hashtable whose contents are copied into this OpenAttributeHash
Method Detail

get

public java.io.Serializable get(java.lang.String key)
This method retrieves the first value which corresponds to the key given, or null if no value is mapped to that key.

Parameters:
key - A key in the hashtable
Returns:
The first mapping or null if there is none.

getKeys

public java.util.Enumeration getKeys()
Returns an Enumeration of all of the keys in this OpenAttributeHash

Returns:
Returns an Enumeration of all of the keys in this OpenAttributeHash

keys

public java.util.Enumeration keys()
Convenience alias to getKeys() for Hashtable users.


getValues

public java.util.Enumeration getValues(java.lang.String key)
Returns an enumeration of values for the given key.

Parameters:
key - A key in the hashtable
Returns:
An enumeration of the values for the key.

containsValue

public boolean containsValue(java.io.Serializable value)
Returns true if this OpenAttributeHash contains the given value

Parameters:
value - The value to check for in this OpenAttributeHash.
Returns:
True if the value is found in the OpenAttributeHash, otherwise false.

containsValue

public boolean containsValue(java.lang.String key,
                             java.io.Serializable value)
Returns true if this OpenAttributeHash contains the given value with the given key

Parameters:
key - The key to search for in this OpenAttributeHash.
value - The value to search for in this OpenAttributeHash.
Returns:
Returns true if the key/value pair is found, otherwise returns false.

containsKey

public boolean containsKey(java.lang.String key)
Returns true if this OpenAttributeHash contains a key equal to the one passed in.

Parameters:
key - The key to check.
Returns:
True if the key is found, false otherwise.

size

public int size()
Returns the number of keys in this OpenAttributeHash

Returns:
The number of keys in this OpenAttributeHash

put

public void put(java.lang.String key,
                java.io.Serializable value)
This method maps a key to a value in the hashtable.

Parameters:
key - The object to be used as a key in the mapping
value - The object which the key is being mapped to.

remove

public java.util.Vector remove(java.lang.String key)
Removes all the values that are associated with the given key.

Parameters:
key - the key to be removed
Returns:
A Vector containing the objects removed from this OpenAttributeHash, or null if there was no such key

remove

public java.io.Serializable remove(java.lang.String key,
                                   java.io.Serializable value)
Removes the key/value pair specified.

Parameters:
key - The key in the key/value pair to remove.
value - The value in the key/value pair to remove.
Returns:
The element removed, or null if no matching key/value pair was found.

clear

public void clear()
This method removes all entries from the hashtable.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

main

public static void main(java.lang.String[] args)
This method is provided as a test harness for this class

Parameters:
args - Command line arguments are ignored.

Nitido NiM 2.5 Java API

These JavaDoc pages are generated for release/nim_2_5-2.5.44

Copyright © 1999-2009 Nitido Inc.    Proprietary and Confidential.    All Rights Reserved.