org.opendaylight.mdsal.binding.javav2.runtime.javassist

Class JavassistUtils

java.lang.Object

org.opendaylight.mdsal.binding.javav2.runtime.javassist.JavassistUtils

@Beta
public final class JavassistUtils
extends Object

Users of this utility class are expected to synchronize on this instance it they need to ensure atomic operations on it.

Method Summary

Modifier and Type	Method and Description
void	appendClassLoaderIfMissing(ClassLoader loader) Append class to class pool if doesn't exist.
javassist.CtClass	asCtClass(Class<?> class1) Get class from class pool.
javassist.CtClass	createClass(String className, ClassGenerator classGenerator) Generate and add class to global class pool.
javassist.CtClass	createClass(String className, javassist.CtClass superInterface, ClassGenerator classGenerator) Generate and add class to global class pool with implemented interface.
void	ensureClassLoader(Class<?> child) Ensure if is class in class loader.
javassist.CtField	field(javassist.CtClass baseClass, String fieldName, Class<?> fieldType) Create and add field to class.
static JavassistUtils	forClassPool(javassist.ClassPool pool) Get a utility instance for a particular class pool.
javassist.CtClass	get(javassist.ClassPool pool, Class<? extends Object> clazz) Get class from pool.
void	implementMethodsFrom(javassist.CtClass target, javassist.CtClass source, MethodGenerator methodGenerator) Implement methods to class from other class.
void	implementsType(javassist.CtClass baseClass, javassist.CtClass superInterface) Implements type to class.
javassist.CtClass	instantiatePrototype(String prototype, String target, ClassCustomizer customizer) Instantiate a new class based on a prototype.
void	method(javassist.CtClass baseClass, Class<?> methodReturnType, String methodName, Class<?> methodParameter, MethodGenerator methodGenerator) Generate and add method to class.
void	method(javassist.CtClass baseClass, Class<?> methodReturnType, String methodName, Collection<? extends Class<?>> methodParameters, MethodGenerator methodGenerator) Generate and add method to class.
javassist.CtField	staticField(javassist.CtClass baseClass, String fieldName, Class<?> fieldType) Create and add static field to class.
javassist.CtField	staticField(javassist.CtClass baseClass, String fieldName, Class<?> fieldType, SourceCodeGenerator sourceGenerator) Create and add static field to class.
void	staticMethod(javassist.CtClass baseClass, Class<?> methodReturnType, String methodName, Class<?> methodParameter, MethodGenerator methodGenerator) Generate and add static method to class.

Methods inherited from class java.lang.Object

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

Method Detail

forClassPool

public static JavassistUtils forClassPool(javassist.ClassPool pool)

Get a utility instance for a particular class pool. A new instance is created if this is a new pool. If an instance already exists, is is returned.

Parameters:

pool - - backing class pool

Returns:

shared utility instance for specified pool

method

public void method(javassist.CtClass baseClass,
                   Class<?> methodReturnType,
                   String methodName,
                   Class<?> methodParameter,
                   MethodGenerator methodGenerator)
            throws javassist.CannotCompileException

Generate and add method to class.

Parameters:

baseClass - - class for adding method

methodReturnType - - return type of method

methodName - - name of method

methodParameter - - parameter of method

methodGenerator - - method generator

Throws:

javassist.CannotCompileException

method

public void method(javassist.CtClass baseClass,
                   Class<?> methodReturnType,
                   String methodName,
                   Collection<? extends Class<?>> methodParameters,
                   MethodGenerator methodGenerator)
            throws javassist.CannotCompileException

Generate and add method to class.

Parameters:

baseClass - - class for adding method

methodReturnType - - return type of method

methodName - - name of method

methodParameters - - parameters of method

methodGenerator - - method generator

Throws:

javassist.CannotCompileException

staticMethod

public void staticMethod(javassist.CtClass baseClass,
                         Class<?> methodReturnType,
                         String methodName,
                         Class<?> methodParameter,
                         MethodGenerator methodGenerator)
                  throws javassist.CannotCompileException

