com.solarmetric.kodo.util
Interface ProxyCollection

All Superinterfaces:

Collection

All Known Implementing Classes:

ProxyArrayList, ProxyHashSet, ProxyLinkedList, ProxyTreeSet, ProxyVector

public interface ProxyCollection

extends Collection

Interface implemented by all proxies on Collection types.

Method Summary

Comparator	getComparator() Return the comparator used in this collection, or null if it is unordered or uses natural ordering.
Collection	getCopy(Collection orig) This method should return a copy of the given collection; 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.
ProxyCollection	newInstance(Class elementType, Collection 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.Collection

add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

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 ProxyCollection newInstance(Class elementType,
                                   Collection 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 Collection getCopy(Collection orig)

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

getComparator

public Comparator getComparator()

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