oracle.toplink.essentials.descriptors.copying.CopyPolicy Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
// Copyright (c) 1998, 2007, Oracle. All rights reserved.
package oracle.toplink.essentials.descriptors.copying;
import java.io.*;
import oracle.toplink.essentials.exceptions.*;
import oracle.toplink.essentials.descriptors.ClassDescriptor;
import oracle.toplink.essentials.queryframework.ObjectBuildingQuery;
import oracle.toplink.essentials.queryframework.ObjectLevelReadQuery;
import oracle.toplink.essentials.sessions.*;
/**
* 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 MethodBasedCopyPolicy 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.
*/
public interface CopyPolicy extends Cloneable, Serializable {
/**
* Return a shallow clone of the object for usage with object copying, or unit of work backup cloning.
*/
Object buildClone(Object object, Session session) throws DescriptorException;
/**
* Return a shallow clone of the object for usage with the unit of work working copy.
*/
Object buildWorkingCopyClone(Object object, Session session) 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.
*/
Object buildWorkingCopyCloneFromRow(Record row, ObjectBuildingQuery query) 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.
*/
Object buildWorkingCopyCloneFromRow(Record row, ObjectLevelReadQuery query) throws DescriptorException;
/**
* Clone the CopyPolicy.
*/
Object clone();
/**
* Allow for any initialization or validation required.
*/
void initialize(Session session) throws DescriptorException;
/**
* Set the descriptor.
*/
void setDescriptor(ClassDescriptor descriptor);
/**
* Return if this copy policy creates a new instance, vs a clone.
*/
boolean buildsNewInstance();
}