io.micronaut.inject.writer

Class BeanDefinitionWriter

java.lang.Object

io.micronaut.inject.writer.AbstractClassFileWriter

io.micronaut.inject.writer.BeanDefinitionWriter

All Implemented Interfaces:

BeanDefinitionVisitor, org.objectweb.asm.Opcodes

@Internal
public class BeanDefinitionWriter
extends AbstractClassFileWriter
implements BeanDefinitionVisitor

Responsible for building BeanDefinition instances at compile time. Uses ASM build the class definition.

Should be used from AST frameworks to build bean definitions from source code data.

For example:

     

          BeanDefinitionWriter writer = new BeanDefinitionWriter("my.package", "MyClass", "javax.inject.Singleton", true)
          writer.visitBeanDefinitionConstructor()
          writer.visitFieldInjectionPoint("my.Qualifier", false, "my.package.MyDependency", "myfield" )
          writer.visitBeanDefinitionEnd()
          writer.writeTo(new File(..))
     
 

Since:

1.0

Author:

Graeme Rocher

See Also:

BeanDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeanDefinitionWriter.MethodVisitData Data used when visiting method.

Field Summary

Fields inherited from class io.micronaut.inject.writer.AbstractClassFileWriter

CONSTRUCTOR_NAME, DEFAULT_MAX_STACK, DESCRIPTOR_DEFAULT_CONSTRUCTOR, METHOD_DEFAULT_CONSTRUCTOR, NAME_TO_TYPE_MAP, originatingElement, TYPE_ARGUMENT, TYPE_ARGUMENT_ARRAY, TYPE_CLASS, TYPE_GENERATED, TYPE_OBJECT, ZERO_ARGUMENTS_CONSTANT

Fields inherited from interface io.micronaut.inject.writer.BeanDefinitionVisitor

PROXY_SUFFIX

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, SOURCE_DEPRECATED, SOURCE_MASK, 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, V13, V14, V9

Constructor Summary

Constructors

Constructor and Description
BeanDefinitionWriter(java.lang.String packageName, java.lang.String className, boolean isInterface, Element originatingElement, AnnotationMetadata annotationMetadata) Creates a bean definition writer.
BeanDefinitionWriter(java.lang.String packageName, java.lang.String className, Element originatingElement, AnnotationMetadata annotationMetadata) Creates a bean definition writer.
BeanDefinitionWriter(java.lang.String packageName, java.lang.String className, java.lang.String providedClassName, boolean isInterface, Element originatingElement, AnnotationMetadata annotationMetadata) Creates a bean definition writer.
BeanDefinitionWriter(java.lang.String packageName, java.lang.String className, java.lang.String beanDefinitionName, java.lang.String providedClassName, boolean isInterface, Element originatingElement, AnnotationMetadata annotationMetadata) Creates a bean definition writer.

Method Summary

