com.fr.clone.cloning

类 Cloner

java.lang.Object

com.fr.clone.cloning.Cloner

public class Cloner
extends java.lang.Object

Cloner: deep clone objects. This class is thread safe. One instance can be used by multiple threads on the same time.

作者:

kostantinos.kougios 18 Sep 2008

构造器概要

构造器

构造器和说明
Cloner()
Cloner(IInstantiationStrategy instantiationStrategy)

方法概要

方法

限定符和类型	方法和说明
protected java.util.List<java.lang.reflect.Field>	allFields(java.lang.Class<?> c) reflection utils, override this to choose which fields to clone
protected <T> T	cloneInternal(T o, java.util.Map<java.lang.Object,java.lang.Object> clones)
protected boolean	considerImmutable(java.lang.Class<?> clz) override this to decide if a class is immutable.
<T,E extends T> void	copyPropertiesOfInheritedClass(T src, E dest) copies all properties from src to dest.
<T> T	deepClone(T o) deep clones "o".
<T> T	deepCloneDontCloneInstances(T o, java.lang.Object... dontCloneThese)
void	dontClone(java.lang.Class<?>... c) instances of classes that shouldn't be cloned can be registered using this method.
void	dontCloneInstanceOf(java.lang.Class<?>... c)
protected java.lang.Object	fastClone(java.lang.Object o, java.util.Map<java.lang.Object,java.lang.Object> clones)
<T> T	fastCloneOrNewInstance(java.lang.Class<T> c)
IDumpCloned	getDumpCloned()
protected java.lang.Class<?>	getImmutableAnnotation()
boolean	isCloneAnonymousParent()
boolean	isCloningEnabled()
boolean	isDumpClonedClasses()
boolean	isNullTransient()
protected <T> T	newInstance(java.lang.Class<T> c) creates a new instance of c.
void	nullInsteadOfClone(java.lang.Class<?>... c) instead of cloning these classes will set the field to null
void	registerConstant(java.lang.Class<?> c, java.lang.String privateFieldName)
void	registerConstant(java.lang.Object o)
void	registerFastCloner(java.lang.Class<?> c, IFastCloner fastCloner)
protected void	registerFastCloners() registers a std set of fast cloners.
void	registerImmutable(java.lang.Class<?>... c) registers an immutable class.
protected void	registerKnownConstants()
protected void	registerKnownJdkImmutableClasses() registers some known JDK immutable classes.
void	registerStaticFields(java.lang.Class<?>... classes) registers all static fields of these classes.
void	setCloneAnonymousParent(boolean cloneAnonymousParent) if false, anonymous classes parent class won't be cloned.
void	setCloneSynthetics(boolean cloneSynthetics)
void	setCloningEnabled(boolean cloningEnabled)
void	setDontCloneInstanceOf(java.lang.Class<?>... c)
void	setDumpCloned(IDumpCloned dumpCloned) provide a cloned classes dumper (so i.e. they can be logged or stored in a file instead of the default behaviour which is to println(cloned) )
void	setDumpClonedClasses(boolean dumpClonedClasses) will println() all cloned classes.
void	setExtraImmutables(java.util.Set<java.lang.Class<?>> set)
void	setExtraNullInsteadOfClone(java.util.Set<java.lang.Class<?>> set)
void	setExtraStaticFields(java.util.Set<java.lang.Class<?>> set) spring framework friendly version of registerStaticFields
void	setNullTransient(boolean nullTransient) this makes the cloner to set a transient field to null upon cloning.
<T> T	shallowClone(T o) shallow clones "o".
static Cloner	shared()
static Cloner	standard()
void	unregisterFastCloner(java.lang.Class<?> c)

从类继承的方法 java.lang.Object

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

构造器详细资料

Cloner

public Cloner()

Cloner

public Cloner(IInstantiationStrategy instantiationStrategy)

方法详细资料

getDumpCloned

public IDumpCloned getDumpCloned()

setDumpCloned

public void setDumpCloned(IDumpCloned dumpCloned)

provide a cloned classes dumper (so i.e. they can be logged or stored in a file instead of the default behaviour which is to println(cloned) )

参数:

dumpCloned - an implementation of the interface which can dump the cloned classes.

isNullTransient

public boolean isNullTransient()

setNullTransient

public void setNullTransient(boolean nullTransient)

this makes the cloner to set a transient field to null upon cloning. NOTE: primitive types can't be nulled. Their value will be set to default, i.e. 0 for int

参数:

nullTransient - true for transient fields to be nulled

setCloneSynthetics

public void setCloneSynthetics(boolean cloneSynthetics)

registerFastCloners

protected void registerFastCloners()

registers a std set of fast cloners.

fastClone

protected java.lang.Object fastClone(java.lang.Object o,
                         java.util.Map<java.lang.Object,java.lang.Object> clones)
                              throws java.lang.IllegalAccessException

抛出:

java.lang.IllegalAccessException

registerConstant

public void registerConstant(java.lang.Object o)

registerConstant

