Package io.micronaut.aop.writer

Class AopProxyWriter

java.lang.Object

io.micronaut.inject.writer.AbstractClassFileWriter

io.micronaut.aop.writer.AopProxyWriter

All Implemented Interfaces:

Toggleable, BeanDefinitionVisitor, ClassOutputWriter, OriginatingElements, ProxyingBeanDefinitionVisitor, org.objectweb.asm.Opcodes

@Internal
public class AopProxyWriter
extends AbstractClassFileWriter
implements ProxyingBeanDefinitionVisitor, Toggleable

A class that generates AOP proxy classes at compile time.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ADDITIONAL_PARAMETERS_COUNT

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

ARRAY_PATTERN, CONSTRUCTOR_NAME, DEFAULT_MAX_STACK, DESCRIPTOR_DEFAULT_CONSTRUCTOR, METHOD_CREATE_ARGUMENT_SIMPLE, METHOD_CREATE_TYPE_VARIABLE_SIMPLE, METHOD_DEFAULT_CONSTRUCTOR, METHOD_GENERIC_PLACEHOLDER_SIMPLE, originatingElements, 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_RECORD, 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, ASM10_EXPERIMENTAL, ASM4, ASM5, ASM6, ASM7, ASM8, ASM9, 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, V15, V16, V17, V18, V19, V20, V21, V22, V23, V9

Constructor Summary

Constructors

Constructor	Description
AopProxyWriter(BeanDefinitionWriter parent, OptionalValues<Boolean> settings, VisitorContext visitorContext, AnnotationValue<?>... interceptorBinding)	Constructs a new AopProxyWriter for the given parent BeanDefinitionWriter and starting interceptors types.
AopProxyWriter(String packageName, String className, boolean isInterface, boolean implementInterface, Element originatingElement, AnnotationMetadata annotationMetadata, ClassElement[] interfaceTypes, VisitorContext visitorContext, AnnotationValue<?>... interceptorBinding)	Constructs a new AopProxyWriter for the purposes of writing Introduction advise.
AopProxyWriter(String packageName, String className, boolean isInterface, Element originatingElement, AnnotationMetadata annotationMetadata, ClassElement[] interfaceTypes, VisitorContext visitorContext, AnnotationValue<?>... interceptorBinding)	Constructs a new AopProxyWriter for the purposes of writing Introduction advise.

Method Summary