Modifier and Type	Method and Description
void	accept(ClassWriterOutputVisitor visitor) Accept a ClassWriterOutputVisitor to write this writer to disk.
AnnotationMetadata	getAnnotationMetadata()
java.lang.String	getBeanDefinitionClassFile()
java.lang.String	getBeanDefinitionName()
java.lang.String	getBeanDefinitionReferenceClassName()
java.lang.String	getBeanSimpleName()
java.lang.String	getBeanTypeName()
org.objectweb.asm.ClassVisitor	getClassWriter()
java.lang.String	getPackageName()
java.util.List<BeanDefinitionWriter.MethodVisitData>	getPostConstructMethodVisits()
java.util.List<BeanDefinitionWriter.MethodVisitData>	getPreDestroyMethodVisits()
org.objectweb.asm.Type	getProvidedType() The provided type of the bean.
boolean	isInterface()
boolean	isSingleton()
boolean	isValidated()
boolean	requiresMethodProcessing() By default, when the BeanContext is started, the BeanDefinition.getExecutableMethods() are not processed by registered ExecutableMethodProcessor instances unless this method returns true.
void	setRequiresMethodProcessing(boolean shouldPreProcess) Sets whether the BeanType.requiresMethodProcessing() returns true.
void	setValidated(boolean validated) Make the bean definition as validated by javax.validation.
byte[]	toByteArray()
java.lang.String	toString()
void	visitBeanDefinitionConstructor(AnnotationMetadata annotationMetadata, boolean requiresReflection) Visits a no-args constructor used to create the bean definition.
void	visitBeanDefinitionConstructor(AnnotationMetadata annotationMetadata, boolean requiresReflection, java.util.Map<java.lang.String,java.lang.Object> argumentTypes, java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes) Visits the constructor used to create the bean definition.
void	visitBeanDefinitionEnd() Finalize the bean definition to the given output stream.
void	visitBeanDefinitionInterface(java.lang.Class<? extends BeanDefinition> interfaceType) Visit a marker interface on the generated bean definition.
void	visitBeanFactoryMethod(java.lang.Object factoryClass, java.lang.Object producedType, java.lang.String methodName, AnnotationMetadata methodAnnotationMetadata, java.util.Map<java.lang.String,java.lang.Object> argumentTypes, java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes) In the case where the produced class is produced by a factory method annotated with Bean this method should be called.
void	visitConfigBuilderDurationMethod(java.lang.String prefix, java.lang.Object returnType, java.lang.String methodName, java.lang.String path) Visit a configuration builder method that accepts a long and a TimeUnit.
void	visitConfigBuilderEnd() Finalize a configuration builder field.
void	visitConfigBuilderField(java.lang.Object type, java.lang.String field, AnnotationMetadata annotationMetadata, ConfigurationMetadataBuilder metadataBuilder, boolean isInterface) Begin defining a configuration builder.
void	visitConfigBuilderMethod(java.lang.Object type, java.lang.String methodName, AnnotationMetadata annotationMetadata, ConfigurationMetadataBuilder metadataBuilder, boolean isInterface) Begin defining a configuration builder.
void	visitConfigBuilderMethod(java.lang.String prefix, java.lang.Object returnType, java.lang.String methodName, java.lang.Object paramType, java.util.Map<java.lang.String,java.lang.Object> generics, java.lang.String path) Visit a configuration builder method.
ExecutableMethodWriter	visitExecutableMethod(java.lang.Object declaringType, java.lang.Object returnType, java.lang.Object genericReturnType, java.util.Map<java.lang.String,java.lang.Object> returnTypeGenericTypes, java.lang.String methodName, java.util.Map<java.lang.String,java.lang.Object> argumentTypes, java.util.Map<java.lang.String,java.lang.Object> genericArgumentTypes, java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes, AnnotationMetadata annotationMetadata, boolean isInterface, boolean isDefault) Visit a method that is to be made executable allow invocation of said method without reflection.
void	visitFieldInjectionPoint(java.lang.Object declaringType, java.lang.Object fieldType, java.lang.String fieldName, boolean requiresReflection, AnnotationMetadata annotationMetadata, java.util.Map<java.lang.String,java.lang.Object> typeArguments) Visits a field injection point.
void	visitFieldValue(java.lang.Object declaringType, java.lang.Object fieldType, java.lang.String fieldName, boolean requiresReflection, AnnotationMetadata annotationMetadata, java.util.Map<java.lang.String,java.lang.Object> typeArguments, boolean isOptional) Visits a field injection point.
void	visitMethodInjectionPoint(java.lang.Object declaringType, boolean requiresReflection, java.lang.Object returnType, java.lang.String methodName, java.util.Map<java.lang.String,java.lang.Object> argumentTypes, java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes, AnnotationMetadata annotationMetadata) Visits a method injection point.
void	visitPostConstructMethod(java.lang.Object declaringType, boolean requiresReflection, java.lang.Object returnType, java.lang.String methodName, java.util.Map<java.lang.String,java.lang.Object> argumentTypes, java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes, AnnotationMetadata annotationMetadata) Visits a method injection point.
void	visitPreDestroyMethod(java.lang.Object declaringType, boolean requiresReflection, java.lang.Object returnType, java.lang.String methodName, java.util.Map<java.lang.String,java.lang.Object> argumentTypes, java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata, java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes, AnnotationMetadata annotationMetadata) Visits a method injection point.
void	visitPreDestroyMethod(java.lang.Object declaringType, java.lang.Object returnType, java.lang.String methodName) Visits a pre-destroy method injection point.
void	visitPreDestroyMethod(java.lang.Object declaringType, java.lang.String methodName) Visits a pre-destroy method injection point.
void	visitSetterValue(java.lang.Object declaringType, java.lang.Object returnType, AnnotationMetadata annotationMetadata, boolean requiresReflection, java.lang.Object valueType, java.lang.String setterName, java.util.Map<java.lang.String,java.lang.Object> genericTypes, AnnotationMetadata setterArgumentMetadata, boolean isOptional) Visits an injection point for a setter.
void	visitSetterValue(java.lang.Object declaringType, java.lang.Object returnType, AnnotationMetadata annotationMetadata, boolean requiresReflection, java.lang.Object fieldType, java.lang.String fieldName, java.lang.String setterName, java.util.Map<java.lang.String,java.lang.Object> genericTypes, boolean isOptional) Visits an injection point for a field and setter pairing.
void	visitSuperBeanDefinition(java.lang.String name) Alter the super class of this bean definition.
void	visitSuperBeanDefinitionFactory(java.lang.String beanName) Alter the super class of this bean definition to use another factory bean.
void	visitTypeArguments(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> typeArguments) Visits the type arguments for the bean.

