org.apache.openjpa.util

Interface ProxyManager

All Known Implementing Classes:

ProxyManagerImpl

public interface ProxyManager

Manager for copying and proxying second class objects. Second class objects are those that are often used as fields of persistent or transactional instances, and which can themselves be modified without resetting the owning class' field. Because these types can change without an explicit call to the owning persistence capable instance, special care must be taken to ensure that their state is managed correctly. Specifically, they must be copied when saving state for rollback, and they must be proxied for any instance whose state is managed by a state manager, where proxying involves creating a second class object that automaticlly notifies its owning instance whenever it is modified. Generally, this factory is only used by the implementation; second class object handling is transparent to client code.

Author:

Abe White

Method Summary

Modifier and Type	Method and Description
Object	copyArray(Object orig) Return a new array of the same component type as the given array and containing the same elements.
Calendar	copyCalendar(Calendar orig) Return a copy of the given calendar with the same information.
Collection	copyCollection(Collection orig) Return a new collection of the same type as the given one with a copy of all contained elements.
Object	copyCustom(Object orig) Return a copy of the given object with the same information, or null if this manager cannot copy the object.
Date	copyDate(Date orig) Return a copy of the given date with the same information.
Map	copyMap(Map orig) Return a new map of the same type as the given one with a copy of all contained key/value pairs.
boolean	getDelayCollectionLoading() Returns whether this proxy manager is enabled for delayed collection loading.
Proxy	newCalendarProxy(Class type, TimeZone timeZone) Return a new calendar proxy.
Proxy	newCollectionProxy(Class type, Class elementType, Comparator compare, boolean autoOff) Return a proxy for the given collection type.
Proxy	newCustomProxy(Object obj, boolean autoOff) Return a proxy for the given object, or null if this manager cannot proxy the object.
Proxy	newDateProxy(Class type) Return a new date proxy.
Proxy	newMapProxy(Class type, Class keyType, Class valueType, Comparator compare, boolean autoOff) Return a proxy for the given map type.

Method Detail

copyArray

Object copyArray(Object orig)

Return a new array of the same component type as the given array and containing the same elements. Works for both primitive and object array types.

copyDate

Date copyDate(Date orig)

Return a copy of the given date with the same information.

newDateProxy

Proxy newDateProxy(Class type)

Return a new date proxy.

copyCalendar

Calendar copyCalendar(Calendar orig)

Return a copy of the given calendar with the same information.

newCalendarProxy

Proxy newCalendarProxy(Class type,
                       TimeZone timeZone)

Return a new calendar proxy.

copyCollection

Collection copyCollection(Collection orig)

Return a new collection of the same type as the given one with a copy of all contained elements.

newCollectionProxy

Proxy newCollectionProxy(Class type,
                         Class elementType,
                         Comparator compare,
                         boolean autoOff)

Return a proxy for the given collection type. The returned collection will allow only addition of elements assignable from the given element type and will use the given comparator, if it is not null.

copyMap

Map copyMap(Map orig)

Return a new map of the same type as the given one with a copy of all contained key/value pairs.

newMapProxy

Proxy newMapProxy(Class type,
                  Class keyType,
                  Class valueType,
                  Comparator compare,
                  boolean autoOff)

Return a proxy for the given map type. The returned map will allow only addition of keys/values assignable from the given keyType/valueType, and will use the given comparator, if it is not null.

copyCustom

Object copyCustom(Object orig)

Return a copy of the given object with the same information, or null if this manager cannot copy the object.

Since:

0.2.5

newCustomProxy

Proxy newCustomProxy(Object obj,
                     boolean autoOff)

Return a proxy for the given object, or null if this manager cannot proxy the object.

Since:

0.2.5

getDelayCollectionLoading

boolean getDelayCollectionLoading()

Returns whether this proxy manager is enabled for delayed collection loading. Delayed collection loading provides the ability to do simple, non-indexed add or remove operations on a lazy collection without loading the collection. The collection is loaded when necessary, such as iteration, indexed operations, isEmpty, or size.

Since:

2.2.1