org.datanucleus.enhancer

Class ClassMethod

java.lang.Object

org.datanucleus.enhancer.ClassMethod

Direct Known Subclasses:

DefaultConstructor, InitClass, InitFieldFlags, InitFieldNames, InitFieldTypes, InitPersistenceCapableSuperclass, JdoCopyField, JdoCopyFields, JdoCopyKeyFieldsFromObjectId, JdoCopyKeyFieldsFromObjectId2, JdoCopyKeyFieldsToObjectId, JdoCopyKeyFieldsToObjectId2, JdoGetInheritedFieldCount, JdoGetManagedFieldCount, JdoGetNormal, JdoGetObjectId, JdoGetPersistenceManager, JdoGetTransactionalObjectId, JdoGetVersion, JdoGetViaCheck, JdoGetViaMediate, JdoIsDetached, JdoIsDirty, JdoIsXXX, JdoMakeDirty, JdoNewInstance1, JdoNewInstance2, JdoNewObjectIdInstance1, JdoNewObjectIdInstance2, JdoPreSerialize, JdoProvideField, JdoProvideFields, JdoReplaceDetachedState, JdoReplaceField, JdoReplaceFields, JdoReplaceFlags, JdoReplaceStateManager, JdoSetNormal, JdoSetViaCheck, JdoSetViaMediate, JdoSuperClone, LoadClass, WriteObject

public abstract class ClassMethod
extends Object

Representation of a method that an enhanced class requires.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	access Access flags for the method (public, protected etc).
protected String[]	argNames Names of the arguments.
protected Object[]	argTypes Types of the arguments.
protected ClassEnhancer	enhancer The parent enhancer.
protected String[]	exceptions Exceptions that can be thrown.
protected static Localiser	LOCALISER Localisation of messages
protected String	methodName Name of the method.
protected Object	returnType Return type for the method
protected MethodVisitor	visitor Visitor for use in updating the method of the class (set in initialise).

Constructor Summary

Constructors

Constructor and Description
ClassMethod(ClassEnhancer enhancer, String name, int access, Object returnType, Object[] argTypes, String[] argNames) Constructor.
ClassMethod(ClassEnhancer enhancer, String name, int access, Object returnType, Object[] argTypes, String[] argNames, String[] exceptions) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Method to close the definition of the class method.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
abstract void	execute() Method to add the contents of the class method.
int	getAccess() Accessor for the access
protected ClassEnhancer	getClassEnhancer() Convenience accessor for the ClassEnhancer
String	getDescriptor() Accessor for the descriptor of the method.
static String	getMethodAdditionMessage(String methodName, Object returnType, Object[] argTypes, String[] argNames) Convenience method to generate a message that a method has been added.
String	getName() Accessor for the method name
EnhancementNamer	getNamer()
int	hashCode() Return hash code of this instance.
void	initialise() Default implementation of initialise, specifying the method based on the ClassMethod info.
void	initialise(ClassVisitor classVisitor) Method to initialise the class method.

Methods inherited from class java.lang.Object

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

Field Detail

LOCALISER

protected static final Localiser LOCALISER

Localisation of messages

enhancer

protected ClassEnhancer enhancer

The parent enhancer.

methodName

protected String methodName

Name of the method.

access

protected int access

Access flags for the method (public, protected etc).

returnType

protected Object returnType

Return type for the method

argTypes

protected Object[] argTypes

Types of the arguments.

argNames

protected String[] argNames

Names of the arguments.

exceptions

protected String[] exceptions

Exceptions that can be thrown.

visitor

protected MethodVisitor visitor

Visitor for use in updating the method of the class (set in initialise).

Constructor Detail

ClassMethod

public ClassMethod(ClassEnhancer enhancer,
           String name,
           int access,
           Object returnType,
           Object[] argTypes,
           String[] argNames)

Constructor.

Parameters:

enhancer - ClassEnhancer

name - Name of the method

access - Access for the method (PUBLIC, PROTECTED etc)

returnType - Return type

argTypes - Argument type(s)

argNames - Argument name(s)

ClassMethod

public ClassMethod(ClassEnhancer enhancer,
           String name,
           int access,
           Object returnType,
           Object[] argTypes,
           String[] argNames,
           String[] exceptions)

Constructor.

Parameters:

enhancer - ClassEnhancer

name - Name of the method

access - Access for the method (PUBLIC, PROTECTED etc)

returnType - Return type

argTypes - Argument type(s)

argNames - Argument name(s)

exceptions - Exceptions that can be thrown

Method Detail

initialise

public void initialise()

Default implementation of initialise, specifying the method based on the ClassMethod info.

initialise

public void initialise(ClassVisitor classVisitor)

Method to initialise the class method.

Parameters:

classVisitor - Visitor for the class

getClassEnhancer

protected ClassEnhancer getClassEnhancer()

Convenience accessor for the ClassEnhancer

Returns:

ClassEnhancer

getDescriptor

public String getDescriptor()

Accessor for the descriptor of the method.

Returns:

The descriptor

getNamer

public EnhancementNamer getNamer()

getName

public String getName()

Accessor for the method name

Returns:

Name of the method

getAccess

public int getAccess()

Accessor for the access

Returns:

Access for the method

execute

public abstract void execute()

Method to add the contents of the class method.

close

public void close()

Method to close the definition of the class method. This implementation simply logs a debug message to category ENHANCER.

hashCode

public int hashCode()

Return hash code of this instance.

Overrides:

hashCode in class Object

Returns:

hash code of this instance

equals

public boolean equals(Object o)

Indicates whether some other object is "equal to" this one.

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

getMethodAdditionMessage

public static String getMethodAdditionMessage(String methodName,
                              Object returnType,
                              Object[] argTypes,
                              String[] argNames)

Convenience method to generate a message that a method has been added.

Parameters:

methodName - Name of the method

returnType - Return type of the method

argTypes - arg types for the method

argNames - arg names for the method

Returns:

The message