Methods inherited from class io.micronaut.inject.writer.AbstractClassFileWriter

buildArgument, generateServiceDescriptor, getClassFileName, getConstructorDescriptor, getConstructorDescriptor, getInternalName, getInternalNameForCast, getMethodDescriptor, getMethodDescriptor, getMethodSignature, getObjectType, getObjectTypes, getOriginatingElement, getTypeDescriptor, getTypeDescriptor, getTypeReference, getTypeReference, getTypeReferenceForName, getWrapperType, invokeConstructor, invokeInterfaceStaticMethod, isPrimitive, newClassWriterOutputVisitor, pushBoxPrimitiveIfNecessary, pushBuildArgumentsForMethod, pushCastToType, pushMethodNameAndTypesArguments, pushNewArray, pushNewInstance, pushReturnValue, pushStoreInArray, pushStoreStringInArray, pushStoreTypeInArray, pushTypeArgumentElements, pushTypeArguments, returnVoid, startClass, startClass, startConstructor, startConstructor, startFinalClass, startProtectedMethod, startPublicClass, startPublicFinalClass, startPublicFinalMethodZeroArgs, startPublicMethod, startPublicMethodZeroArgs, startService, startService, toParameterTypes, toTypeArguments, toTypeArguments, visitStaticInitializer, writeBooleanMethod, writeClassToDisk, writeClassToDisk, writeTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.inject.writer.BeanDefinitionVisitor

getOriginatingElement, writeTo

Constructor Detail

BeanDefinitionWriter

public BeanDefinitionWriter(java.lang.String packageName,
                            java.lang.String className,
                            Element originatingElement,
                            AnnotationMetadata annotationMetadata)

Creates a bean definition writer.

Parameters:

packageName - The package name of the bean

className - The class name, without the package, of the bean

originatingElement - The originating element

annotationMetadata - The annotation metadata

BeanDefinitionWriter

public BeanDefinitionWriter(java.lang.String packageName,
                            java.lang.String className,
                            boolean isInterface,
                            Element originatingElement,
                            AnnotationMetadata annotationMetadata)

Creates a bean definition writer.

Parameters:

packageName - The package name of the bean

className - The class name, without the package, of the bean

isInterface - Whether the writer is for an interface.

originatingElement - The originating element

annotationMetadata - The annotation metadata

BeanDefinitionWriter

public BeanDefinitionWriter(java.lang.String packageName,
                            java.lang.String className,
                            java.lang.String providedClassName,
                            boolean isInterface,
                            Element originatingElement,
                            AnnotationMetadata annotationMetadata)

Creates a bean definition writer.

