jmplib

Class TransactionalIntercessor

java.lang.Object

jmplib.TransactionalIntercessor

All Implemented Interfaces:

IIntercessor

public class TransactionalIntercessor
extends java.lang.Object
implements IIntercessor

An intercessor of classes. This class is the fa�ade of JMPlib and provides all the primitive support (add method, replace method, delete method...) and the methods that allow to create invokers for the new members. Contrary to SimpleIntercessor, this class supports the execution of several primitives simultaneously as a transaction.

Version:

1.3 (Redondo) Duplicate code with Intercessor moved to IntercessorUtils. Added many new services, integrating the jmplib.reflect classes and also new primitives (import and annotation manipulation, instance "type change"). Once commited, this intercessor is able to process a new set of primitives.

Author:

Ignacio Lagartos, Jose Manuel Redondo

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Queue<Primitive>	primitives

Constructor Summary

Constructors

Constructor and Description
TransactionalIntercessor()

Method Summary

Modifier and Type	Method and Description
void	addAnnotation(Method method, java.lang.reflect.Type... annotationObjects)
void	addAnnotation(java.lang.reflect.Type clazz, java.lang.reflect.Type... annotationObjects) Add the provided annotations to the specified class.
void	addField(java.lang.reflect.Type clazz, Field... fields)
void	addGenericType(Method method, TypeVariable<?>... types)
void	addGenericType(java.lang.reflect.Type clazz, TypeVariable<?>... types) Add the provided generic type to the specified class.
void	addImport(java.lang.reflect.Type clazz, Class<?>... importObjects)
void	addImport(java.lang.reflect.Type clazz, java.lang.Package... importObjects) Add the provided imports to the source file that defines the specified class.
void	addInterface(java.lang.reflect.Type clazz, java.util.Map<java.lang.reflect.Type,java.lang.reflect.Type[]> interfs) Version of the previous method able to add multiple interfaces.
void	addInterface(java.lang.reflect.Type clazz, java.lang.reflect.Type interf, java.lang.reflect.Type... typeParameters) Adds an interface to the provided class.
void	addMethod(java.lang.reflect.Type clazz, Method... methods)
void	addPublicInterfaceOf(java.lang.reflect.Type origin, java.lang.reflect.Type destination) Adds all the members of the public interface of the specified class to another class
void	commit() Performs the operations indicated to the intercessor, if the intercessor has the ability to store the operations until they are executed at the same time.
Class<?>	createClassClone(java.lang.String packageName, java.lang.String className, java.lang.reflect.Type origin) Creates a class clone of the specified class with the specified name and belonging to the provided package
IIntercessor	createIntercessor() Creates an instance of the intercessor implementing this interface
java.lang.reflect.AnnotatedElement[]	getImports(java.lang.reflect.Type clazz) Get the imports of the source file that defines the specified class.
void	implementInterface(java.lang.reflect.Type clazz, java.lang.reflect.Type interf, Method[] methods, java.lang.Class<?>... typeParameters)
void	removeField(java.lang.reflect.Type clazz, Field... fields)
void	removeInterface(java.lang.reflect.Type clazz, java.lang.reflect.Type interf) Removes an interface from a class
void	removeMethod(java.lang.reflect.Type clazz, Method... methods)
void	removeSuperclass(java.lang.reflect.Type clazz) Removes the superclass of an existing class, setting it to Object.
void	replaceField(java.lang.reflect.Type clazz, Field... fields)
void	replaceImplementation(java.lang.reflect.Type clazz, Method... methods)
void	replaceMethod(java.lang.reflect.Type clazz, java.util.Map<Method,Method> methods) Replaces a series of methods from the specified class For example, modifying the method to acept a more generic type (Dog -> Animal): // Creating MethodType MethodType newType = MethodType.methodType(void.class, Pet.class); // Modifying the method Intercessor.replaceMethod(Owner.class, new jmplib.reflect.Method("addPet", newType, "this.pet = dog;"));
void	replaceMethod(java.lang.reflect.Type clazz, Method method, Method newMethod)
void	setAnnotation(Method method, java.lang.reflect.Type... annotationObjects)
void	setAnnotation(java.lang.reflect.Type clazz, java.lang.reflect.Type... annotationObjects) Replace the annotations of the specified class with the provided ones.
void	setGenericType(Method method, TypeVariable<?>... types)
void	setGenericType(java.lang.reflect.Type clazz, TypeVariable<?>... types) Replace the generic types of the specified class with the provided ones.
void	setImports(java.lang.reflect.Type clazz, java.lang.reflect.AnnotatedElement... importObjects) Replace the imports of the source file that defines the specified class with the provided ones.
void	setSuperclass(java.lang.reflect.Type clazz, java.lang.reflect.Type superclazz, java.lang.reflect.Type... typeParameters) Changes the superclass of an existing class, modifying member visibilities accordingly.

Methods inherited from class java.lang.Object

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

Methods inherited from interface jmplib.IIntercessor

addAnnotation, addField, addGenericType, addImport, addMethod, implementInterface, removeField, removeMethod, replaceField, replaceImplementation, replaceMethod, setAnnotation, setGenericType

Field Detail

