com.solarmetric.kodo.util
Interface ProxyMap

All Superinterfaces:

Map

All Known Implementing Classes:

ProxyHashMap, ProxyTreeMap, ProxyProperties, ProxyHashtable

public interface ProxyMap

extends Map

Interface implemented by all proxies on Map types.

Inner classes inherited from class java.util.Map

Map.Entry

Method Summary

Comparator	getComparator() Return the comparator used in this map, or null if it is unordered or uses natural ordering.
Map	getCopy(Map orig) This method should return a copy of the given map; the copy should be of the same class as the superclass of this collection.
Object	getOwner() Return the owning object.
String	getOwnerFieldName() Return the owning field name.
ProxyMap	newInstance(Class keyType, Class valueType, Map contents, Comparator compare) This method should return a new proxy of the same concrete type as the implementing class.
void	setOwner(Object pc, String fieldName) Set the owning JDO instance of the proxy and the name of the field it is assigned to.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

setOwner

public void setOwner(Object pc,
                     String fieldName)

Set the owning JDO instance of the proxy and the name of the field it is assigned to. Set to null to indicate that the proxy is no longer managed.

getOwner

public Object getOwner()

Return the owning object.

getOwnerFieldName

public String getOwnerFieldName()

Return the owning field name.

newInstance

public ProxyMap newInstance(Class keyType,
                            Class valueType,
                            Map contents,
                            Comparator compare)

This method should return a new proxy of the same concrete type as the implementing class. Used by the ProxyManager factories: one template instance of each type is created for the purpose of producing new instances via this method. Overcomes the performance penalties of reflection.

getCopy

public Map getCopy(Map orig)

This method should return a copy of the given map; the copy should be of the same class as the superclass of this collection.

getComparator

public Comparator getComparator()

Return the comparator used in this map, or null if it is unordered or uses natural ordering.