Parameters:

packageName - The package name of the bean

className - The class name, without the package, of the bean

providedClassName - The type this bean definition provides, in this case where the bean implements Provider

isInterface - Is the type an interface

originatingElement - The originating element

annotationMetadata - The annotation metadata

BeanDefinitionWriter

public BeanDefinitionWriter(java.lang.String packageName,
                            java.lang.String className,
                            java.lang.String beanDefinitionName,
                            java.lang.String providedClassName,
                            boolean isInterface,
                            Element originatingElement,
                            AnnotationMetadata annotationMetadata)

Creates a bean definition writer.

Parameters:

packageName - The package name of the bean

className - The class name, without the package, of the bean

beanDefinitionName - The name of the bean definition

providedClassName - The type this bean definition provides, which differs from the class name in the case of factory beans

isInterface - Whether the provided type is an interface

originatingElement - The originating element

annotationMetadata - The annotation metadata

Method Detail

getBeanDefinitionReferenceClassName

@NonNull
public java.lang.String getBeanDefinitionReferenceClassName()

Specified by:

getBeanDefinitionReferenceClassName in interface BeanDefinitionVisitor

Returns:

The name of the bean definition reference class.

getPostConstructMethodVisits

public final java.util.List<BeanDefinitionWriter.MethodVisitData> getPostConstructMethodVisits()

Returns:

The data for any post construct methods that were visited

getPreDestroyMethodVisits

public java.util.List<BeanDefinitionWriter.MethodVisitData> getPreDestroyMethodVisits()

Returns:

The data for any pre destroy methods that were visited

getClassWriter

public org.objectweb.asm.ClassVisitor getClassWriter()

Returns:

The underlying class writer

isInterface

public boolean isInterface()

Specified by:

isInterface in interface BeanDefinitionVisitor

Returns:

Whether the provided type an interface

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface BeanDefinitionVisitor

Returns:

Is the bean singleton

visitBeanDefinitionInterface

public void visitBeanDefinitionInterface(java.lang.Class<? extends BeanDefinition> interfaceType)

Description copied from interface: BeanDefinitionVisitor

Visit a marker interface on the generated bean definition.

Specified by:

visitBeanDefinitionInterface in interface BeanDefinitionVisitor

Parameters:

interfaceType - The interface type

visitSuperBeanDefinition

public void visitSuperBeanDefinition(java.lang.String name)

Description copied from interface: BeanDefinitionVisitor

Alter the super class of this bean definition. The passed class should be a subclass of AbstractBeanDefinition.

Specified by:

visitSuperBeanDefinition in interface BeanDefinitionVisitor

Parameters:

name - The super type

visitSuperBeanDefinitionFactory

public void visitSuperBeanDefinitionFactory(java.lang.String beanName)

Description copied from interface: BeanDefinitionVisitor

Alter the super class of this bean definition to use another factory bean.

Specified by:

visitSuperBeanDefinitionFactory in interface BeanDefinitionVisitor

Parameters:

beanName - The bean name

getBeanTypeName

public java.lang.String getBeanTypeName()

Specified by:

getBeanTypeName in interface BeanDefinitionVisitor

Returns:

The full class name of the bean

getProvidedType

public org.objectweb.asm.Type getProvidedType()

Description copied from interface: BeanDefinitionVisitor

The provided type of the bean. Usually this is the same as BeanDefinitionVisitor.getBeanTypeName(), except in the case of factory beans which produce a different type.

Specified by:

getProvidedType in interface BeanDefinitionVisitor

Returns:

The provided type

setValidated

public void setValidated(boolean validated)

Description copied from interface: BeanDefinitionVisitor

Make the bean definition as validated by javax.validation.

Specified by:

setValidated in interface BeanDefinitionVisitor

Parameters:

validated - Whether the bean definition is validated

isValidated

public boolean isValidated()

Specified by:

isValidated in interface BeanDefinitionVisitor

Returns:

Return whether the bean definition is validated.

getBeanDefinitionName

public java.lang.String getBeanDefinitionName()

Specified by:

getBeanDefinitionName in interface BeanDefinitionVisitor

