org.jadira.reflection.cloning.implementor

Class AbstractCloneStrategy

java.lang.Object

org.jadira.reflection.cloning.implementor.AbstractCloneStrategy

All Implemented Interfaces:

CloneImplementor, CloneStrategy

Direct Known Subclasses:

AsmCloneStrategy, InvokeDynamicCloneStrategy, PortableCloneStrategy, UnsafeCloneStrategy

public abstract class AbstractCloneStrategy
extends Object
implements CloneStrategy

A Base CloneStrategy implementation providing functionality which is common across class and field access mechanisms.

Constructor Summary

Constructors

Constructor and Description
AbstractCloneStrategy()

Method Summary

Modifier and Type	Method and Description
boolean	canClone(Class<?> clazz) True if this implementor can clone the given class
<T> T	clone(T obj, CloneDriver context, IdentityHashMap<Object,Object> referencesToReuse, long stackDepth) Performs a clone.
protected abstract <W> ClassModel<W>	getClassModel(Class<W> clazz) Obtain a ClassModel instance for the given class
protected abstract <T> Object	getFieldValue(T obj, FieldModel<T> f) Method to retrieve the value of a particular field
protected <T> T	handleArray(T origFieldValue, CloneDriver context, IdentityHashMap<Object,Object> visited, long stackDepth) Clone an array
protected <T> void	handleCloneField(T obj, T copy, CloneDriver driver, FieldModel<T> f, IdentityHashMap<Object,Object> referencesToReuse, long stackDepth) Clone a Field
protected abstract <T> void	handleClonePrimitiveField(T obj, T copy, CloneDriver driver, FieldModel<T> f, IdentityHashMap<Object,Object> referencesToReuse) Method should clone the given primitive field
protected abstract <T> void	handleTransientField(T copy, FieldModel<T> f) Implementations should ensure that transient fields are left with the correct default (unset) value
void	initialiseFor(Class<?>... classes)
abstract <T> T	newInstance(Class<T> c) Create a new, uninitialised instance of the given class (if supported).
protected <T> T	performCloneForCloneableMethod(T object, CloneDriver context) Helper method for performing cloning for objects of classes implementing java.lang.Cloneable
protected abstract <T> void	putFieldValue(T obj, FieldModel<T> f, Object value) Put the given value into the target field

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCloneStrategy

public AbstractCloneStrategy()

Method Detail

newInstance

public abstract <T> T newInstance(Class<T> c)

Description copied from interface: CloneImplementor

Create a new, uninitialised instance of the given class (if supported). Depending on strategy, this may or may not initialise instance fields, and may or may not invoke constructors.

Specified by:

newInstance in interface CloneImplementor

Type Parameters:

T - The type of the instance to be constructed

Parameters:

c - Type to create instance of

Returns:

The new instance

canClone

public boolean canClone(Class<?> clazz)

Description copied from interface: CloneImplementor

True if this implementor can clone the given class

Specified by:

canClone in interface CloneImplementor

Parameters:

clazz - The class

Returns:

True if cloneable, false otherwise

clone

public <T> T clone(T obj,
                   CloneDriver context,
                   IdentityHashMap<Object,Object> referencesToReuse,
                   long stackDepth)

Description copied from interface: CloneImplementor

Performs a clone.

Specified by:

clone in interface CloneImplementor

Type Parameters:

T - The type of the object to be cloned

Parameters:

obj - Object to clone

context - The CloneDriver that initiated the request

referencesToReuse - Any references for objects already cloned to ensure reference identity is preserved

stackDepth - The number of objects already cloned in the current data structure

Returns:

The cloned object

performCloneForCloneableMethod

protected <T> T performCloneForCloneableMethod(T object,
                                               CloneDriver context)

Helper method for performing cloning for objects of classes implementing java.lang.Cloneable

Type Parameters:

T - The type being copied

Parameters:

object - The object to be cloned.

context - The CloneDriver to be used

Returns:

The cloned object

getClassModel

protected abstract <W> ClassModel<W> getClassModel(Class<W> clazz)

Obtain a ClassModel instance for the given class

Type Parameters:

W - The type of class

Parameters:

clazz - Class to model

Returns:

The ClassModel

handleArray

protected <T> T handleArray(T origFieldValue,
                            CloneDriver context,
                            IdentityHashMap<Object,Object> visited,
                            long stackDepth)

Clone an array

Type Parameters:

T - The type being copied

Parameters:

origFieldValue - The original value

context - The CloneDriver

visited - Used for tracking objects that have already been seen

stackDepth - The current depth of the stack - used to switch from recursion to iteration if the stack grows too deep.

Returns:

A clone of the array

handleCloneField

protected <T> void handleCloneField(T obj,
                                    T copy,
                                    CloneDriver driver,
                                    FieldModel<T> f,
                                    IdentityHashMap<Object,Object> referencesToReuse,
                                    long stackDepth)

Clone a Field

Type Parameters:

T - The type containing the field being cloned

Parameters:

obj - The original object

copy - The destination object

driver - The CloneDriver

f - The FieldModel for the target field

referencesToReuse - Used for tracking objects that have already been seen

stackDepth - The current depth of the stack - used to switch from recursion to iteration if the stack grows too deep.

handleTransientField

protected abstract <T> void handleTransientField(T copy,
                                                 FieldModel<T> f)

Implementations should ensure that transient fields are left with the correct default (unset) value

Type Parameters:

T - The type containing the field

Parameters:

copy - The target object

f - The FieldModel for the Field that should stay as a default

handleClonePrimitiveField

protected abstract <T> void handleClonePrimitiveField(T obj,
                                                      T copy,
                                                      CloneDriver driver,
                                                      FieldModel<T> f,
                                                      IdentityHashMap<Object,Object> referencesToReuse)

Method should clone the given primitive field

Type Parameters:

T - The type being copied

Parameters:

obj - Source object

copy - The target object

driver - The CloneDriver to use

f - The FieldModel for the Field that should stay as a default

referencesToReuse - Used for tracking objects that have already been seen

getFieldValue

protected abstract <T> Object getFieldValue(T obj,
                                            FieldModel<T> f)

Method to retrieve the value of a particular field

Type Parameters:

T - The type containing the field

Parameters:

obj - Source object

f - The FieldModel for the Field that should stay as a default

Returns:

The value in the given field

putFieldValue

protected abstract <T> void putFieldValue(T obj,
                                          FieldModel<T> f,
                                          Object value)

Put the given value into the target field

Type Parameters:

T - The type containing the field

Parameters:

obj - Source object

f - The FieldModel for the Field that should stay as a default

value - The value to put

initialiseFor

public void initialiseFor(Class<?>... classes)

Specified by:

initialiseFor in interface CloneStrategy

Parameters:

classes - Classes to initialise for