primitives

protected final java.util.Queue<Primitive> primitives

Constructor Detail

TransactionalIntercessor

public TransactionalIntercessor()

Method Detail

createIntercessor

public IIntercessor createIntercessor()

Creates an instance of the intercessor implementing this interface

Specified by:

createIntercessor in interface IIntercessor

Returns:

An intercessor instance

addField

public void addField(java.lang.reflect.Type clazz,
                     Field... fields)
              throws StructuralIntercessionException

Specified by:

addField in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.addField(Type, java.lang.reflect.Field...)

replaceField

public void replaceField(java.lang.reflect.Type clazz,
                         Field... fields)
                  throws StructuralIntercessionException

Specified by:

replaceField in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.replaceField(Type, java.lang.reflect.Field...)

removeField

public void removeField(java.lang.reflect.Type clazz,
                        Field... fields)
                 throws StructuralIntercessionException

Specified by:

removeField in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.removeField(Type, java.lang.reflect.Field...)

addMethod

public void addMethod(java.lang.reflect.Type clazz,
                      Method... methods)
               throws StructuralIntercessionException

Specified by:

addMethod in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.addMethod(Type, java.lang.reflect.Method...)

replaceMethod

public void replaceMethod(java.lang.reflect.Type clazz,
                          Method method,
                          Method newMethod)
                   throws StructuralIntercessionException

Specified by:

replaceMethod in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.replaceMethod(Type, java.lang.reflect.Method, java.lang.reflect.Method)

replaceMethod

public void replaceMethod(java.lang.reflect.Type clazz,
                          java.util.Map<Method,Method> methods)
                   throws StructuralIntercessionException

Replaces a series of methods from the specified class

For example, modifying the method to acept a more generic type (Dog -> Animal):

 // Creating MethodType
 MethodType newType = MethodType.methodType(void.class, Pet.class);

 // Modifying the method
 Intercessor.replaceMethod(Owner.class, new jmplib.reflect.Method("addPet", newType,
                "this.pet = dog;"));
 

Specified by:

replaceMethod in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

methods - Set of jmplib.reflect.Method or java.lang.reflect.Method to replace. The method name and type is used to identify the method to replace. The rest of the information is taken from the Method class.

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

replaceImplementation

public void replaceImplementation(java.lang.reflect.Type clazz,
                                  Method... methods)
                           throws StructuralIntercessionException

Specified by:

replaceImplementation in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.replaceImplementation(Type, java.lang.reflect.Method...)

removeMethod

public void removeMethod(java.lang.reflect.Type clazz,
                         Method... methods)
                  throws StructuralIntercessionException

Specified by:

removeMethod in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.removeMethod(Type, java.lang.reflect.Method...)

addPublicInterfaceOf

public void addPublicInterfaceOf(java.lang.reflect.Type origin,
                                 java.lang.reflect.Type destination)
                          throws StructuralIntercessionException

Adds all the members of the public interface of the specified class to another class

Specified by:

addPublicInterfaceOf in interface IIntercessor

Parameters:

origin - A java.lang.Class or a jmplib.reflect.Class

destination - A java.lang.Class or a jmplib.reflect.Class

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

createClassClone

public Class<?> createClassClone(java.lang.String packageName,
                                 java.lang.String className,
                                 java.lang.reflect.Type origin)
                          throws StructuralIntercessionException

Creates a class clone of the specified class with the specified name and belonging to the provided package

This operation works independently from the current transaction and does not commit it or modify its pending operations.

Specified by:

createClassClone in interface IIntercessor

Parameters:

packageName - Package name of the new class to be created

className - Name of the newly created class

origin - A java.lang.Class or a jmplib.reflect.Class

Returns:

A new class copying the class structure of the provided one

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

addInterface

public void addInterface(java.lang.reflect.Type clazz,
                         java.lang.reflect.Type interf,
                         java.lang.reflect.Type... typeParameters)
                  throws StructuralIntercessionException

Adds an interface to the provided class. The class must already provide implementations for all the interface methods

Specified by:

addInterface in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

interf - A java.lang.Class or a jmplib.reflect.Class representing an interface to add

typeParameters - Types of the generic parameters of the interface to be added. This is an optional parameter. However, if specified, it must comply with the expected type parameter number of the passed interface.

Example:

To add the Comparable interface to the Dog object, the call should be:

Intercessor.addInterface(Dog.class, Comparable.class);

The call will fail if the Dog class do not have a compareTo(Object) method already added.

If we need to add the Comparable interface instead, then the call should be:

Intercessor.addInterface(Dog.class, Comparable.class, Dog.class);

The call will fail if the Dog class do not have a compareTo(Dog) method already added.

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

addInterface

public void addInterface(java.lang.reflect.Type clazz,
                         java.util.Map<java.lang.reflect.Type,java.lang.reflect.Type[]> interfs)
                  throws StructuralIntercessionException

Version of the previous method able to add multiple interfaces.

Specified by:

addInterface in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

interfs - A collection of objects representing interfaces and their type parameters

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

removeInterface

public void removeInterface(java.lang.reflect.Type clazz,
                            java.lang.reflect.Type interf)
                     throws StructuralIntercessionException

