org.datanucleus.enhancer

Class AbstractClassEnhancer

java.lang.Object

org.datanucleus.enhancer.AbstractClassEnhancer

All Implemented Interfaces:

ClassEnhancer

Direct Known Subclasses:

JDOClassEnhancer

public abstract class AbstractClassEnhancer
extends Object
implements ClassEnhancer

Abstract representation of a class enhancer. To be extended by implementing enhancers.

Field Summary

Fields

Modifier and Type	Field and Description
String	className Class name of the class being enhanced
protected ClassLoaderResolver	clr Class Loader Resolver to use for any loading issues.
protected ClassMetaData	cmd MetaData for the class being enhanced.
protected List<ClassField>	fieldsToAdd List of fields to be added to the class.
protected boolean	initialised Flag for whether we are initialised.
protected static Localiser	LOCALISER
protected MetaDataManager	metaDataMgr MetaData Manager to use.
protected List<ClassMethod>	methodsToAdd List of methods to be added to the class.
protected Collection<String>	options Options for enhancement.
protected boolean	update Flag specifying if the class needs updating.

Fields inherited from interface org.datanucleus.enhancer.ClassEnhancer

ASM_API_VERSION, OPTION_GENERATE_DEFAULT_CONSTRUCTOR, OPTION_GENERATE_DETACH_LISTENER, OPTION_GENERATE_PK

Constructor Summary

Constructors

Constructor and Description
AbstractClassEnhancer(ClassMetaData cmd, ClassLoaderResolver clr, MetaDataManager mmgr) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
ClassLoaderResolver	getClassLoaderResolver() Accessor for the ClassLoaderResolver
ClassMetaData	getClassMetaData() Accessor for the ClassMetaData for the class.
String	getClassName() Accessor for the name of the class being enhanced.
List<ClassField>	getFieldsList() Accessor for the fields required.
MetaDataManager	getMetaDataManager() Accessor for the MetaData manager in use.
List<ClassMethod>	getMethodsList() Accessor for the methods required.
boolean	hasOption(String name) Accessor for whether a particular option is enabled.
protected void	initialise() Initialisation of the information for enhancing this class.
protected abstract void	initialiseFieldsList() Method to initialise the list of fields to add.
protected abstract void	initialiseMethodsList() Method to initialise the list of methods to add.
boolean	isPersistable(String className) Check if the class is Persistable or is going to be enhanced based on the metadata
protected boolean	requiresDetachable() Convenience method for whether this class needs to implement Detachable
void	save(String directoryName) Method to save the class definition bytecode into a class file.
void	setOptions(Collection<String> options) Method to set the options controlling the enhancement.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.datanucleus.enhancer.ClassEnhancer

enhance, getASMClassName, getClassBeingEnhanced, getClassBytes, getClassDescriptor, getNamer, getPrimaryKeyClassBytes, setNamer, validate

Field Detail

LOCALISER

protected static final Localiser LOCALISER

clr

protected final ClassLoaderResolver clr

Class Loader Resolver to use for any loading issues.

metaDataMgr

protected final MetaDataManager metaDataMgr

MetaData Manager to use.

cmd

protected final ClassMetaData cmd

MetaData for the class being enhanced.

className

public final String className

Class name of the class being enhanced

update

protected boolean update

Flag specifying if the class needs updating.

fieldsToAdd

protected List<ClassField> fieldsToAdd

List of fields to be added to the class.

methodsToAdd

protected List<ClassMethod> methodsToAdd

List of methods to be added to the class.

initialised

protected boolean initialised

Flag for whether we are initialised.

options

protected Collection<String> options

Options for enhancement.

Constructor Detail

AbstractClassEnhancer

public AbstractClassEnhancer(ClassMetaData cmd,
                     ClassLoaderResolver clr,
                     MetaDataManager mmgr)

Constructor.

Parameters:

cmd - MetaData for the class to be enhanced

clr - ClassLoader resolver

mmgr - MetaData manager

Method Detail

initialise

protected void initialise()

Initialisation of the information for enhancing this class.

getClassName

public String getClassName()

Description copied from interface: ClassEnhancer

Accessor for the name of the class being enhanced.

Specified by:

getClassName in interface ClassEnhancer

Returns:

Class name

initialiseMethodsList

protected abstract void initialiseMethodsList()

Method to initialise the list of methods to add.

initialiseFieldsList

protected abstract void initialiseFieldsList()

Method to initialise the list of fields to add.

getMethodsList

public List<ClassMethod> getMethodsList()

Accessor for the methods required.

Specified by:

getMethodsList in interface ClassEnhancer

Returns:

List of methods required for enhancement

getFieldsList

public List<ClassField> getFieldsList()

Accessor for the fields required.

Specified by:

getFieldsList in interface ClassEnhancer

Returns:

List of fields required for enhancement

getClassLoaderResolver

public ClassLoaderResolver getClassLoaderResolver()

Accessor for the ClassLoaderResolver

Specified by:

getClassLoaderResolver in interface ClassEnhancer

Returns:

ClassLoader resolver

getMetaDataManager

public MetaDataManager getMetaDataManager()

Description copied from interface: ClassEnhancer

Accessor for the MetaData manager in use.

Specified by:

getMetaDataManager in interface ClassEnhancer

Returns:

MetaData manager

getClassMetaData

public ClassMetaData getClassMetaData()

Description copied from interface: ClassEnhancer

Accessor for the ClassMetaData for the class.

Specified by:

getClassMetaData in interface ClassEnhancer

Returns:

MetaData for the class

requiresDetachable

protected boolean requiresDetachable()

Convenience method for whether this class needs to implement Detachable

Returns:

Whether we need to implement the Detachable interface

isPersistable

public boolean isPersistable(String className)

Check if the class is Persistable or is going to be enhanced based on the metadata

Specified by:

isPersistable in interface ClassEnhancer

Parameters:

className - the class name

Returns:

true if Persistable

setOptions

public void setOptions(Collection<String> options)

Description copied from interface: ClassEnhancer

Method to set the options controlling the enhancement.

Specified by:

setOptions in interface ClassEnhancer

Parameters:

options - The options

hasOption

public boolean hasOption(String name)

Description copied from interface: ClassEnhancer

Accessor for whether a particular option is enabled.

Specified by:

hasOption in interface ClassEnhancer

Parameters:

name - Name of the option

Returns:

Whether it has this option

save

public void save(String directoryName)
          throws IOException

Method to save the class definition bytecode into a class file. If directoryName is specified it will be written to $directoryName/className.class else will overwrite the existing class.

Specified by:

save in interface ClassEnhancer

Parameters:

directoryName - Name of a directory (or null to overwrite the class)

Throws:

IOException - If an I/O error occurs in the write.