org.jadira.reflection.cloning.api

Interface CloneDriver

All Superinterfaces:

CloneImplementor

All Known Implementing Classes:

BasicCloner, MinimalCloner

public interface CloneDriver
extends CloneImplementor

A clone driver defines the features of a class that is used to bootstrap and provide context to a cloning operation, typically (but not always), a Cloner *

Method Summary

Modifier and Type	Method and Description
CloneImplementor	getAnnotationImplementor(Class<?> clazz) Retrieves the registered implementor for the given class
CloneImplementor	getBuiltInImplementor(Class<?> clazz) Gets the built in implementor for the given class
MethodHandle	getCloneMethod(Class<?> clazz) Returns the clone() method for the indicated class
Set<Class<?>>	getImmutableClasses() A list of classes that should be treated as immutable.
CloneImplementor	getImplementor(Class<?> clazz) Retrieves the registered implementor for the given class
Set<Class<?>>	getNonCloneableClasses() A list of classes that should not be cloned.
boolean	isCloneImmutable() If false, indicates that classes known to be immutable should be not cloned.
boolean	isCloneSyntheticFields() Indicates whether synthetic fields should be cloned
boolean	isCloneTransientAnnotatedFields() If false, indicates that fields annotated by the Transient annotation should not be cloned, instead being replaced with null.
boolean	isCloneTransientFields() If false, indicates that fields modified by the transient keyword should not be cloned, instead being replaced with null.
boolean	isImmutableInstance(Object instance) Indicates whether the given object instance should be treated as immutable
boolean	isTrackReferences() Indicates whether to track references
boolean	isTrackReferencesForFlatClasses() Indicates whether to also track references for flat classes when tracking references.
boolean	isUseCloneable() If true, then any class that implements Cloneable will be cloned using the Object.clone() method.
boolean	isUseCloneImplementors() Indicates whether custom clone implementors are enabled
void	putAnnotationImplementor(Class<?> clazz, CloneImplementor implementor) Put the registered implementor for the given class
void	putCloneMethod(Class<?> clazz, MethodHandle handle) Put the clone() method for the indicated class
void	putImmutableInstance(Object instance) Stores an object instance to be treated as immutable

Methods inherited from interface org.jadira.reflection.cloning.api.CloneImplementor

canClone, clone, newInstance

Method Detail

getBuiltInImplementor

CloneImplementor getBuiltInImplementor(Class<?> clazz)

Gets the built in implementor for the given class

Parameters:

clazz - The class

Returns:

A CloneImplementor

getImplementor

CloneImplementor getImplementor(Class<?> clazz)

Retrieves the registered implementor for the given class

Parameters:

clazz - The class

Returns:

A CloneImplementor

getAnnotationImplementor

CloneImplementor getAnnotationImplementor(Class<?> clazz)

Retrieves the registered implementor for the given class

Parameters:

clazz - The class

Returns:

A CloneImplementor

putAnnotationImplementor

void putAnnotationImplementor(Class<?> clazz,
                              CloneImplementor implementor)

Put the registered implementor for the given class

Parameters:

clazz - The class

implementor - Implementor to register

isUseCloneable

boolean isUseCloneable()

If true, then any class that implements Cloneable will be cloned using the Object.clone() method.

Returns:

Default value is false

getCloneMethod

MethodHandle getCloneMethod(Class<?> clazz)

Returns the clone() method for the indicated class

Parameters:

clazz - The class to obtain the method for

Returns:

The related MethodHandle

putCloneMethod

void putCloneMethod(Class<?> clazz,
                    MethodHandle handle)

Put the clone() method for the indicated class

Parameters:

clazz - The class to obtain the method for

handle - The related MethodHandle

isCloneTransientFields

boolean isCloneTransientFields()

If false, indicates that fields modified by the transient keyword should not be cloned, instead being replaced with null.

Returns:

Default value is true

isCloneTransientAnnotatedFields

boolean isCloneTransientAnnotatedFields()

If false, indicates that fields annotated by the Transient annotation should not be cloned, instead being replaced with null.

Returns:

Default value is false

isCloneImmutable

boolean isCloneImmutable()

If false, indicates that classes known to be immutable should be not cloned. Immutables are identified by the @Immutable annotation; are one of a select set of known JDK immutable classes; or are detected as immutable by the Mutability Detector tool (if it was found on the classpath).

Returns:

Default value is false

getImmutableClasses

Set<Class<?>> getImmutableClasses()

A list of classes that should be treated as immutable.

Returns:

immutableClasses The immutable classes

getNonCloneableClasses

Set<Class<?>> getNonCloneableClasses()

A list of classes that should not be cloned.

Returns:

immutableClasses The classes which should be be cloned

isUseCloneImplementors

boolean isUseCloneImplementors()

Indicates whether custom clone implementors are enabled

Returns:

Default value is true

isCloneSyntheticFields

boolean isCloneSyntheticFields()

Indicates whether synthetic fields should be cloned

Returns:

cloneSyntheticFields Default is false

isImmutableInstance

boolean isImmutableInstance(Object instance)

Indicates whether the given object instance should be treated as immutable

Parameters:

instance - The instance to check for whether it is registered as immutable

Returns:

True if the object is registered as immutable

putImmutableInstance

void putImmutableInstance(Object instance)

Stores an object instance to be treated as immutable

Parameters:

instance - Object to be considered immutable

isTrackReferences

boolean isTrackReferences()

Indicates whether to track references

Returns:

trackReferences Default is true

isTrackReferencesForFlatClasses

boolean isTrackReferencesForFlatClasses()

Indicates whether to also track references for flat classes when tracking references.

Returns:

trackReferences Default is false