Module eclipselink

Package org.eclipse.persistence.descriptors.copying

Interface CopyPolicy

All Superinterfaces:

Cloneable, Serializable

All Known Implementing Classes:

AbstractCopyPolicy, CloneCopyPolicy, InstantiationCopyPolicy, PersistenceEntityCopyPolicy

public interface CopyPolicy
extends Cloneable, Serializable

Purpose: Allows customization of how an object is cloned. An implementer of CopyPolicy can be set on a descriptor to provide special cloning routine for how an object is cloned in a unit of work. By default the InstantiationCopyPolicy is used which creates a new instance of the class to be copied into. The CloneCopyPolicy can also be used that uses a clone method in the object to clone the object. When a clone method is used it avoid the requirement of having to copy over each of the direct attributes.

See Also:

CloneCopyPolicy, InstantiationCopyPolicy

Method Summary

Modifier and Type	Method	Description
Object	buildClone(Object object, Session session)	Return a shallow clone of the object for usage with object copying, or unit of work backup cloning.
boolean	buildsNewInstance()	Return if this copy policy creates a new instance, vs a clone.
Object	buildWorkingCopyClone(Object object, Session session)	Return a shallow clone of the object for usage with the unit of work working copy.
Object	buildWorkingCopyCloneFromRow(DataRecord row, ObjectBuildingQuery query, Object primaryKey, UnitOfWork uow)	Return an instance with the primary key set from the row, used for building a working copy during a unit of work transactional read.
Object	clone()	Clone the CopyPolicy.
void	initialize(Session session)	Allow for any initialization or validation required.
void	setDescriptor(ClassDescriptor descriptor)	Set the descriptor.

Method Detail

buildClone

Object buildClone(Object object,
                  Session session)
           throws DescriptorException

Return a shallow clone of the object for usage with object copying, or unit of work backup cloning.

Throws:

DescriptorException

buildWorkingCopyClone

Object buildWorkingCopyClone(Object object,
                             Session session)
                      throws DescriptorException

Return a shallow clone of the object for usage with the unit of work working copy.

Throws:

DescriptorException

buildWorkingCopyCloneFromRow

Object buildWorkingCopyCloneFromRow(DataRecord row,
                                    ObjectBuildingQuery query,
                                    Object primaryKey,
                                    UnitOfWork uow)
                             throws DescriptorException

Return an instance with the primary key set from the row, used for building a working copy during a unit of work transactional read.

Throws:

DescriptorException

clone

Object clone()

Clone the CopyPolicy.

initialize

void initialize(Session session)
         throws DescriptorException

Allow for any initialization or validation required.

Throws:

DescriptorException

setDescriptor

void setDescriptor(ClassDescriptor descriptor)

Set the descriptor.

buildsNewInstance

boolean buildsNewInstance()

Return if this copy policy creates a new instance, vs a clone.