Removes an interface from a class

Specified by:

removeInterface in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

interf - A java.lang.Class or a jmplib.reflect.Class representing an interface

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

implementInterface

public void implementInterface(java.lang.reflect.Type clazz,
                               java.lang.reflect.Type interf,
                               Method[] methods,
                               java.lang.Class<?>... typeParameters)
                        throws StructuralIntercessionException

Specified by:

implementInterface in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.implementInterface(Type, Type, java.lang.reflect.Method[], Class...)

setSuperclass

public void setSuperclass(java.lang.reflect.Type clazz,
                          java.lang.reflect.Type superclazz,
                          java.lang.reflect.Type... typeParameters)
                   throws StructuralIntercessionException

Changes the superclass of an existing class, modifying member visibilities accordingly.

Specified by:

setSuperclass in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

superclazz - A java.lang.Class or a jmplib.reflect.Class

typeParameters - Type parameters of the new superclass

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

removeSuperclass

public void removeSuperclass(java.lang.reflect.Type clazz)
                      throws StructuralIntercessionException

Removes the superclass of an existing class, setting it to Object.

Specified by:

removeSuperclass in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

addImport

public void addImport(java.lang.reflect.Type clazz,
                      Class<?>... importObjects)
               throws StructuralIntercessionException

Specified by:

addImport in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.addImport(Type, Class...)

addImport

public void addImport(java.lang.reflect.Type clazz,
                      java.lang.Package... importObjects)
               throws StructuralIntercessionException

Add the provided imports to the source file that defines the specified class.

Specified by:

addImport in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

importObjects - Packages to add as imports to the source file of the class

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

getImports

public java.lang.reflect.AnnotatedElement[] getImports(java.lang.reflect.Type clazz)
                                                throws StructuralIntercessionException

Get the imports of the source file that defines the specified class. This operation works independently from the current transaction and does not commit it or modify its pending operations.

Specified by:

getImports in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

Returns:

The import set of the file that defines the provided class

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

setImports

public void setImports(java.lang.reflect.Type clazz,
                       java.lang.reflect.AnnotatedElement... importObjects)
                throws StructuralIntercessionException

Replace the imports of the source file that defines the specified class with the provided ones.

Specified by:

setImports in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

importObjects - Modifies the import set of the file that defines the provided class

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

addAnnotation

public void addAnnotation(java.lang.reflect.Type clazz,
                          java.lang.reflect.Type... annotationObjects)
                   throws StructuralIntercessionException

Add the provided annotations to the specified class.

Specified by:

addAnnotation in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

annotationObjects - Set of annotations to be used to add to the existing ones.

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

setAnnotation

public void setAnnotation(java.lang.reflect.Type clazz,
                          java.lang.reflect.Type... annotationObjects)
                   throws StructuralIntercessionException

Replace the annotations of the specified class with the provided ones.

Specified by:

setAnnotation in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

annotationObjects - Set of annotations to be used to replace the existing ones.

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

addAnnotation

public void addAnnotation(Method method,
                          java.lang.reflect.Type... annotationObjects)
                   throws StructuralIntercessionException

Specified by:

addAnnotation in interface IIntercessor

Throws:

StructuralIntercessionException

setAnnotation

public void setAnnotation(Method method,
                          java.lang.reflect.Type... annotationObjects)
                   throws StructuralIntercessionException

Specified by:

setAnnotation in interface IIntercessor

Throws:

StructuralIntercessionException

addGenericType

public void addGenericType(java.lang.reflect.Type clazz,
                           TypeVariable<?>... types)
                    throws StructuralIntercessionException

Add the provided generic type to the specified class.

Specified by:

addGenericType in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

types - Set of generic types to be used to add to the existing ones.

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

setGenericType

public void setGenericType(java.lang.reflect.Type clazz,
                           TypeVariable<?>... types)
                    throws StructuralIntercessionException

Replace the generic types of the specified class with the provided ones.

Specified by:

setGenericType in interface IIntercessor

Parameters:

clazz - A java.lang.Class or a jmplib.reflect.Class

types - Set of generic types to be used to replace the existing ones.

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)

addGenericType

public void addGenericType(Method method,
                           TypeVariable<?>... types)
                    throws StructuralIntercessionException

Specified by:

addGenericType in interface IIntercessor

Throws:

StructuralIntercessionException

setGenericType

public void setGenericType(Method method,
                           TypeVariable<?>... types)
                    throws StructuralIntercessionException

Specified by:

setGenericType in interface IIntercessor

Throws:

StructuralIntercessionException

See Also:

IIntercessor.setGenericType(Method, TypeVariable[])

commit

public void commit()
            throws StructuralIntercessionException

Performs the operations indicated to the intercessor, if the intercessor has the ability to store the operations until they are executed at the same time. This enables the creation of a single class version with all the specified operations included, instead of a new version per operation. Some intercessors may not have an implementation for this operation. Therefore, is implemented as empty by default.

Specified by:

commit in interface IIntercessor

Throws:

StructuralIntercessionException - If problems with the metaprogramming primitives are detected (exception message indicates the concrete problem, as it wraps the inner exception)