Module eclipselink

Package org.eclipse.persistence.descriptors.copying

Class CloneCopyPolicy

java.lang.Object

org.eclipse.persistence.descriptors.copying.AbstractCopyPolicy

org.eclipse.persistence.descriptors.copying.CloneCopyPolicy

All Implemented Interfaces:

Serializable, Cloneable, CopyPolicy

public class CloneCopyPolicy
extends AbstractCopyPolicy

Purpose: Allows a clone of an object to be created with a method that returns the cloned object.

It is possible to define methods for two types of clones

• methodName can be set to define the method EclipseLink uses to clone objects for it's own internal use. The objects created by this method will not be visible to the user, and instead used as a basis for comparison when a DeferredChangeDetectionPolicy used. This method will also be in place of the workingCopyMethod if it is not provided
• workingCopyMethod this method is used to create the clone that is returned to the user when an Object is registered in a UnitOfWork

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Method	method
protected String	methodName	Allow for clone method to be specified.
protected Method	workingCopyMethod
protected String	workingCopyMethodName

Fields inherited from class org.eclipse.persistence.descriptors.copying.AbstractCopyPolicy

descriptor

Constructor Summary

Constructors

Constructor	Description
CloneCopyPolicy()

Method Summary

Modifier and Type	Method	Description
Object	buildClone(Object domainObject, Session session)	Clone through calling the clone method.
boolean	buildsNewInstance()	Return false as a shallow clone is returned, not a new instance.
Object	buildWorkingCopyClone(Object domainObject, Session session)	Clone through the workingCopyClone method, or if not specified the clone method.
Object	buildWorkingCopyCloneFromRow(DataRecord row, ObjectBuildingQuery query, Object primaryKey, UnitOfWork uow)	Create a new instance, unless a workingCopyClone method is specified, then build a new instance and clone it.
protected Method	getMethod()	Return the clone method.
String	getMethodName()	Return the clone method name.
protected Method	getWorkingCopyMethod()	Return the workingCopyClone method.
String	getWorkingCopyMethodName()	Return the workingCopyClone method name.
void	initialize(Session session)	Validate and build the methods.
protected void	setMethod(Method method)	Set the clone method.
void	setMethodName(String methodName)	Set the clone method name.
protected void	setWorkingCopyMethod(Method method)	Set the workingCopyClone method.
void	setWorkingCopyMethodName(String methodName)	Set the workingCopyClone method name.
String	toString()

Methods inherited from class org.eclipse.persistence.descriptors.copying.AbstractCopyPolicy

clone, getDescriptor, setDescriptor

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

methodName

protected String methodName

Allow for clone method to be specified.

workingCopyMethodName

protected String workingCopyMethodName

method

protected transient Method method

workingCopyMethod

protected transient Method workingCopyMethod

Constructor Details

CloneCopyPolicy

public CloneCopyPolicy()

Method Details

buildClone

public Object buildClone(Object domainObject,
 Session session)
                  throws DescriptorException

Clone through calling the clone method.

Specified by:

buildClone in interface CopyPolicy

Specified by:

buildClone in class AbstractCopyPolicy

Throws:

DescriptorException

buildWorkingCopyClone

public Object buildWorkingCopyClone(Object domainObject,
 Session session)
                             throws DescriptorException

Clone through the workingCopyClone method, or if not specified the clone method.

Specified by:

buildWorkingCopyClone in interface CopyPolicy

Overrides:

buildWorkingCopyClone in class AbstractCopyPolicy

Throws:

DescriptorException

buildWorkingCopyCloneFromRow

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

Create a new instance, unless a workingCopyClone method is specified, then build a new instance and clone it.

Specified by:

buildWorkingCopyCloneFromRow in interface CopyPolicy

Overrides:

buildWorkingCopyCloneFromRow in class AbstractCopyPolicy

Throws:

DescriptorException

getMethod

protected Method getMethod()

Return the clone method.

getMethodName

public String getMethodName()

Return the clone method name.

getWorkingCopyMethod

protected Method getWorkingCopyMethod()

Return the workingCopyClone method. This is used to clone within a unit of work.

getWorkingCopyMethodName

public String getWorkingCopyMethodName()

Return the workingCopyClone method name. This is used to clone within a unit of work.

initialize

public void initialize(Session session)
                throws DescriptorException

Validate and build the methods.

Specified by:

initialize in interface CopyPolicy

Overrides:

initialize in class AbstractCopyPolicy

Throws:

DescriptorException

setMethod

protected void setMethod(Method method)

Set the clone method.

setMethodName

public void setMethodName(String methodName)

Set the clone method name.

setWorkingCopyMethod

protected void setWorkingCopyMethod(Method method)

Set the workingCopyClone method. This is used to clone within a unit of work.

setWorkingCopyMethodName

public void setWorkingCopyMethodName(String methodName)

Set the workingCopyClone method name. This is used to clone within a unit of work.

buildsNewInstance

public boolean buildsNewInstance()

Return false as a shallow clone is returned, not a new instance.

toString

public String toString()

Overrides:

toString in class AbstractCopyPolicy