io.micronaut.inject.writer

Class AbstractClassFileWriter

java.lang.Object

io.micronaut.inject.writer.AbstractClassFileWriter

All Implemented Interfaces:

org.objectweb.asm.Opcodes

Direct Known Subclasses:

AbstractAnnotationMetadataWriter, AnnotationMetadataWriter, AopProxyWriter, BeanDefinitionWriter

@Internal
public abstract class AbstractClassFileWriter
extends Object
implements org.objectweb.asm.Opcodes

Abstract class that writes generated classes to disk and provides convenience methods for building classes.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONSTRUCTOR_NAME
protected static int	DEFAULT_MAX_STACK
protected static String	DESCRIPTOR_DEFAULT_CONSTRUCTOR
protected static org.objectweb.asm.commons.Method	METHOD_DEFAULT_CONSTRUCTOR
protected static Map<String,String>	NAME_TO_TYPE_MAP
protected static org.objectweb.asm.Type	TYPE_CLASS
protected static org.objectweb.asm.Type	TYPE_OBJECT

Fields inherited from interface org.objectweb.asm.Opcodes

AALOAD, AASTORE, ACC_ABSTRACT, ACC_ANNOTATION, ACC_BRIDGE, ACC_DEPRECATED, ACC_ENUM, ACC_FINAL, ACC_INTERFACE, ACC_MANDATED, ACC_MODULE, ACC_NATIVE, ACC_OPEN, ACC_PRIVATE, ACC_PROTECTED, ACC_PUBLIC, ACC_STATIC, ACC_STATIC_PHASE, ACC_STRICT, ACC_SUPER, ACC_SYNCHRONIZED, ACC_SYNTHETIC, ACC_TRANSIENT, ACC_TRANSITIVE, ACC_VARARGS, ACC_VOLATILE, ACONST_NULL, ALOAD, ANEWARRAY, ARETURN, ARRAYLENGTH, ASM4, ASM5, ASM6, ASM7, ASTORE, ATHROW, BALOAD, BASTORE, BIPUSH, CALOAD, CASTORE, CHECKCAST, D2F, D2I, D2L, DADD, DALOAD, DASTORE, DCMPG, DCMPL, DCONST_0, DCONST_1, DDIV, DLOAD, DMUL, DNEG, DOUBLE, DREM, DRETURN, DSTORE, DSUB, DUP, DUP_X1, DUP_X2, DUP2, DUP2_X1, DUP2_X2, F_APPEND, F_CHOP, F_FULL, F_NEW, F_SAME, F_SAME1, F2D, F2I, F2L, FADD, FALOAD, FASTORE, FCMPG, FCMPL, FCONST_0, FCONST_1, FCONST_2, FDIV, FLOAD, FLOAT, FMUL, FNEG, FREM, FRETURN, FSTORE, FSUB, GETFIELD, GETSTATIC, GOTO, H_GETFIELD, H_GETSTATIC, H_INVOKEINTERFACE, H_INVOKESPECIAL, H_INVOKESTATIC, H_INVOKEVIRTUAL, H_NEWINVOKESPECIAL, H_PUTFIELD, H_PUTSTATIC, I2B, I2C, I2D, I2F, I2L, I2S, IADD, IALOAD, IAND, IASTORE, ICONST_0, ICONST_1, ICONST_2, ICONST_3, ICONST_4, ICONST_5, ICONST_M1, IDIV, IF_ACMPEQ, IF_ACMPNE, IF_ICMPEQ, IF_ICMPGE, IF_ICMPGT, IF_ICMPLE, IF_ICMPLT, IF_ICMPNE, IFEQ, IFGE, IFGT, IFLE, IFLT, IFNE, IFNONNULL, IFNULL, IINC, ILOAD, IMUL, INEG, INSTANCEOF, INTEGER, INVOKEDYNAMIC, INVOKEINTERFACE, INVOKESPECIAL, INVOKESTATIC, INVOKEVIRTUAL, IOR, IREM, IRETURN, ISHL, ISHR, ISTORE, ISUB, IUSHR, IXOR, JSR, L2D, L2F, L2I, LADD, LALOAD, LAND, LASTORE, LCMP, LCONST_0, LCONST_1, LDC, LDIV, LLOAD, LMUL, LNEG, LONG, LOOKUPSWITCH, LOR, LREM, LRETURN, LSHL, LSHR, LSTORE, LSUB, LUSHR, LXOR, MONITORENTER, MONITOREXIT, MULTIANEWARRAY, NEW, NEWARRAY, NOP, NULL, POP, POP2, PUTFIELD, PUTSTATIC, RET, RETURN, SALOAD, SASTORE, SIPUSH, SWAP, T_BOOLEAN, T_BYTE, T_CHAR, T_DOUBLE, T_FLOAT, T_INT, T_LONG, T_SHORT, TABLESWITCH, TOP, UNINITIALIZED_THIS, V_PREVIEW, V1_1, V1_2, V1_3, V1_4, V1_5, V1_6, V1_7, V1_8, V10, V11, V12, V9