Modifier and Type	Method	Description
void	accept(ClassWriterOutputVisitor visitor)	Write the class to output via a visitor that manages output destination.
static int	findInterceptorsListParameterIndex(List<ParameterElement> parameters)	Find the interceptors list constructor parameter index.
AnnotationMetadata	getAnnotationMetadata()
String	getBeanDefinitionName()
@NonNull String	getBeanDefinitionReferenceClassName()
String	getBeanSimpleName()
String	getBeanTypeName()
Optional<org.objectweb.asm.Type>	getInterceptedType()
String	getPackageName()
org.objectweb.asm.Type	getProvidedType()	The provided type of the bean.
String	getProxiedBeanDefinitionName()
String	getProxiedTypeName()
Map<String,ClassElement>	getTypeArgumentMap()
@NonNull ClassElement[]	getTypeArguments()
boolean	isEnabled()
boolean	isInterface()
boolean	isProxyTarget()	Is the target bean being proxied.
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	setInterceptedType(String typeName)	Sets the name of the intercepted type.
void	setRequiresMethodProcessing(boolean shouldPreProcess)	Sets whether the BeanType.requiresMethodProcessing() returns true.
void	setValidated(boolean validated)	Make the bean definition as validated by jakarta.validation.
protected void	startClass(org.objectweb.asm.ClassVisitor classWriter, String className, org.objectweb.asm.Type superType)
void	visitAnnotationMemberPropertyInjectionPoint(TypedElement annotationMemberBeanType, String annotationMemberProperty, String requiredValue, String notEqualsValue)	Visits an annotation injection point.
void	visitAroundMethod(TypedElement beanType, MethodElement methodElement)	Visit a method that is to be proxied.
void	visitBeanDefinitionConstructor(MethodElement constructor, boolean requiresReflection, VisitorContext visitorContext)	Visits a constructor.
void	visitBeanDefinitionEnd()	Finalizes the proxy.
void	visitBeanDefinitionInterface(Class<? extends BeanDefinition> interfaceType)	Visit a marker interface on the generated bean definition.
void	visitBeanFactoryField(ClassElement factoryClass, FieldElement factoryField)	In the case where the produced class is produced by a factory field annotated with Bean this method should be called.
void	visitBeanFactoryMethod(ClassElement factoryClass, MethodElement factoryMethod)	In the case where the produced class is produced by a factory method annotated with Bean this method should be called.
void	visitBeanFactoryMethod(ClassElement factoryClass, MethodElement factoryMethod, ParameterElement[] parameters)	In the case where the produced class is produced by a factory method annotated with Bean this method should be called.
void	visitConfigBuilderDurationMethod(String propertyName, ClassElement returnType, String methodName, String propertyPath)	Visit a configuration builder method that accepts a long and a TimeUnit.
void	visitConfigBuilderEnd()	Finalize a configuration builder field.
void	visitConfigBuilderField(ClassElement type, String field, AnnotationMetadata annotationMetadata, ConfigurationMetadataBuilder metadataBuilder, boolean isInterface)	Begin defining a configuration builder.
void	visitConfigBuilderMethod(ClassElement type, String methodName, AnnotationMetadata annotationMetadata, ConfigurationMetadataBuilder metadataBuilder, boolean isInterface)	Begin defining a configuration builder.
void	visitConfigBuilderMethod(String propertyName, ClassElement returnType, String methodName, ClassElement paramType, Map<String,ClassElement> generics, String propertyPath)	Visit a configuration builder method.
void	visitDefaultConstructor(AnnotationMetadata annotationMetadata, VisitorContext visitorContext)	Visits the constructor used to create the bean definition in the case where no constructor is present.
int	visitExecutableMethod(TypedElement declaringBean, MethodElement methodElement, VisitorContext visitorContext)	Visit a method that is to be made executable allow invocation of said method without reflection.
void	visitFieldInjectionPoint(TypedElement declaringType, FieldElement fieldType, boolean requiresReflection, VisitorContext visitorContext)	Visits a field injection point.
void	visitFieldValue(TypedElement declaringType, FieldElement fieldType, boolean requiresReflection, boolean isOptional)	Visits a field injection point.
void	visitInterceptorBinding(AnnotationValue<?>... interceptorBinding)	visitInterceptorTypes.
void	visitIntroductionMethod(TypedElement declaringBean, MethodElement methodElement)	Visit an abstract method that is to be implemented.
void	visitMethodInjectionPoint(TypedElement beanType, MethodElement methodElement, boolean requiresReflection, VisitorContext visitorContext)	Visits a method injection point.
void	visitPostConstructMethod(TypedElement declaringType, MethodElement methodElement, boolean requiresReflection, VisitorContext visitorContext)	Visits a method injection point.
void	visitPreDestroyMethod(TypedElement declaringType, MethodElement methodElement, boolean requiresReflection, VisitorContext visitorContext)	Visits a method injection point.
void	visitSetterValue(TypedElement declaringType, MethodElement methodElement, AnnotationMetadata annotationMetadata, boolean requiresReflection, boolean isOptional)	Visits an injection point for a setter.
void	visitSuperBeanDefinition(String name)	Alter the super class of this bean definition.
void	visitSuperBeanDefinitionFactory(String beanName)	Alter the super class of this bean definition to use another factory bean.
void	visitTypeArguments(Map<String,Map<String,ClassElement>> typeArguments)	Visits the type arguments for the bean.
void	writeTo(File compilationDir)	Write the proxy to the given compilation directory.

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

