|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.util.Dictionary | +--java.util.Hashtable | +--com.ibm.etill.framework.payapi.ParameterTable
ParameterTable objects map keys to values where any non-null object can be a key and any object can be a value. ParameterTable is a highfalutin version of Hashtable by allowing a null to be inserted as a value into the table.
To successfully store and retrieve value objects from a ParameterTable, key objects must
implement the hashCode
method and the equals
method.
Hashtable
, Serialized FormInner classes inherited from class java.util.Map |
---|
Map.Entry |
Constructor Summary | |
---|---|
ParameterTable()
This Constructor should be called when an empty ParameterTable is to be instantiated. |
|
ParameterTable(Hashtable parameterTable)
This Constructor should be called when an ParameterTable is to be initialized with a given Hashtable object when instantiated. |
Method Summary | |
---|---|
Object |
clone()
Creates a copy of this ParameterTable. |
boolean |
contains(Object value)
Tests if some key maps into the specified value in this parameter table. |
Enumeration |
elements()
If this method is called, an exception will be thrown. |
Object |
get(Object key)
Returns the value entry that is paired with the given key entry or returns null when the key is not found. |
Object |
get(Object key,
Object defaultReturnValue)
Returns the value entry that is paired with the given key entry or returns the defaultReturnValue when the key is not found. |
Object |
put(Object key,
Object value)
Inserts a given key/value pair into the table and returns the key's previous value or a null if the key was not previously inserted. |
Object |
put(Object key,
Object value,
Object defaultReturnValue)
Inserts a given key/value pair into the table and returns the key's previous value or the defaultReturnValue if the key was not previously inserted. |
Object |
remove(Object key)
Deletes a key/value pair by searching for a given key. |
Object |
remove(Object key,
Object defaultReturnValue)
Deletes a key/value pair by searching for a given key. |
Methods inherited from class java.util.Hashtable |
---|
clear, containsKey, containsValue, entrySet, equals, hashCode, isEmpty, keys, keySet, putAll, size, toString, values |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ParameterTable()
public ParameterTable(Hashtable parameterTable)
parameterTable
- a Hashtable object to initialize this ParameterTableMethod Detail |
public Enumeration elements()
elements
in class Hashtable
public Object clone()
clone
in class Hashtable
public Object get(Object key, Object defaultReturnValue)
key
- index to the value object that the caller wantsdefaultReturnValue
- if the key is not found in the table, this will be returned to the callerpublic Object get(Object key)
get
in class Hashtable
key
- index to the value object that the caller wantspublic Object remove(Object key, Object defaultReturnValue)
key
- index to the value object that the caller wants to removedefaultReturnValue
- if the key is not found in the table, this will be returned to the callerpublic Object remove(Object key)
remove
in class Hashtable
key
- index to the value object that the caller wants to removepublic boolean contains(Object value)
contains
in class Hashtable
key
- object to search forpublic Object put(Object key, Object value, Object defaultReturnValue)
key
- the parametertable key/indexvalue
- the value to be set with this keydefaultReturnValue
- object returned if the given key was not previously inserted into the tablepublic Object put(Object key, Object value)
put
in class Hashtable
key
- the ParameterTable key (index)value
- the value to be set with this key
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |