Class ClassCopierBase
java.lang.Object
org.glassfish.pfl.dynamic.copyobject.impl.ClassCopierBase
- All Implemented Interfaces:
ClassCopier
- Direct Known Subclasses:
ClassCopierOrdinaryImpl
A convenient base class for making ClassCopier types.
This takes care of checking oldToNew and updating oldToNew
when an actual copy is made. All subclasses must override
createCopy, which allocates a new result. In some simple
cases, this is all that is needed. In the more complex
cases, doCopy must also be overridden to make the actual copy.
-
Field Summary
Fields -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ClassCopierBase
(String name) Pass a name here that can be used for toString, hashCode, and equals.protected
ClassCopierBase
(String name, boolean isReflective) -
Method Summary
Modifier and TypeMethodDescriptionprivate HashMap
final Object
Make the actual copy of source, using oldToNew to preserve aliasing.protected abstract Object
createCopy
(Object source) Create a copy of source.private Object
doByFieldCopy
(Map<Object, Object> oldToNew, Object source) protected Object
Do the copying of data from source to result.private Object
doSpecialCaseCopy
(Map<Object, Object> oldToNew, Object source) Sometimes the internal representation of an object will be violated by our field-by-field copy.final boolean
final int
hashCode()
private boolean
isEmptyHashMap
(Object source) As of JDK 1.7-40, the JDK relies on the HashMap#table field being identical to a constant.boolean
We need to know whether this class copier operates via reflection or not, as the reflective class copier must be able to tell when a super class is copied by an incompatible copier.final String
toString()
-
Field Details
-
name
-
isReflective
private boolean isReflective
-
-
Constructor Details
-
ClassCopierBase
Pass a name here that can be used for toString, hashCode, and equals. All different ClassCopier classes derived from this base should have unique names. -
ClassCopierBase
-
-
Method Details
-
toString
-
hashCode
public final int hashCode() -
equals
-
copy
Make the actual copy of source, using oldToNew to preserve aliasing. This first checks to see whether source has been previously copied. If so, the value obtained from oldToNew is returned. Otherwise,- createCopy( source ) is called to create a new copy of source.
- The new copy is placed in oldToNew with source as its key.
- doCopy is called to complete the copy.
- Specified by:
copy
in interfaceClassCopier
- Throws:
ReflectiveCopyException
-
doSpecialCaseCopy
Sometimes the internal representation of an object will be violated by our field-by-field copy. This method handles those special cases. It suggests that there may be a basic problem with our code logic.- Parameters:
oldToNew
- a map of already copied objects and their corresponding copies.source
- the object to copy.
-
isEmptyHashMap
As of JDK 1.7-40, the JDK relies on the HashMap#table field being identical to a constant. That will not be true if we invoke #doByFieldCopy to copy it, so we need special processing.- Parameters:
source
- the object to copy.
-
cloneEmptyHashMap
-
doByFieldCopy
-
isReflectiveClassCopier
public boolean isReflectiveClassCopier()Description copied from interface:ClassCopier
We need to know whether this class copier operates via reflection or not, as the reflective class copier must be able to tell when a super class is copied by an incompatible copier.- Specified by:
isReflectiveClassCopier
in interfaceClassCopier
-
createCopy
Create a copy of source. The copy may or may not be fully initialized. This method must always be overridden in a subclass.- Throws:
ReflectiveCopyException
-
doCopy
protected Object doCopy(Map<Object, Object> oldToNew, Object source, Object result) throws ReflectiveCopyExceptionDo the copying of data from source to result. This just returns the result by default, but it may be overrideden in a subclass. When this method completes, result must be fully initialized.- Throws:
ReflectiveCopyException
-