Constructor Summary

Constructors

Constructor and Description
AbstractClassFileWriter()

Method Summary

Modifier and Type	Method and Description
abstract void	accept(ClassWriterOutputVisitor classWriterOutputVisitor) Accept a ClassWriterOutputVisitor to write this writer to disk.
protected void	generateServiceDescriptor(String className, GeneratedFile generatedFile) Generates a service discovery for the given class name and file.
protected String	getClassFileName(String className)
protected static String	getConstructorDescriptor(Collection<Object> argList)
protected static String	getConstructorDescriptor(Object... argumentTypes)
protected static String	getInternalName(String className)
protected static String	getInternalNameForCast(Object type)
protected static String	getMethodDescriptor(Object returnType, Collection<Object> argumentTypes)
protected static String	getMethodDescriptor(String returnType, String... argumentTypes)
protected static String	getMethodSignature(String returnTypeReference, String... argReferenceTypes)
protected static org.objectweb.asm.Type	getObjectType(Object type)
protected org.objectweb.asm.Type[]	getObjectTypes(Collection types)
protected static String	getTypeDescriptor(Object type) Returns the descriptor corresponding to the given class.
protected static String	getTypeDescriptor(String className, String... genericTypes)
protected static org.objectweb.asm.Type	getTypeReference(Object type) Return the type reference for a class.
protected static org.objectweb.asm.Type	getTypeReferenceForName(String className, String... genericTypes) Returns the Type reference corresponding to the given class.
protected static Class	getWrapperType(Object type)
protected void	invokeConstructor(org.objectweb.asm.MethodVisitor cv, Class superClass, Class... argumentTypes)
protected static void	invokeInterfaceStaticMethod(org.objectweb.asm.MethodVisitor visitor, Class targetType, org.objectweb.asm.commons.Method method)
protected static boolean	isPrimitive(Object type)
protected ClassWriterOutputVisitor	newClassWriterOutputVisitor(File compilationDir)
protected static void	pushBoxPrimitiveIfNecessary(Object fieldType, org.objectweb.asm.MethodVisitor injectMethodVisitor)
protected static void	pushCastToType(org.objectweb.asm.MethodVisitor methodVisitor, Object type)
protected static void	pushMethodNameAndTypesArguments(org.objectweb.asm.commons.GeneratorAdapter methodVisitor, String methodName, Collection<Object> argumentTypes)
protected static void	pushNewArray(org.objectweb.asm.commons.GeneratorAdapter methodVisitor, Class arrayType, int size)
protected static void	pushReturnValue(org.objectweb.asm.MethodVisitor methodVisitor, Object type)
protected static void	pushStoreInArray(org.objectweb.asm.commons.GeneratorAdapter methodVisitor, int index, int size, Runnable runnable)
protected static void	pushStoreStringInArray(org.objectweb.asm.commons.GeneratorAdapter methodVisitor, int index, int size, String string)
protected static void	pushStoreTypeInArray(org.objectweb.asm.commons.GeneratorAdapter methodVisitor, int index, int size, Object type)
protected void	returnVoid(org.objectweb.asm.commons.GeneratorAdapter overriddenMethodGenerator)
protected void	startClass(org.objectweb.asm.ClassVisitor classWriter, String className, org.objectweb.asm.Type superType)
protected void	startClass(org.objectweb.asm.ClassWriter classWriter, String className, org.objectweb.asm.Type superType, String genericSignature)
protected org.objectweb.asm.commons.GeneratorAdapter	startConstructor(org.objectweb.asm.ClassVisitor classWriter)
protected org.objectweb.asm.commons.GeneratorAdapter	startConstructor(org.objectweb.asm.ClassVisitor classWriter, Object... argumentTypes)
protected org.objectweb.asm.commons.GeneratorAdapter	startProtectedMethod(org.objectweb.asm.ClassWriter writer, String methodName, String returnType, String... argumentTypes)
protected org.objectweb.asm.commons.GeneratorAdapter	startPublicMethod(org.objectweb.asm.ClassWriter writer, String methodName, String returnType, String... argumentTypes)
protected org.objectweb.asm.commons.GeneratorAdapter	startPublicMethodZeroArgs(org.objectweb.asm.ClassWriter classWriter, Class returnType, String methodName)
protected org.objectweb.asm.commons.GeneratorAdapter	visitStaticInitializer(org.objectweb.asm.ClassVisitor classWriter)
protected void	writeClassToDisk(File targetDir, org.objectweb.asm.ClassWriter classWriter, String className) Writes the class file to disk in the given directory.
protected void	writeClassToDisk(OutputStream out, org.objectweb.asm.ClassWriter classWriter)
void	writeTo(File targetDir) Write the class to the target directory.

