com.alee.api.clone

Class Clone

java.lang.Object

com.alee.api.clone.Clone

All Implemented Interfaces:

Serializable

public final class Clone
extends Object
implements Serializable

Configurable algorithm for cloning object instances. It can be customized through the settings provided in its constructor once on creation. To clone any Object using this class instance call clone(Object) method. There are some preconfigured options available: - basic() - Clone instance for cloning basic types and objects that implement CloneBehavior - deep() - Clone instance for cloning any Cloneable objects - reflective() - Clone instance for cloning any objects, Cloneable or not

Author:

Mikle Garin

See Also:

How to use Clone, Clone, UnknownResolver, GlobalCloneBehavior, CloneBehavior, Cloneable, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Clone(UnknownResolver unknownResolver, GlobalCloneBehavior... behaviors) Constructs new Clone algorithm.
Clone(UnknownResolver unknownResolver, List<GlobalCloneBehavior> behaviors) Constructs new Clone algorithm.

Method Summary

Modifier and Type	Method and Description
static Clone	basic() Returns Clone algorithm that is able to clone basic object types as well as simple Collections and Maps.
<T> T	clone(T object) Returns clone of the specified object.
static Clone	deep() Returns Clone algorithm that can also clone custom objects through ReflectionCloneBehavior.
<T> T	nonNullClone(T object) Returns non-null clone of the specified object.
static Clone	reflective() Returns Clone algorithm similar to deep() but also allows non-Cloneable objects to be cloned.

Methods inherited from class java.lang.Object

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

Constructor Detail

Clone

public Clone(@NotNull
             UnknownResolver unknownResolver,
             @NotNull
             GlobalCloneBehavior... behaviors)

Constructs new Clone algorithm.

Parameters:

unknownResolver - unknown object types case resolver

behaviors - behaviors taking part in this clone algorithm instance

Clone

public Clone(@NotNull
             UnknownResolver unknownResolver,
             @NotNull
             List<GlobalCloneBehavior> behaviors)

Constructs new Clone algorithm.

Parameters:

unknownResolver - unknown object types case resolver

behaviors - behaviors taking part in this clone algorithm instance

Method Detail

clone

@Nullable
public <T> T clone(@Nullable
                             T object)

Returns clone of the specified object. New Clone.InternalClone instance is used for every separate clone operation. That is necessary because Clone.InternalClone stores cloned object references internally to preserve object links.

Type Parameters:

T - cloned object type

Parameters:

object - object to clone, should never be null

Returns:

clone of the specified object

nonNullClone

@NotNull
public <T> T nonNullClone(@NotNull
                                   T object)

Returns non-null clone of the specified object. New Clone.InternalClone instance is used for every separate clone operation. That is necessary because Clone.InternalClone stores cloned object references internally to preserve object links.

Type Parameters:

T - cloned object type

Parameters:

object - object to clone, should never be null

Returns:

non-null clone of the specified object

basic

@NotNull
public static Clone basic()

Returns Clone algorithm that is able to clone basic object types as well as simple Collections and Maps. This algorithm is most useful for cases when you don't want to clone any unwanted objects and only focus on few basic types and some extra types which have strictly defined clone behavior through implementing CloneBehavior.

Returns:

Clone algorithm that is able to clone basic object types as well as simple Collections and Maps

deep

@NotNull
public static Clone deep()

Returns Clone algorithm that can also clone custom objects through ReflectionCloneBehavior. Be careful when using this clone algorithm as it will go through all object references and will clone any existing fields. This algorithm is most useful for cases of cloning complex multi-level structures of objects where defining every clone operation can be difficult and vulnerable to mistakes.

Returns:

Clone algorithm that can also clone custom objects through ReflectionCloneBehavior

reflective

@NotNull
public static Clone reflective()

Returns Clone algorithm similar to deep() but also allows non-Cloneable objects to be cloned. Be careful when using this clone algorithm as it will go through all object references and will clone any existing fields. Just like deep() clone algorithm this one is most useful for cloning complex multi-level structures of objects while also honoring base Object.clone() API while going through the structure of objects.

Returns:

Clone algorithm similar to deep() that also uses base Object.clone() API