Returns:

The name of the bean definition class

getBeanDefinitionClassFile

public java.lang.String getBeanDefinitionClassFile()

Returns:

The name of the bean definition class

visitBeanFactoryMethod

public void visitBeanFactoryMethod(java.lang.Object factoryClass,
                                   java.lang.Object producedType,
                                   java.lang.String methodName,
                                   AnnotationMetadata methodAnnotationMetadata,
                                   java.util.Map<java.lang.String,java.lang.Object> argumentTypes,
                                   java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata,
                                   java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes)

In the case where the produced class is produced by a factory method annotated with Bean this method should be called.

Parameters:

factoryClass - The factory class

producedType - The produced type

methodName - The method name

methodAnnotationMetadata - The method annotation metadata

argumentTypes - The arguments to the method

argumentAnnotationMetadata - The argument annotation metadata

genericTypes - The generic types for the method parameters

visitBeanDefinitionConstructor

public void visitBeanDefinitionConstructor(AnnotationMetadata annotationMetadata,
                                           boolean requiresReflection,
                                           java.util.Map<java.lang.String,java.lang.Object> argumentTypes,
                                           java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata,
                                           java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes)

Visits the constructor used to create the bean definition.

Specified by:

visitBeanDefinitionConstructor in interface BeanDefinitionVisitor

Parameters:

annotationMetadata - The annotation metadata for the constructor

requiresReflection - Whether invoking the constructor requires reflection

argumentTypes - The argument type names for each parameter

argumentAnnotationMetadata - The qualifier type names for each parameter

genericTypes - The generic types for each parameter

visitBeanDefinitionConstructor

public void visitBeanDefinitionConstructor(AnnotationMetadata annotationMetadata,
                                           boolean requiresReflection)

Visits a no-args constructor used to create the bean definition.

Specified by:

visitBeanDefinitionConstructor in interface BeanDefinitionVisitor

Parameters:

annotationMetadata - The annotation metadata for the constructor.

requiresReflection - Whether invoking the constructor requires reflection.

visitBeanDefinitionEnd

public void visitBeanDefinitionEnd()

Finalize the bean definition to the given output stream.

Specified by:

visitBeanDefinitionEnd in interface BeanDefinitionVisitor

toByteArray

public byte[] toByteArray()

Returns:

The bytes of the class

accept

public void accept(ClassWriterOutputVisitor visitor)
            throws java.io.IOException

Description copied from class: AbstractClassFileWriter

Accept a ClassWriterOutputVisitor to write this writer to disk.

Specified by:

accept in interface BeanDefinitionVisitor

Specified by:

accept in class AbstractClassFileWriter

Parameters:

visitor - The ClassWriterOutputVisitor

Throws:

java.io.IOException - if there is an error writing to disk

visitSetterValue

public void visitSetterValue(java.lang.Object declaringType,
                             java.lang.Object returnType,
                             AnnotationMetadata annotationMetadata,
                             boolean requiresReflection,
                             java.lang.Object fieldType,
                             java.lang.String fieldName,
                             java.lang.String setterName,
                             java.util.Map<java.lang.String,java.lang.Object> genericTypes,
                             boolean isOptional)

Description copied from interface: BeanDefinitionVisitor

Visits an injection point for a field and setter pairing.

Specified by:

visitSetterValue in interface BeanDefinitionVisitor

Parameters:

declaringType - The declaring type

returnType - The return type

annotationMetadata - The annotation metadata

requiresReflection - Whether the setter requires reflection

fieldType - The field type

fieldName - The field name

setterName - The setter name

genericTypes - The generic types

isOptional - Whether the setter is optional

visitSetterValue

public void visitSetterValue(java.lang.Object declaringType,
                             java.lang.Object returnType,
                             AnnotationMetadata annotationMetadata,
                             boolean requiresReflection,
                             java.lang.Object valueType,
                             java.lang.String setterName,
                             java.util.Map<java.lang.String,java.lang.Object> genericTypes,
                             AnnotationMetadata setterArgumentMetadata,
                             boolean isOptional)

