edu.tum.cs.commons.clone
Class CloneUtils

java.lang.Object
  edu.tum.cs.commons.clone.CloneUtils

public class CloneUtils
extends Object

Collection of utility methods to simplify cloning.

Version:

$Rev: 26268 $

Author:

Benjamin Hummel, $Author: juergens $

Rating:

GREEN Hash: 67F5FD6BA376F3700299C536C919917E

Constructor Summary

CloneUtils()

Method Summary

static Object	cloneAsDeepAsPossible(Object o) Clone the provided object if supported.
static Object	cloneAsDeepAsPossible(Object o, int maxDepth) Clone the provided object if supported.
static void	cloneMapEntries(Map<String,Object> source, Map<String,Object> target) Duplicate all entries of the source map to the target map and create clones of all contained objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

CloneUtils

public CloneUtils()

Method Detail

cloneMapEntries

public static void cloneMapEntries(Map<String,Object> source,
                                   Map<String,Object> target)
                            throws DeepCloneException

Duplicate all entries of the source map to the target map and create clones of all contained objects.

Parameters:

source - the source for the key value pairs.

target - the map to insert the created clones into.

Throws:

DeepCloneException

cloneAsDeepAsPossible

public static Object cloneAsDeepAsPossible(Object o)
                                    throws DeepCloneException

Clone the provided object if supported. If the depth of the structure is deeper than 3 an exception is thrown. For some of the special cases handled see cloneAsDeepAsPossible(Object, int).

Parameters:

o - the object to be cloned.

Returns:

the cloned (or original) object.

Throws:

DeepCloneException - if the depth of the cloned struture is too high or the underlying clone methods failed.

cloneAsDeepAsPossible

public static Object cloneAsDeepAsPossible(Object o,
                                           int maxDepth)
                                    throws DeepCloneException

Clone the provided object if supported. The following cases are explicitly handled:

• For IDeepCloneables the IDeepCloneable.deepClone() method is used, ignoring the maximal depth.
• For Maps the contents (keys and values) are cloned and put into a HashMap. The order is not preserved.
• Arrays are cloned as expected.
• All Collections are cloned as an ArrayList
• Is nothing matched so far, and the object implements Cloneable, and has a public clone method, the Object.clone() method is used.
• In any other case the object itself is returned (uncloned).

Parameters:

o - the object to be cloned.

maxDepth - the maximal depth of the structure before an exception is thrown. A depth of 0 indicates that no recursive calls are allowed, depth 1 allows 1 recursive call, and so on.

Returns:

the cloned (or original) object.

Throws:

DeepCloneException - if the depth of the cloned struture is too high or the underlying clone methods failed.