org.datanucleus.enhancer.ClassEnhancer Maven / Gradle / Ivy
/**********************************************************************
Copyright (c) 2006 Andy Jefferson and others. All rights reserved.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Contributors:
...
**********************************************************************/
package org.datanucleus.enhancer;
import java.io.IOException;
import java.util.Collection;
import org.datanucleus.ClassLoaderResolver;
import org.datanucleus.metadata.ClassMetaData;
import org.datanucleus.metadata.MetaDataManager;
/**
* Interface representation of an enhancer of a class.
*/
public interface ClassEnhancer
{
/** Option for generating the default constructor. */
public static final String OPTION_GENERATE_DEFAULT_CONSTRUCTOR = "generate-default-constructor";
/** Option for generating the default constructor. */
public static final String OPTION_GENERATE_PK = "generate-primary-key";
/** Option for use the detach listener. */
public static final String OPTION_GENERATE_DETACH_LISTENER = "generate-detach-listener";
/**
* Method to set the options controlling the enhancement.
* @param options The options
*/
void setOptions(Collection options);
/**
* Accessor for whether a particular option is enabled.
* @param name Name of the option
* @return Whether it has this option
*/
boolean hasOption(String name);
/**
* Validate whether the class is enhanced.
* @return Return true if already enhanced class.
*/
boolean validate();
/**
* Method to enhance the class definition internally.
* @return Whether the class was enhanced successfully
*/
boolean enhance();
/**
* Method to save the (current) class definition bytecode into a class file.
* Only has effect if the bytecode has been modified (by enhance()).
* If directoryName is specified it will be written to $directoryName/className.class
* else will overwrite the existing class.
* @param directoryName Name of a directory (or null to overwrite the class)
* @throws IOException If an I/O error occurs in the write.
*/
void save(String directoryName) throws IOException;
/**
* Access the class bytecode.
* @return the class in byte array format
*/
byte[] getClassBytes();
/**
* Access the generated primary-key class bytecode.
* @return the primary-key class in byte array format
*/
byte[] getPrimaryKeyClassBytes();
/**
* Accessor for the MetaData manager in use.
* @return MetaData manager
*/
MetaDataManager getMetaDataManager();
/**
* Accessor for the ClassLoaderResolver in use.
* @return ClassLoader resolver
*/
ClassLoaderResolver getClassLoaderResolver();
/**
* Accessor for the ClassMetaData for the class.
* @return MetaData for the class
*/
ClassMetaData getClassMetaData();
/** Field name of StateManager */
String getStateManagerFieldName();
/** Field name of Flags */
String getFlagsFieldName();
/** Field name of FieldNames */
String getFieldNamesFieldName();
/** Field name of FieldTypes */
String getFieldTypesFieldName();
/** Field name of FieldFlags */
String getFieldFlagsFieldName();
/** Field name of PersistenceCapableSuperclass */
String getPersistableSuperclassFieldName();
/** Field name of FieldCount */
String getInheritedFieldCountFieldName();
/** Field name of DetachedState */
String getDetachedStateFieldName();
/** Field name of serialVersionUID */
String getSerialVersionUidFieldName();
/** Method name for initialising FieldNames */
String getFieldNamesInitMethodName();
/** Method name for initialising FieldTypes */
String getFieldTypesInitMethodName();
/** Method name for initialising FieldFlags */
String getFieldFlagsInitMethodName();
/** Method name for object id accessor */
String getGetObjectIdMethodName();
/** Method name for transactional object id accessor */
String getGetTransactionalObjectIdMethodName();
/** Method name for version accessor */
String getGetVersionMethodName();
/** Method name of IsDetached */
String getIsDetachedMethodName();
/** Method name of IsDetachedInternal */
String getIsDetachedInternalMethodName();
/** Method name of IsDeleted */
String getIsDeletedMethodName();
/** Method name of IsDirty */
String getIsDirtyMethodName();
/** Method name of IsNew */
String getIsNewMethodName();
/** Method name of IsPersistent */
String getIsPersistentMethodName();
/** Method name of IsTransactional */
String getIsTransactionalMethodName();
/** Method name of GetPersistenceManager */
String getGetPersistenceManagerMethodName();
/** Method name of PreSerialize */
String getPreSerializeMethodName();
/** Method name for GetInheritedFieldCount */
String getGetInheritedFieldCountMethodName();
/** Method name for SuperClone */
String getSuperCloneMethodName();
/** Method name for GetManagedFieldCount */
String getGetManagedFieldCountMethodName();
/** Method name for PersistableSuperclassInit */
String getPersistableSuperclassInitMethodName();
/** Method name of LoadClass */
String getLoadClassMethodName();
/** Method name of CopyField */
String getCopyFieldMethodName();
/** Method name of CopyFields */
String getCopyFieldsMethodName();
/** Method name of CopyFieldsFromObjectId */
String getCopyKeyFieldsFromObjectIdMethodName();
/** Method name of CopyFieldsToObjectId */
String getCopyKeyFieldsToObjectIdMethodName();
/** Method name of ProvideField */
String getProvideFieldMethodName();
/** Method name of ProvideFields */
String getProvideFieldsMethodName();
/** Method name of ReplaceField */
String getReplaceFieldMethodName();
/** Method name of ReplaceFields. */
String getReplaceFieldsMethodName();
/** Method name of ReplaceFlags. */
String getReplaceFlagsMethodName();
/** Method name of ReplaceStateManager. */
String getReplaceStateManagerMethodName();
/** Method name of ReplaceDetachedState. */
String getReplaceDetachedStateMethodName();
/** Method name of MakeDirty. */
String getMakeDirtyMethodName();
/** Method name of MakeDirtyDetached. */
String getMakeDirtyDetachedMethodName();
/** Method name of NewInstance. */
String getNewInstanceMethodName();
/** Method name of NewObjectIdInstance. */
String getNewObjectIdInstanceMethodName();
/** Prefix for method names for getXXX. */
String getGetMethodPrefixMethodName();
/** Prefix for method names for setXXX. */
String getSetMethodPrefixMethodName();
/** Class name of Helper */
String getHelperClassName();
/** Class name of ImplHelper */
String getImplHelperClassName();
/** Class name of FatalInternalException */
String getFatalInternalExceptionClassName();
/** Class name of DetachedFieldAccessException */
String getDetachedFieldAccessExceptionClassName();
/** ASM class name for StateManager. */
String getStateManagerAsmClassName();
/** ASM class name for PersistenceManager. */
String getPersistenceManagerAsmClassName();
/** ASM class name for Persistable. */
String getPersistableAsmClassName();
/** ASM class name for Detachable. */
String getDetachableAsmClassName();
/** ASM class name for ObjectIdFieldConsumer. */
String getObjectIdFieldConsumerAsmClassName();
/** ASM class name for ObjectIdFieldSupplier. */
String getObjectIdFieldSupplierAsmClassName();
/** ASM class name for DetachedFieldAccessException. */
String getDetachedFieldAccessExceptionAsmClassName();
/** ASM class name for FatalInternalException. */
String getFatalInternalExceptionAsmClassName();
/** ASM class name for Helper. */
String getHelperAsmClassName();
/** ASM class name for ImplHelper. */
String getImplHelperAsmClassName();
/** Descriptor for ByteIdentity. */
String getByteIdentityDescriptor();
/** Descriptor for CharIdentity. */
String getCharIdentityDescriptor();
/** Descriptor for IntIdentity. */
String getIntIdentityDescriptor();
/** Descriptor for LongIdentity. */
String getLongIdentityDescriptor();
/** Descriptor for ShortIdentity. */
String getShortIdentityDescriptor();
/** Descriptor for StringIdentity. */
String getStringIdentityDescriptor();
/** Descriptor for ObjectIdentity. */
String getObjectIdentityDescriptor();
/**
* Accessor for the descriptor for a SingleFieldIdentity type.
* @param oidClassName Name of the SingleFieldIdentity class
* @return The descriptor of the SingleFieldIdentity type
*/
String getSingleFieldIdentityDescriptor(String oidClassName);
/**
* Method to return the type descriptor for the key of the provided single-field identity class name.
* @param oidClassName Single-field identity class name
* @return The type descriptor for the key
*/
String getTypeDescriptorForSingleFieldIdentityGetKey(String oidClassName);
/**
* Convenience method to give the method type name for a singleFieldIdentity class name.
* Used for aaaCopyKeyFields[To/From]ObjectId and defines the "type name" used for things like storeXXXField.
*
* - Byte, byte : returns "Byte"
* - Character, char : returns "Char"
* - Integer, int : returns "Int"
* - Long, long : returns "Long"
* - Short, short : returns "Short"
* - String : returns "String"
* - all others : returns "Object"
*
* @param oidClassName Name of the single field identity class
* @return Name for the method
*/
String getTypeNameForUseWithSingleFieldIdentity(String oidClassName);
/** Descriptor for javax.jdo.spi.StateManager. */
String getStateManagerDescriptor();
/** Descriptor for javax.jdo.PersistenceManager. */
String getPersistenceManagerDescriptor();
/** Descriptor for javax.jdo.spi.PersistenceCapable. */
String getPersistableDescriptor();
/** Descriptor for javax.jdo.spi.Detachable. */
String getDetachableDescriptor();
/** Descriptor for ObjectIdFieldConsumer. */
String getObjectIdFieldConsumerDescriptor();
/** Descriptor for ObjectIdFieldSupplier. */
String getObjectIdFieldSupplierDescriptor();
/** Class for the PersistenceManager interface. */
Class getPersistenceManagerClass();
/** Class for the StateManager interface. */
Class getStateManagerClass();
/** Class for the Persistable interface. */
Class getPersistableClass();
/** Class for the Detachable interface. */
Class getDetachableClass();
/** Class for ObjectIdFieldSupplier. */
Class getObjectIdFieldSupplierClass();
/** Class for ObjectIdFieldConsumer. */
Class getObjectIdFieldConsumerClass();
/** Class for ObjectIdentity. */
Class getObjectIdentityClass();
}