Description copied from interface: BeanDefinitionVisitor

Visits an injection point for a setter.

Specified by:

visitSetterValue in interface BeanDefinitionVisitor

Parameters:

declaringType - The declaring type

returnType - The return type

annotationMetadata - The annotation metadata

requiresReflection - Whether the setter requires reflection

valueType - The field type

setterName - The setter name

genericTypes - The generic types

setterArgumentMetadata - The setter argument metadata

isOptional - Whether the setter is optional

visitPostConstructMethod

public void visitPostConstructMethod(java.lang.Object declaringType,
                                     boolean requiresReflection,
                                     java.lang.Object returnType,
                                     java.lang.String methodName,
                                     java.util.Map<java.lang.String,java.lang.Object> argumentTypes,
                                     java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata,
                                     java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes,
                                     AnnotationMetadata annotationMetadata)

Description copied from interface: BeanDefinitionVisitor

Visits a method injection point.

Specified by:

visitPostConstructMethod in interface BeanDefinitionVisitor

Parameters:

declaringType - The declaring type of the method. Either a Class or a string representing the name of the type

requiresReflection - Whether the method requires reflection

returnType - The return type of the method. Either a Class or a string representing the name of the type

methodName - The method name

argumentTypes - The argument types. Note: an ordered map should be used such as LinkedHashMap. Can be null or empty.

argumentAnnotationMetadata - The argument annotation metadata

genericTypes - The generic types of each argument. Can be null.

annotationMetadata - The annotation metadata

visitPreDestroyMethod

public void visitPreDestroyMethod(java.lang.Object declaringType,
                                  java.lang.String methodName)

Visits a pre-destroy method injection point.

Parameters:

declaringType - The declaring type of the method. Either a Class or a string representing the name of the type

methodName - The method name

visitPreDestroyMethod

public void visitPreDestroyMethod(java.lang.Object declaringType,
                                  java.lang.Object returnType,
                                  java.lang.String methodName)

Visits a pre-destroy method injection point.

Parameters:

declaringType - The declaring type of the method. Either a Class or a string representing the name of the type

returnType - The return type of the method

methodName - The method name

visitPreDestroyMethod

public void visitPreDestroyMethod(java.lang.Object declaringType,
                                  boolean requiresReflection,
                                  java.lang.Object returnType,
                                  java.lang.String methodName,
                                  java.util.Map<java.lang.String,java.lang.Object> argumentTypes,
                                  java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata,
                                  java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes,
                                  AnnotationMetadata annotationMetadata)

Description copied from interface: BeanDefinitionVisitor

Visits a method injection point.

Specified by:

visitPreDestroyMethod in interface BeanDefinitionVisitor

Parameters:

declaringType - The declaring type of the method. Either a Class or a string representing the name of the type

requiresReflection - Whether the method requires reflection

returnType - The return type of the method. Either a Class or a string representing the name of the type

methodName - The method name

argumentTypes - The argument types. Note: an ordered map should be used such as LinkedHashMap. Can be null or empty.

argumentAnnotationMetadata - The argument annotation metadata

genericTypes - The generic types of each argument. Can be null.

annotationMetadata - The annotation metadata

visitMethodInjectionPoint

public void visitMethodInjectionPoint(java.lang.Object declaringType,
                                      boolean requiresReflection,
                                      java.lang.Object returnType,
                                      java.lang.String methodName,
                                      java.util.Map<java.lang.String,java.lang.Object> argumentTypes,
                                      java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata,
                                      java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes,
                                      AnnotationMetadata annotationMetadata)

Description copied from interface: BeanDefinitionVisitor

Visits a method injection point.

Specified by:

visitMethodInjectionPoint in interface BeanDefinitionVisitor

Parameters:

declaringType - The declaring type of the method. Either a Class or a string representing the name of the type

requiresReflection - Whether the method requires reflection

returnType - The return type of the method. Either a Class or a string representing the name of the type

methodName - The method name

argumentTypes - The argument types. Note: an ordered map should be used such as LinkedHashMap. Can be null or empty.