addOriginatingElement, annotateAsGeneratedAndService, buildArgument, buildArgument, buildArgumentWithGenerics, buildArgumentWithGenerics, getConstructorDescriptor, getConstructorDescriptor, getConstructorDescriptor, getInternalName, getMethodDescriptor, getMethodDescriptor, getMethodDescriptor, getMethodDescriptor, getMethodDescriptorForReturnType, getMethodSignature, getObjectType, getOriginatingElement, getOriginatingElements, getTypeDescriptor, getTypeDescriptor, getTypeDescriptor, getTypeDescriptor, getTypeReference, getTypeReferenceForName, implementInterceptedTypeMethod, invokeConstructor, invokeInterfaceStaticMethod, newClassWriterOutputVisitor, pushBoxPrimitiveIfNecessary, pushBoxPrimitiveIfNecessary, pushBoxPrimitiveIfNecessary, pushBuildArgumentsForMethod, pushCastFromObjectToType, pushCastToType, pushCastToType, pushCastToType, pushCastToType, pushCreateArgument, pushCreateArgument, pushListOfString, pushMethodNameAndTypesArguments, pushNewArray, pushNewArray, pushNewArray, pushNewArray, pushNewArray, pushNewArrayIndexed, pushNewInstance, pushReturnTypeArgument, pushStoreInArray, pushStoreInArray, pushStringMapOf, pushTypeArgumentElements, startConstructor, startConstructor, startProtectedMethod, startPublicClass, startPublicFinalMethodZeroArgs, startPublicMethod, startPublicMethod, startPublicMethod, startPublicMethodZeroArgs, startService, startService, toTypeString, visitStaticInitializer, writeClassToDisk

Methods inherited from class java.lang.Object

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

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

getOriginatingElement, isProxiedBean

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

addOriginatingElement, getOriginatingElements

Field Details

ADDITIONAL_PARAMETERS_COUNT

public static final int ADDITIONAL_PARAMETERS_COUNT

See Also:

• Constant Field Values

Constructor Details

AopProxyWriter

public AopProxyWriter(BeanDefinitionWriter parent,
 OptionalValues<Boolean> settings,
 VisitorContext visitorContext,
 AnnotationValue<?>... interceptorBinding)

Constructs a new AopProxyWriter for the given parent BeanDefinitionWriter and starting interceptors types.

Additional Interceptor types can be added downstream with visitInterceptorBinding(AnnotationValue[]) .

Parameters:

parent - The parent BeanDefinitionWriter

settings - optional setting

visitorContext - The visitor context

interceptorBinding - The interceptor binding of the Interceptor instances to be injected

AopProxyWriter

public AopProxyWriter(String packageName,
 String className,
 boolean isInterface,
 Element originatingElement,
 AnnotationMetadata annotationMetadata,
 ClassElement[] interfaceTypes,
 VisitorContext visitorContext,
 AnnotationValue<?>... interceptorBinding)

Constructs a new AopProxyWriter for the purposes of writing Introduction advise.

Parameters:

packageName - The package name

className - The class name

isInterface - Is the target of the advice an interface

originatingElement - The originating element

annotationMetadata - The annotation metadata

interfaceTypes - The additional interfaces to implement

visitorContext - The visitor context

interceptorBinding - The interceptor types

AopProxyWriter

public AopProxyWriter(String packageName,
 String className,
 boolean isInterface,
 boolean implementInterface,
 Element originatingElement,
 AnnotationMetadata annotationMetadata,
 ClassElement[] interfaceTypes,
 VisitorContext visitorContext,
 AnnotationValue<?>... interceptorBinding)

Constructs a new AopProxyWriter for the purposes of writing Introduction advise.

Parameters:

packageName - The package name

className - The class name

isInterface - Is the target of the advice an interface