Generate and add static method to class.

Parameters:

baseClass - - class for adding method

methodReturnType - - return type of method

methodName - - name of method

methodParameter - - parameter of method

methodGenerator - - method generator

Throws:

javassist.CannotCompileException

implementMethodsFrom

public void implementMethodsFrom(javassist.CtClass target,
                                 javassist.CtClass source,
                                 MethodGenerator methodGenerator)
                          throws javassist.CannotCompileException

Implement methods to class from other class.

Parameters:

target - - class for implementing methods

source - - source class of methods to be implemented in target

methodGenerator - - method generator

Throws:

javassist.CannotCompileException

createClass

public javassist.CtClass createClass(String className,
                                     ClassGenerator classGenerator)
                              throws javassist.CannotCompileException

Generate and add class to global class pool.

Parameters:

className - - name of class

classGenerator - - class generator

Returns:

generated class

Throws:

javassist.CannotCompileException

createClass

public javassist.CtClass createClass(String className,
                                     javassist.CtClass superInterface,
                                     ClassGenerator classGenerator)
                              throws javassist.CannotCompileException

Generate and add class to global class pool with implemented interface.

Parameters:

className - - name of class

superInterface - - interface to be implemented to the class

classGenerator - - class generator

Returns:

generated class with interface

Throws:

javassist.CannotCompileException

instantiatePrototype

public javassist.CtClass instantiatePrototype(String prototype,
                                              String target,
                                              ClassCustomizer customizer)
                                       throws javassist.NotFoundException

Instantiate a new class based on a prototype. The class is set to automatically prune.

Parameters:

prototype - - prototype class fully qualified name

target - - target class fully qualified name

customizer - - customization callback to be invoked on the new class

Returns:

An instance of the new class

Throws:

javassist.NotFoundException - - when the prototype class is not found

implementsType

public void implementsType(javassist.CtClass baseClass,
                           javassist.CtClass superInterface)

Implements type to class.

Parameters:

baseClass - - class for implements interface

superInterface - - interface to be implemented

asCtClass

public javassist.CtClass asCtClass(Class<?> class1)

Get class from class pool.

Parameters:

class1 - - class for getting from class pool

Returns:

class

field

public javassist.CtField field(javassist.CtClass baseClass,
                               String fieldName,
                               Class<?> fieldType)
                        throws javassist.CannotCompileException

Create and add field to class.

Parameters:

baseClass - - class for adding field

fieldName - - name of field

fieldType - - type of field

Returns:

class of field

Throws:

javassist.CannotCompileException

staticField

public javassist.CtField staticField(javassist.CtClass baseClass,
                                     String fieldName,
                                     Class<?> fieldType)
                              throws javassist.CannotCompileException

Create and add static field to class.

Parameters:

baseClass - - class for adding field

fieldName - - name of field

fieldType - - type of field

Returns:

class of field

Throws:

javassist.CannotCompileException

staticField

public javassist.CtField staticField(javassist.CtClass baseClass,
                                     String fieldName,
                                     Class<?> fieldType,
                                     SourceCodeGenerator sourceGenerator)
                              throws javassist.CannotCompileException

Create and add static field to class.

Parameters:

baseClass - - class for adding field

fieldName - - name of field

fieldType - - type of field

sourceGenerator - - source generator

Returns:

class of field

Throws:

javassist.CannotCompileException

get

public javassist.CtClass get(javassist.ClassPool pool,
                             Class<? extends Object> clazz)

Get class from pool.

Parameters:

pool - - class pool

clazz - - search class in class pool

Returns:

class if exists

appendClassLoaderIfMissing

public void appendClassLoaderIfMissing(ClassLoader loader)

Append class to class pool if doesn't exist.

Parameters:

loader - - class loader of search class

ensureClassLoader

public void ensureClassLoader(Class<?> child)

Ensure if is class in class loader.

Parameters:

child - - search class