com.jme3.util.clone

Interface CloneFunction<T>

All Known Implementing Classes:

IdentityCloneFunction, ListCloneFunction

public interface CloneFunction<T>

Provides custom cloning for a particular object type. Once registered with the Cloner, this function object will be called twice for any cloned object that matches the class for which it was registered. It will first call cloneObject() to shallow clone the object and then call cloneFields() to deep clone the object's values.

This two step process is important because this is what allows circular references in the cloned object graph.

Method Summary

Modifier and Type	Method and Description
void	cloneFields(Cloner cloner, T clone, T original) Performs a deep clone of the specified clone's fields.
T	cloneObject(Cloner cloner, T original) Performs a shallow clone of the specified object.

Method Detail

cloneObject

T cloneObject(Cloner cloner,
              T original)

Performs a shallow clone of the specified object. This is similar to the JmeCloneable.clone() method in semantics and is the first part of a two part cloning process. Once the shallow clone is created, it is cached and CloneFunction.cloneFields() is called. In this way, the CloneFunction interface can completely take over the JmeCloneable style cloning for an object that doesn't otherwise implement that interface.

Parameters:

cloner - The cloner performing the cloning operation.

original - The original object that needs to be cloned.

Returns:

a new instance

cloneFields

void cloneFields(Cloner cloner,
                 T clone,
                 T original)

Performs a deep clone of the specified clone's fields. This is similar to the JmeCloneable.cloneFields() method in semantics and is the second part of a two part cloning process. Once the shallow clone is created, it is cached and CloneFunction.cloneFields() is called. In this way, the CloneFunction interface can completely take over the JmeCloneable style cloning for an object that doesn't otherwise implement that interface.

Parameters:

cloner - The cloner performing the cloning operation.

clone - The clone previously returned from cloneObject().

original - The original object that was cloned. This is provided for the very special case where field cloning needs to refer to the original object. Mostly the necessary fields should already be on the clone.