implementInterface - Whether the interface should be implemented. If false the interfaceTypes argument should contain at least one entry

originatingElement - The originating elements

annotationMetadata - The annotation metadata

interfaceTypes - The additional interfaces to implement

visitorContext - The visitor context

interceptorBinding - The interceptor binding

Method Details

findInterceptorsListParameterIndex

public static int findInterceptorsListParameterIndex(List<ParameterElement> parameters)

Find the interceptors list constructor parameter index.

Parameters:

parameters - The constructor parameters

Returns:

the index

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Whether the component is enabled

isProxyTarget

public boolean isProxyTarget()

Is the target bean being proxied.

Specified by:

isProxyTarget in interface BeanDefinitionVisitor

Returns:

True if the target bean is being proxied

startClass

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

Overrides:

startClass in class AbstractClassFileWriter

Parameters:

classWriter - The current class writer

className - The class name

superType - The super type

visitBeanFactoryMethod

public void visitBeanFactoryMethod(ClassElement factoryClass,
 MethodElement factoryMethod)

Description copied from interface: BeanDefinitionVisitor

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

Specified by:

visitBeanFactoryMethod in interface BeanDefinitionVisitor

Parameters:

factoryClass - The factory class

factoryMethod - The factory method

visitBeanFactoryMethod

public void visitBeanFactoryMethod(ClassElement factoryClass,
 MethodElement factoryMethod,
 ParameterElement[] parameters)

Description copied from interface: BeanDefinitionVisitor

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

Specified by:

visitBeanFactoryMethod in interface BeanDefinitionVisitor

Parameters:

factoryClass - The factory class

factoryMethod - The factory method

parameters - The parameters

visitBeanFactoryField

public void visitBeanFactoryField(ClassElement factoryClass,
 FieldElement factoryField)

Description copied from interface: BeanDefinitionVisitor

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

Specified by:

visitBeanFactoryField in interface BeanDefinitionVisitor

Parameters:

factoryClass - The factory class

factoryField - The factory field

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface BeanDefinitionVisitor

Returns:

Is the bean singleton

isInterface

public boolean isInterface()

Specified by:

isInterface in interface BeanDefinitionVisitor

Returns:

Whether the provided type an interface

visitBeanDefinitionInterface

