agi.foundation.infrastructure

(agi.foundation.core-2024r3.jar)

Class CopyContext

java.lang.Object

agi.foundation.infrastructure.CopyContext

Direct Known Subclasses:

AccessQueryReplacementCopyContext, CopyForAnotherThread

public class CopyContext
extends Object

A context that identifies a complete copy operation. It is used to map old references to new references when doing a deep copy of a hierarchy of objects.

Constructor Summary

Constructors

Constructor and Description
CopyContext() Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
<T> void	addObjectMapping(T oldObject, T newObject) Adds a mapping between an old object reference and a new one.
void	clearObjectMapping() Clears the list of mappings that has been created with calls to CopyContext.addObjectMapping(T, T).
protected <T> T	clone(T oldObject) Copies the specified object using the ICloneWithContext interface or the ICloneable interface, with a preference on ICloneWithContext.
<T> T	cloneIfNotMapped(T oldObject) Looks for a mapping for this object that was added with CopyContext.addObjectMapping(T, T).
<T> T	getObjectMapping(T oldObject) Gets the mapping for the specified object.
<T> T	updateReference(T oldObject) Updates a given reference, returning a reference to use in its place.

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyContext

public CopyContext()

Initializes a new instance.

Method Detail

cloneIfNotMapped

public <T> T cloneIfNotMapped(T oldObject)

Looks for a mapping for this object that was added with CopyContext.addObjectMapping(T, T). If one is found, the object to which the specified one is mapped is returned. If one is not found, this method clones the given object by calling CopyContext.clone(T). Derived classes can override this default behavior.

Type Parameters:

T - The type of the object to clone.

Parameters:

oldObject - The old object reference for which to look for a mapping or clone.

Returns:

The object that the specified object is mapped to, or a cloned object if the specified object was not mapped.

Throws:

IllegalStateException - The object does not implement ICloneWithContext or ICloneable.

clone

@Nonnull
protected final <T> T clone(@Nonnull
                                      T oldObject)

Copies the specified object using the ICloneWithContext interface or the ICloneable interface, with a preference on ICloneWithContext.

Type Parameters:

T - The type of the object to clone.

Parameters:

oldObject - The object to clone.

Returns:

The newly-cloned object.

Throws:

ArgumentNullException - Thrown when oldObject is null.

IllegalStateException - The object does not implement ICloneWithContext or ICloneable.

addObjectMapping

public final <T> void addObjectMapping(@Nonnull
                                       T oldObject,
                                       @Nonnull
                                       T newObject)

Adds a mapping between an old object reference and a new one. The default implementation of CopyContext.updateReference(T) will substitute newObject everywhere it encounters oldObject.

Type Parameters:

T - The type of object to map.

Parameters:

oldObject - The old object reference.

newObject - The new object reference.

getObjectMapping

public final <T> T getObjectMapping(T oldObject)

Gets the mapping for the specified object.

Type Parameters:

T - The type of object to map.

Parameters:

oldObject - The old object reference for which to look for a mapping.

Returns:

The object that the specified object is mapped to, or null if the specified object is not mapped.

clearObjectMapping

public final void clearObjectMapping()

Clears the list of mappings that has been created with calls to CopyContext.addObjectMapping(T, T). This is useful if you want to reuse a CopyContext instance for a separate copy operation.

updateReference

public <T> T updateReference(T oldObject)

Updates a given reference, returning a reference to use in its place. The default implementation of this method looks for a mapping for this object that was added with CopyContext.addObjectMapping(T, T). If one is found, the object to which the specified one is mapped is returned. If one is not found, this method returns the object that was passed to it. Derived classes can override this default behavior.

Type Parameters:

T - The type of the object reference.

Parameters:

oldObject - The old reference to update.

Returns:

The updated reference.