argumentAnnotationMetadata - The argument annotation metadata

genericTypes - The generic types of each argument. Can be null.

annotationMetadata - The annotation metadata

visitExecutableMethod

public ExecutableMethodWriter visitExecutableMethod(java.lang.Object declaringType,
                                                    java.lang.Object returnType,
                                                    java.lang.Object genericReturnType,
                                                    java.util.Map<java.lang.String,java.lang.Object> returnTypeGenericTypes,
                                                    java.lang.String methodName,
                                                    java.util.Map<java.lang.String,java.lang.Object> argumentTypes,
                                                    java.util.Map<java.lang.String,java.lang.Object> genericArgumentTypes,
                                                    java.util.Map<java.lang.String,AnnotationMetadata> argumentAnnotationMetadata,
                                                    java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> genericTypes,
                                                    AnnotationMetadata annotationMetadata,
                                                    boolean isInterface,
                                                    boolean isDefault)

Description copied from interface: BeanDefinitionVisitor

Visit a method that is to be made executable allow invocation of said method without reflection.

Specified by:

visitExecutableMethod in interface BeanDefinitionVisitor

Parameters:

declaringType - The declaring type of the method. Either a Class or a string representing the name of the type

returnType - The return type of the method. Either a Class or a string representing the name of the type

genericReturnType - The generic return type

returnTypeGenericTypes - The return type for generic types

methodName - The method name

argumentTypes - The argument types. Note: an ordered map should be used such as LinkedHashMap. Can be null or empty.

genericArgumentTypes - The generic argument types. Note: an ordered map should be used such as LinkedHashMap. Can be null or empty.

argumentAnnotationMetadata - The argument annotation metadata

genericTypes - The generic types of each argument. Can be null.

annotationMetadata - The annotation metadata for the method

isInterface - If the method belongs to an interface

isDefault - If the method is a default method

Returns:

The ExecutableMethodWriter.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getPackageName

public java.lang.String getPackageName()

Specified by:

getPackageName in interface BeanDefinitionVisitor

Returns:

The package name of the bean

getBeanSimpleName

public java.lang.String getBeanSimpleName()

Specified by:

getBeanSimpleName in interface BeanDefinitionVisitor

Returns:

The short name of the bean

getAnnotationMetadata

public AnnotationMetadata getAnnotationMetadata()

Specified by:

getAnnotationMetadata in interface BeanDefinitionVisitor

Returns:

The annotation metadata

visitConfigBuilderField

public void visitConfigBuilderField(java.lang.Object type,
                                    java.lang.String field,
                                    AnnotationMetadata annotationMetadata,
                                    ConfigurationMetadataBuilder metadataBuilder,
                                    boolean isInterface)

Description copied from interface: BeanDefinitionVisitor

Begin defining a configuration builder.

Specified by:

visitConfigBuilderField in interface BeanDefinitionVisitor

Parameters:

type - The type of the builder

field - The name of the field that represents the builder

annotationMetadata - The annotation metadata associated with the field

metadataBuilder - The ConfigurationMetadataBuilder

isInterface - Whether the builder type is an interface or not

See Also:

ConfigurationBuilder

visitConfigBuilderMethod

public void visitConfigBuilderMethod(java.lang.Object type,
                                     java.lang.String methodName,
                                     AnnotationMetadata annotationMetadata,
                                     ConfigurationMetadataBuilder metadataBuilder,
                                     boolean isInterface)

Description copied from interface: BeanDefinitionVisitor

Begin defining a configuration builder.

Specified by:

visitConfigBuilderMethod in interface BeanDefinitionVisitor

Parameters:

type - The type of the builder

methodName - The name of the method that returns the builder

annotationMetadata - The annotation metadata associated with the field

metadataBuilder - The ConfigurationMetadataBuilder

isInterface - Whether the builder type is an interface or not

See Also:

ConfigurationBuilder

visitConfigBuilderDurationMethod

public void visitConfigBuilderDurationMethod(java.lang.String prefix,
                                             java.lang.Object returnType,
                                             java.lang.String methodName,
                                             java.lang.String path)