public void registerConstant(java.lang.Class<?> c,
                    java.lang.String privateFieldName)

registerKnownJdkImmutableClasses

protected void registerKnownJdkImmutableClasses()

registers some known JDK immutable classes. Override this to register your own list of jdk's immutable classes

registerKnownConstants

protected void registerKnownConstants()

registerStaticFields

public void registerStaticFields(java.lang.Class<?>... classes)

registers all static fields of these classes. Those static fields won't be cloned when an instance of the class is cloned. This is useful i.e. when a static field object is added into maps or sets. At that point, there is no way for the cloner to know that it was static except if it is registered.

参数:

classes - array of classes

setExtraStaticFields

public void setExtraStaticFields(java.util.Set<java.lang.Class<?>> set)

spring framework friendly version of registerStaticFields

参数:

set - a set of classes which will be scanned for static fields

dontClone

public void dontClone(java.lang.Class<?>... c)

instances of classes that shouldn't be cloned can be registered using this method.

参数:

c - The class that shouldn't be cloned. That is, whenever a deep clone for an object is created and c is encountered, the object instance of c will be added to the clone.

dontCloneInstanceOf

public void dontCloneInstanceOf(java.lang.Class<?>... c)

setDontCloneInstanceOf

public void setDontCloneInstanceOf(java.lang.Class<?>... c)

nullInsteadOfClone

public void nullInsteadOfClone(java.lang.Class<?>... c)

instead of cloning these classes will set the field to null

参数:

c - the classes to nullify during cloning

setExtraNullInsteadOfClone

public void setExtraNullInsteadOfClone(java.util.Set<java.lang.Class<?>> set)

registerImmutable

public void registerImmutable(java.lang.Class<?>... c)

registers an immutable class. Immutable classes are not cloned.

参数:

c - the immutable class

setExtraImmutables

public void setExtraImmutables(java.util.Set<java.lang.Class<?>> set)

registerFastCloner

public void registerFastCloner(java.lang.Class<?> c,
                      IFastCloner fastCloner)

unregisterFastCloner

public void unregisterFastCloner(java.lang.Class<?> c)

newInstance

protected <T> T newInstance(java.lang.Class<T> c)

creates a new instance of c. Override to provide your own implementation

类型参数:

T - the type of c

参数:

c - the class

返回:

a new instance of c

fastCloneOrNewInstance

public <T> T fastCloneOrNewInstance(java.lang.Class<T> c)

deepClone

public <T> T deepClone(T o)

deep clones "o".

类型参数:

T - the type of "o"

参数:

o - the object to be deep-cloned

返回:

a deep-clone of "o".

deepCloneDontCloneInstances

public <T> T deepCloneDontCloneInstances(T o,
                                java.lang.Object... dontCloneThese)

shallowClone

public <T> T shallowClone(T o)

shallow clones "o". This means that if c=shallowClone(o) then c!=o. Any change to c won't affect o.

类型参数:

T - the type of o

参数:

o - the object to be shallow-cloned

返回:

a shallow clone of "o"

considerImmutable

protected boolean considerImmutable(java.lang.Class<?> clz)

override this to decide if a class is immutable. Immutable classes are not cloned.

参数:

clz - the class under check

返回:

true to mark clz as immutable and skip cloning it

getImmutableAnnotation

protected java.lang.Class<?> getImmutableAnnotation()

cloneInternal

protected <T> T cloneInternal(T o,
                  java.util.Map<java.lang.Object,java.lang.Object> clones)
                   throws java.lang.IllegalAccessException

抛出:

java.lang.IllegalAccessException

copyPropertiesOfInheritedClass

public <T,E extends T> void copyPropertiesOfInheritedClass(T src,
                                                  E dest)

copies all properties from src to dest. Src and dest can be of different class, provided they contain same field names/types

参数:

src - the source object

dest - the destination object which must contain as minimum all the fields of src

allFields

protected java.util.List<java.lang.reflect.Field> allFields(java.lang.Class<?> c)

reflection utils, override this to choose which fields to clone

isDumpClonedClasses

public boolean isDumpClonedClasses()

setDumpClonedClasses

public void setDumpClonedClasses(boolean dumpClonedClasses)

will println() all cloned classes. Useful for debugging only. Use setDumpCloned() if you want to control where to print the cloned classes.

参数:

dumpClonedClasses - true to enable printing all cloned classes

isCloningEnabled

public boolean isCloningEnabled()

setCloningEnabled

public void setCloningEnabled(boolean cloningEnabled)

setCloneAnonymousParent

public void setCloneAnonymousParent(boolean cloneAnonymousParent)

if false, anonymous classes parent class won't be cloned. Default is true

isCloneAnonymousParent

public boolean isCloneAnonymousParent()

standard

public static Cloner standard()

返回:

a standard cloner instance, will do for most use cases

shared

public static Cloner shared()

返回:

if Cloner lib is in a shared jar folder for a container (i.e. tomcat/shared), then this method is preferable in order to instantiate cloner. Please see https://code.google.com/p/cloning/issues/detail?id=23