public void visitBeanDefinitionInterface(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

getBeanTypeName

public 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 jakarta.validation.

Specified by:

setValidated in interface BeanDefinitionVisitor

Parameters:

validated - Whether the bean definition is validated

setInterceptedType

public void setInterceptedType(String typeName)

Description copied from interface: BeanDefinitionVisitor

Sets the name of the intercepted type.

Specified by:

setInterceptedType in interface BeanDefinitionVisitor

Parameters:

typeName - The type name

getInterceptedType

public Optional<org.objectweb.asm.Type> getInterceptedType()

Specified by:

getInterceptedType in interface BeanDefinitionVisitor

Returns:

The intercepted type

isValidated

public boolean isValidated()

Specified by:

isValidated in interface BeanDefinitionVisitor

Returns:

Return whether the bean definition is validated.

getBeanDefinitionName

public String getBeanDefinitionName()

Specified by:

getBeanDefinitionName in interface BeanDefinitionVisitor

Returns:

The name of the bean definition class

visitBeanDefinitionConstructor

public void visitBeanDefinitionConstructor(MethodElement constructor,
 boolean requiresReflection,
 VisitorContext visitorContext)

Visits a constructor.

Specified by:

visitBeanDefinitionConstructor in interface BeanDefinitionVisitor

Parameters:

constructor - The constructor

requiresReflection - Whether reflection is required

visitorContext - The visitor context

visitDefaultConstructor

public void visitDefaultConstructor(AnnotationMetadata annotationMetadata,
 VisitorContext visitorContext)

Description copied from interface: BeanDefinitionVisitor

Visits the constructor used to create the bean definition in the case where no constructor is present. This method should only be called in the class defines no constructor.

Specified by:

visitDefaultConstructor in interface BeanDefinitionVisitor

Parameters:

annotationMetadata - The annotation metadata for the constructor

visitorContext - The visitor context

getBeanDefinitionReferenceClassName

@NonNull
public @NonNull String getBeanDefinitionReferenceClassName()

Specified by:

getBeanDefinitionReferenceClassName in interface BeanDefinitionVisitor

Returns:

The name of the bean definition reference class.

visitIntroductionMethod

public void visitIntroductionMethod(TypedElement declaringBean,
 MethodElement methodElement)

Visit an abstract method that is to be implemented.

Parameters:

declaringBean - The declaring bean of the method.

methodElement - The method element

visitAroundMethod

public void visitAroundMethod(TypedElement beanType,
 MethodElement methodElement)

Visit a method that is to be proxied.

Parameters:

beanType - The bean type.

methodElement - The method element

visitBeanDefinitionEnd

public void visitBeanDefinitionEnd()

Finalizes the proxy. This method should be called before writing the proxy to disk with writeTo(File)

Specified by:

visitBeanDefinitionEnd in interface BeanDefinitionVisitor

writeTo

public void writeTo(File compilationDir)
             throws IOException

Write the proxy to the given compilation directory.

Specified by:

writeTo in interface BeanDefinitionVisitor

Overrides:

writeTo in class AbstractClassFileWriter

Parameters:

compilationDir - The target compilation directory

Throws:

IOException - If an error occurs writing the file

getTypeArguments

@NonNull
public @NonNull ClassElement[] getTypeArguments()

Specified by:

getTypeArguments in interface BeanDefinitionVisitor

Returns:

The generic type arguments for the bean type.

getTypeArgumentMap

public Map<String,ClassElement> getTypeArgumentMap()

Specified by:

getTypeArgumentMap in interface BeanDefinitionVisitor

Returns:

A map of the type arguments for the bean.

accept

public void accept(ClassWriterOutputVisitor visitor)
            throws IOException

Write the class to output via a visitor that manages output destination.

Specified by:

accept in interface BeanDefinitionVisitor

Specified by:

accept in interface ClassOutputWriter

Parameters:

visitor - the writer output visitor

Throws:

IOException - If an error occurs

visitSuperBeanDefinition

public void visitSuperBeanDefinition(String name)

Description copied from interface: BeanDefinitionVisitor

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

Specified by:

visitSuperBeanDefinition in interface BeanDefinitionVisitor

Parameters:

name - The super type

visitSuperBeanDefinitionFactory

public void visitSuperBeanDefinitionFactory(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

visitSetterValue

public void visitSetterValue(TypedElement declaringType,
 MethodElement methodElement,
 AnnotationMetadata annotationMetadata,
 boolean requiresReflection,
 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

methodElement - The method element

annotationMetadata - The annotationMetadata

requiresReflection - Whether the setter requires reflection

isOptional - Whether the setter is optional

visitPostConstructMethod

public void visitPostConstructMethod(TypedElement declaringType,
 MethodElement methodElement,
 boolean requiresReflection,
 VisitorContext visitorContext)

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

methodElement - The method element

requiresReflection - Whether the method requires reflection

visitorContext - The visitor context

visitPreDestroyMethod

public void visitPreDestroyMethod(TypedElement declaringType,
 MethodElement methodElement,
 boolean requiresReflection,
 VisitorContext visitorContext)

Description copied from interface: BeanDefinitionVisitor

Visits a method injection point.

Specified by:

visitPreDestroyMethod in interface BeanDefinitionVisitor

Parameters:

declaringType - The bean type of the method

methodElement - The method element

requiresReflection - Whether the method requires reflection

visitorContext - The visitor context

visitMethodInjectionPoint

public void visitMethodInjectionPoint(TypedElement beanType,
 MethodElement methodElement,
 boolean requiresReflection,
 VisitorContext visitorContext)

Description copied from interface: BeanDefinitionVisitor

Visits a method injection point.

Specified by:

visitMethodInjectionPoint in interface BeanDefinitionVisitor

Parameters:

beanType - The bean type of the method

methodElement - The method element

requiresReflection - Whether the method requires reflection

visitorContext - The visitor context

visitExecutableMethod

public int visitExecutableMethod(TypedElement declaringBean,
 MethodElement methodElement,
 VisitorContext visitorContext)

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:

declaringBean - The declaring bean of the method. Note this may differ from MemberElement.getDeclaringType() in the case of the method coming from a super class or interface.

methodElement - The method element

visitorContext - The visitor context

Returns:

The index of a new method

visitFieldInjectionPoint

public void visitFieldInjectionPoint(TypedElement declaringType,
 FieldElement fieldType,
 boolean requiresReflection,
 VisitorContext visitorContext)

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 field element

requiresReflection - Whether accessing the field requires reflection

visitorContext - The visitor context

visitAnnotationMemberPropertyInjectionPoint

public void visitAnnotationMemberPropertyInjectionPoint(TypedElement annotationMemberBeanType,
 String annotationMemberProperty,
 String requiredValue,
 String notEqualsValue)

Description copied from interface: BeanDefinitionVisitor

Visits an annotation injection point.

Specified by:

visitAnnotationMemberPropertyInjectionPoint in interface BeanDefinitionVisitor

Parameters:

annotationMemberBeanType - The type of the injected bean

annotationMemberProperty - Required property of the injected bean

requiredValue - Required value of the bean property for the bean to be loaded

notEqualsValue - The bean property value which should not be equal to present value for the bean to be loaded

visitFieldValue

public void visitFieldValue(TypedElement declaringType,
 FieldElement fieldType,
 boolean requiresReflection,
 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 field element

requiresReflection - Whether accessing the field requires reflection

isOptional - Is the value optional

getPackageName

public String getPackageName()

Specified by:

getPackageName in interface BeanDefinitionVisitor

Returns:

The package name of the bean

getBeanSimpleName

public 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(ClassElement type,
 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(ClassElement type,
 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

visitConfigBuilderMethod

public void visitConfigBuilderMethod(String propertyName,
 ClassElement returnType,
 String methodName,
 ClassElement paramType,
 Map<String,ClassElement> generics,
 String propertyPath)

Description copied from interface: BeanDefinitionVisitor

Visit a configuration builder method.

Specified by:

visitConfigBuilderMethod in interface BeanDefinitionVisitor

Parameters:

propertyName - The property name

returnType - The return type

methodName - The method name

paramType - The method type

generics - The generic types of the method

propertyPath - The property path

See Also:

• ConfigurationBuilder

visitConfigBuilderDurationMethod

public void visitConfigBuilderDurationMethod(String propertyName,
 ClassElement returnType,
 String methodName,
 String propertyPath)

Description copied from interface: BeanDefinitionVisitor

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

Specified by:

visitConfigBuilderDurationMethod in interface BeanDefinitionVisitor

Parameters:

propertyName - The property name

returnType - The return type

methodName - The method name

propertyPath - 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(Map<String,Map<String,ClassElement>> 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()

getProxiedTypeName

public String getProxiedTypeName()

Specified by:

getProxiedTypeName in interface ProxyingBeanDefinitionVisitor

Returns:

The fully qualified name of the class being proxied

getProxiedBeanDefinitionName

public String getProxiedBeanDefinitionName()

Specified by:

getProxiedBeanDefinitionName in interface ProxyingBeanDefinitionVisitor

Returns:

The bean definition that is proxied

visitInterceptorBinding

public void visitInterceptorBinding(AnnotationValue<?>... interceptorBinding)

visitInterceptorTypes.

Parameters:

interceptorBinding - the interceptor binding