Description copied from interface: BeanDefinitionVisitor

Visit a configuration builder method that accepts a long and a TimeUnit.

Specified by:

visitConfigBuilderDurationMethod in interface BeanDefinitionVisitor

Parameters:

prefix - The prefix used for the method

returnType - The return type

methodName - The method name

path - The property path

See Also:

ConfigurationBuilder

visitConfigBuilderMethod

public void visitConfigBuilderMethod(java.lang.String prefix,
                                     java.lang.Object returnType,
                                     java.lang.String methodName,
                                     java.lang.Object paramType,
                                     java.util.Map<java.lang.String,java.lang.Object> generics,
                                     java.lang.String path)

Description copied from interface: BeanDefinitionVisitor

Visit a configuration builder method.

Specified by:

visitConfigBuilderMethod in interface BeanDefinitionVisitor

Parameters:

prefix - The prefix used for the method

returnType - The return type

methodName - The method name

paramType - The method type

generics - The generic types of the method

path - The property path

See Also:

ConfigurationBuilder

visitConfigBuilderEnd

public void visitConfigBuilderEnd()

Description copied from interface: BeanDefinitionVisitor

Finalize a configuration builder field.

Specified by:

visitConfigBuilderEnd in interface BeanDefinitionVisitor

See Also:

ConfigurationBuilder

setRequiresMethodProcessing

public void setRequiresMethodProcessing(boolean shouldPreProcess)

Description copied from interface: BeanDefinitionVisitor

Sets whether the BeanType.requiresMethodProcessing() returns true.

Specified by:

setRequiresMethodProcessing in interface BeanDefinitionVisitor

Parameters:

shouldPreProcess - True if they should be pre-processed

visitTypeArguments

public void visitTypeArguments(java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Object>> typeArguments)

Description copied from interface: BeanDefinitionVisitor

Visits the type arguments for the bean.

Specified by:

visitTypeArguments in interface BeanDefinitionVisitor

Parameters:

typeArguments - The type arguments

requiresMethodProcessing

public boolean requiresMethodProcessing()

Description copied from interface: BeanDefinitionVisitor

By default, when the BeanContext is started, the BeanDefinition.getExecutableMethods() are not processed by registered ExecutableMethodProcessor instances unless this method returns true.

Specified by:

requiresMethodProcessing in interface BeanDefinitionVisitor

Returns:

Whether the bean definition requires method processing

See Also:

Executable.processOnStartup()

visitFieldInjectionPoint

public void visitFieldInjectionPoint(java.lang.Object declaringType,
                                     java.lang.Object fieldType,
                                     java.lang.String fieldName,
                                     boolean requiresReflection,
                                     AnnotationMetadata annotationMetadata,
                                     @Nullable
                                     java.util.Map<java.lang.String,java.lang.Object> typeArguments)

Description copied from interface: BeanDefinitionVisitor

Visits a field injection point.

Specified by:

visitFieldInjectionPoint in interface BeanDefinitionVisitor

Parameters:

declaringType - The declaring type. Either a Class or a string representing the name of the type

fieldType - The type of the field

fieldName - The name of the field

requiresReflection - Whether accessing the field requires reflection

annotationMetadata - The annotation metadata for the field

typeArguments - The generic type arguments

visitFieldValue

public void visitFieldValue(java.lang.Object declaringType,
                            java.lang.Object fieldType,
                            java.lang.String fieldName,
                            boolean requiresReflection,
                            AnnotationMetadata annotationMetadata,
                            @Nullable
                            java.util.Map<java.lang.String,java.lang.Object> typeArguments,
                            boolean isOptional)

Description copied from interface: BeanDefinitionVisitor

Visits a field injection point.

Specified by:

visitFieldValue in interface BeanDefinitionVisitor

Parameters:

declaringType - The declaring type. Either a Class or a string representing the name of the type

fieldType - The type of the field

fieldName - The name of the field

requiresReflection - Whether accessing the field requires reflection

annotationMetadata - The annotation metadata for the field

typeArguments - The generic type arguments

isOptional - Is the value optional