Methods inherited from class java.lang.Object

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

Field Detail

CONSTRUCTOR_NAME

protected static final String CONSTRUCTOR_NAME

See Also:

Constant Field Values

DESCRIPTOR_DEFAULT_CONSTRUCTOR

protected static final String DESCRIPTOR_DEFAULT_CONSTRUCTOR

See Also:

Constant Field Values

METHOD_DEFAULT_CONSTRUCTOR

protected static final org.objectweb.asm.commons.Method METHOD_DEFAULT_CONSTRUCTOR

TYPE_OBJECT

protected static final org.objectweb.asm.Type TYPE_OBJECT

TYPE_CLASS

protected static final org.objectweb.asm.Type TYPE_CLASS

DEFAULT_MAX_STACK

protected static final int DEFAULT_MAX_STACK

See Also:

Constant Field Values

NAME_TO_TYPE_MAP

protected static final Map<String,String> NAME_TO_TYPE_MAP

Constructor Detail

AbstractClassFileWriter

public AbstractClassFileWriter()

Method Detail

writeTo

public void writeTo(File targetDir)
             throws IOException

Write the class to the target directory.

Parameters:

targetDir - The target directory

Throws:

IOException - if there is an error writing the file

accept

public abstract void accept(ClassWriterOutputVisitor classWriterOutputVisitor)
                     throws IOException

Accept a ClassWriterOutputVisitor to write this writer to disk.

Parameters:

classWriterOutputVisitor - The ClassWriterOutputVisitor

Throws:

IOException - if there is an error writing to disk

getTypeDescriptor

protected static String getTypeDescriptor(Object type)

Returns the descriptor corresponding to the given class.

Parameters:

type - The type

Returns:

The descriptor for the class

getTypeReferenceForName

protected static org.objectweb.asm.Type getTypeReferenceForName(String className,
                                                                String... genericTypes)

Returns the Type reference corresponding to the given class.

Parameters:

className - The class name

genericTypes - The generic types

Returns:

The Type

getTypeReference

protected static org.objectweb.asm.Type getTypeReference(Object type)

Return the type reference for a class.

Parameters:

type - The type

Returns:

The Type

pushBoxPrimitiveIfNecessary

protected static void pushBoxPrimitiveIfNecessary(Object fieldType,
                                                  org.objectweb.asm.MethodVisitor injectMethodVisitor)

Parameters:

fieldType - The field type

injectMethodVisitor - The MethodVisitor

pushCastToType

protected static void pushCastToType(org.objectweb.asm.MethodVisitor methodVisitor,
                                     Object type)

Parameters:

methodVisitor - The MethodVisitor

type - The type

pushReturnValue

protected static void pushReturnValue(org.objectweb.asm.MethodVisitor methodVisitor,
                                      Object type)

Parameters:

methodVisitor - The MethodVisitor

type - The type

getWrapperType

protected static Class getWrapperType(Object type)

Parameters:

type - The type

Returns:

The class

isPrimitive

protected static boolean isPrimitive(Object type)

Parameters:

type - The type

Returns:

Whether a type is primitive

pushMethodNameAndTypesArguments

protected static void pushMethodNameAndTypesArguments(org.objectweb.asm.commons.GeneratorAdapter methodVisitor,
                                                      String methodName,
                                                      Collection<Object> argumentTypes)

Parameters:

methodVisitor - The method visitor as GeneratorAdapter

methodName - The method name

argumentTypes - The argument types

pushNewArray

protected static void pushNewArray(org.objectweb.asm.commons.GeneratorAdapter methodVisitor,
                                   Class arrayType,
                                   int size)

Parameters:

methodVisitor - The method visitor as GeneratorAdapter

arrayType - The array class

size - The size

pushStoreStringInArray

protected static void pushStoreStringInArray(org.objectweb.asm.commons.GeneratorAdapter methodVisitor,
                                             int index,
                                             int size,
                                             String string)

Parameters:

methodVisitor - The method visitor as GeneratorAdapter

index - The index

size - The size

string - The string

pushStoreInArray

protected static void pushStoreInArray(org.objectweb.asm.commons.GeneratorAdapter methodVisitor,
                                       int index,
                                       int size,
                                       Runnable runnable)

Parameters:

methodVisitor - The method visitor as GeneratorAdapter

index - The index

size - The size

runnable - The runnable

pushStoreTypeInArray

protected static void pushStoreTypeInArray(org.objectweb.asm.commons.GeneratorAdapter methodVisitor,
                                           int index,
                                           int size,
                                           Object type)

Parameters:

methodVisitor - The method visitor as GeneratorAdapter

index - The index

size - The size

type - The type

getObjectTypes

protected org.objectweb.asm.Type[] getObjectTypes(Collection types)

Parameters:

types - The types

Returns:

An array with the Type of the objects

getObjectType

protected static org.objectweb.asm.Type getObjectType(Object type)

Parameters:

type - The type

Returns:

The Type for the object type

getTypeDescriptor

protected static String getTypeDescriptor(String className,
                                          String... genericTypes)

Parameters:

className - The class name

genericTypes - The generic types

Returns:

The type descriptor as String

getMethodDescriptor

protected static String getMethodDescriptor(String returnType,
                                            String... argumentTypes)

Parameters:

returnType - The return type

argumentTypes - The argument types

Returns:

The method descriptor

getMethodDescriptor

protected static String getMethodDescriptor(Object returnType,
                                            Collection<Object> argumentTypes)

Parameters:

returnType - The return type

argumentTypes - The argument types

Returns:

The method descriptor

getMethodSignature

protected static String getMethodSignature(String returnTypeReference,
                                           String... argReferenceTypes)

Parameters:

returnTypeReference - The return type reference

argReferenceTypes - The argument reference types

Returns:

The method signature

getConstructorDescriptor

protected static String getConstructorDescriptor(Object... argumentTypes)

Parameters:

argumentTypes - The argument types

Returns:

The constructor descriptor

getConstructorDescriptor

protected static String getConstructorDescriptor(Collection<Object> argList)

Parameters:

argList - The argument list

Returns:

The constructor descriptor

writeClassToDisk

protected void writeClassToDisk(File targetDir,
                                org.objectweb.asm.ClassWriter classWriter,
                                String className)
                         throws IOException

Writes the class file to disk in the given directory.

Parameters:

targetDir - The target directory

classWriter - The current class writer

className - The class name

Throws:

IOException - if there is a problem writing the class to disk

writeClassToDisk

protected void writeClassToDisk(OutputStream out,
                                org.objectweb.asm.ClassWriter classWriter)
                         throws IOException

Parameters:

out - The output stream

classWriter - The current class writer

Throws:

IOException - if there is a problem writing the class to disk

startConstructor

protected org.objectweb.asm.commons.GeneratorAdapter startConstructor(org.objectweb.asm.ClassVisitor classWriter)

Parameters:

classWriter - The current class writer

Returns:

The GeneratorAdapter for the constructor

startConstructor

protected org.objectweb.asm.commons.GeneratorAdapter startConstructor(org.objectweb.asm.ClassVisitor classWriter,
                                                                      Object... argumentTypes)

Parameters:

classWriter - The current class writer

argumentTypes - The argument types

Returns:

The GeneratorAdapter for the constructor

startClass

protected void startClass(org.objectweb.asm.ClassVisitor classWriter,
                          String className,
                          org.objectweb.asm.Type superType)

Parameters:

classWriter - The current class writer

className - The class name

superType - The super type

startClass

protected void startClass(org.objectweb.asm.ClassWriter classWriter,
                          String className,
                          org.objectweb.asm.Type superType,
                          String genericSignature)

Parameters:

classWriter - The current class writer

className - The class name

superType - The super type

genericSignature - The generic signature

invokeConstructor

protected void invokeConstructor(org.objectweb.asm.MethodVisitor cv,
                                 Class superClass,
                                 Class... argumentTypes)

Parameters:

cv - The constructor visitor

superClass - The super class

argumentTypes - The argument types

invokeInterfaceStaticMethod

protected static void invokeInterfaceStaticMethod(org.objectweb.asm.MethodVisitor visitor,
                                                  Class targetType,
                                                  org.objectweb.asm.commons.Method method)

Parameters:

visitor - The interface visitor

targetType - The target type

method - The method

startPublicMethodZeroArgs

protected org.objectweb.asm.commons.GeneratorAdapter startPublicMethodZeroArgs(org.objectweb.asm.ClassWriter classWriter,
                                                                               Class returnType,
                                                                               String methodName)

Parameters:

classWriter - The current class writer

returnType - The return type

methodName - The method name

Returns:

TheThe GeneratorAdapter for the method

getInternalName

protected static String getInternalName(String className)

Parameters:

className - The class name

Returns:

The internal name

getInternalNameForCast

protected static String getInternalNameForCast(Object type)

Parameters:

type - The type

Returns:

the internal name for cast

getClassFileName

protected String getClassFileName(String className)

Parameters:

className - The class name

Returns:

The class file name

newClassWriterOutputVisitor

protected ClassWriterOutputVisitor newClassWriterOutputVisitor(File compilationDir)

Parameters:

compilationDir - The compilation directory

Returns:

The directory class writer output visitor

returnVoid

protected void returnVoid(org.objectweb.asm.commons.GeneratorAdapter overriddenMethodGenerator)

Parameters:

overriddenMethodGenerator - The overriden method generator

visitStaticInitializer

protected org.objectweb.asm.commons.GeneratorAdapter visitStaticInitializer(org.objectweb.asm.ClassVisitor classWriter)

Parameters:

classWriter - The current class writer

Returns:

The GeneratorAdapter

startPublicMethod

protected org.objectweb.asm.commons.GeneratorAdapter startPublicMethod(org.objectweb.asm.ClassWriter writer,
                                                                       String methodName,
                                                                       String returnType,
                                                                       String... argumentTypes)

Parameters:

writer - The class writer

methodName - The method name

returnType - The return type

argumentTypes - The argument types

Returns:

The GeneratorAdapter

startProtectedMethod

protected org.objectweb.asm.commons.GeneratorAdapter startProtectedMethod(org.objectweb.asm.ClassWriter writer,
                                                                          String methodName,
                                                                          String returnType,
                                                                          String... argumentTypes)

Parameters:

writer - The class writer

methodName - The method name

returnType - The return type

argumentTypes - The argument types

Returns:

The GeneratorAdapter

generateServiceDescriptor

protected void generateServiceDescriptor(String className,
                                         GeneratedFile generatedFile)
                                  throws IOException

Generates a service discovery for the given class name and file.

Parameters:

className - The class name

generatedFile - The generated file

Throws:

IOException - An exception if an error occurs