org.exolab.castor.mapping

Interface MapHandler

Known Implementing Classes:
J1MapHandler, J2MapHandler

public interface MapHandler

A Map handler for adding and retreiving key-value pairs from A map. A map handler is instantiated only once, must be thread safe and not use any synchronization.
Version:
$Revision: 1.1.1.1 $ $Date: 2003/03/03 07:08:26 $
Author:
Keith Visco

Method Summary

void
clear(Object map)
Clears the map of all key-value pairs.
Object
create()
Creates a new Instance of the map represented by this MapHandler.
Enumeration
elements(Object Map)
Returns an enumeration of all the objects in the Map.
Object
get(Object map, Object key)
Returns the object associated with the given key.
Enumeration
keys(Object Map)
Returns an enumeration of all the keys in the Map.
Object
put(Object map, Object key, Object object)
Adds the given key-value pair to the map.
int
size(Object map)
Returns the number of elements (key-value) in the map.

Method Details

clear

public void clear(Object map)
            throws ClassCastException
Clears the map of all key-value pairs.
Parameters:
map - the map to clear.

create

public Object create()
Creates a new Instance of the map represented by this MapHandler.
Returns:
the new map.

elements

public Enumeration elements(Object Map)
            throws ClassCastException
Returns an enumeration of all the objects in the Map.
Parameters:
Returns:
An enumeration of all the elements in the Map.

get

public Object get(Object map,
                  Object key)
            throws ClassCastException
Returns the object associated with the given key.
Parameters:
map - the map to return the object from.
key - the key for the object.
Returns:
the object associated with the given key, or null if no association was found in the given map.

keys

public Enumeration keys(Object Map)
            throws ClassCastException
Returns an enumeration of all the keys in the Map.
Parameters:
Returns:
An enumeration of all the keys in the Map.

put

public Object put(Object map,
                  Object key,
                  Object object)
            throws ClassCastException
Adds the given key-value pair to the map. Keys must be unique. Adding a key-value pair to the map, when an existing association for that key already exists will cause the existing association to be overwritten. The map is provided as a parameter and is returned as the return value if the returned map is a different object. That way the handler can create a new map if necessary.
Parameters:
map - the map, null if no map has been created yet.
key - the key for the object.
object - the object to add to the map.
Returns:
The map with the new object if a different instance than the map parameter, null otherwise

size

public int size(Object map)
            throws ClassCastException
Returns the number of elements (key-value) in the map.
Parameters:
map - the map.
Returns:
Number of key-value associations in the Map

Intalio Inc. (C) 1999-2003. All rights reserved http://www.intalio.com