io.micronaut.inject.writer

Interface BeanDefinitionVisitor

All Known Subinterfaces:

ProxyingBeanDefinitionVisitor

All Known Implementing Classes:

AopProxyWriter, BeanDefinitionWriter

public interface BeanDefinitionVisitor

Interface for BeanDefinitionVisitor implementations such as BeanDefinitionWriter.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROXY_SUFFIX The suffix use for generated AOP intercepted types.

Method Summary

Modifier and Type	Method and Description
void	accept(ClassWriterOutputVisitor visitor) Write the class to output via a visitor that manages output destination.
AnnotationMetadata	getAnnotationMetadata()
String	getBeanDefinitionName()
String	getBeanSimpleName()
String	getBeanTypeName()
String	getPackageName()
org.objectweb.asm.Type	getProvidedType() The provided type of the bean.
boolean	isInterface()
boolean	isSingleton()
boolean	isValidated()
default 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.
void	visitBeanDefinitionConstructor(AnnotationMetadata annotationMetadata, boolean requiresReflection) Visits a no arguments constructor.
void	visitBeanDefinitionConstructor(AnnotationMetadata annotationMetadata, boolean requiresReflection, Map<String,Object> argumentTypes, Map<String,AnnotationMetadata> argumentAnnotationMetadata, Map<String,Map<String,Object>> genericTypes) Visits the constructor used to create the bean definition.
void	visitBeanDefinitionEnd() Finalize the bean definition to the given output stream.
void	visitBeanDefinitionInterface(Class<? extends BeanDefinition> interfaceType) Visit a marker interface on the generated bean definition.
void	visitConfigBuilderDurationMethod(String prefix, Object returnType, String methodName, String path) Visit a configuration builder method that accepts a long and a TimeUnit.
void	visitConfigBuilderEnd() Finalize a configuration builder field.
void	visitConfigBuilderField(Object type, String field, AnnotationMetadata annotationMetadata, ConfigurationMetadataBuilder metadataBuilder) Begin defining a configuration builder.
void	visitConfigBuilderMethod(Object type, String methodName, AnnotationMetadata annotationMetadata, ConfigurationMetadataBuilder metadataBuilder) Begin defining a configuration builder.
void	visitConfigBuilderMethod(String prefix, Object returnType, String methodName, Object paramType, Map<String,Object> generics, String path) Visit a configuration builder method.
ExecutableMethodWriter	visitExecutableMethod(Object declaringType, Object returnType, Object genericReturnType, Map<String,Object> returnTypeGenericTypes, String methodName, Map<String,Object> argumentTypes, Map<String,Object> genericArgumentTypes, Map<String,AnnotationMetadata> argumentAnnotationMetadata, Map<String,Map<String,Object>> genericTypes, AnnotationMetadata annotationMetadata) Visit a method that is to be made executable allow invocation of said method without reflection.
void	visitFieldInjectionPoint(Object declaringType, Object fieldType, String fieldName, boolean requiresReflection, AnnotationMetadata annotationMetadata, Map<String,Object> typeArguments) Visits a field injection point.
void	visitFieldValue(Object declaringType, Object fieldType, String fieldName, boolean requiresReflection, AnnotationMetadata annotationMetadata, Map<String,Object> typeArguments, boolean isOptional) Visits a field injection point.
void	visitMethodInjectionPoint(Object declaringType, boolean requiresReflection, Object returnType, String methodName, Map<String,Object> argumentTypes, Map<String,AnnotationMetadata> argumentAnnotationMetadata, Map<String,Map<String,Object>> genericTypes, AnnotationMetadata annotationMetadata) Visits a method injection point.
void	visitPostConstructMethod(Object declaringType, boolean requiresReflection, Object returnType, String methodName, Map<String,Object> argumentTypes, Map<String,AnnotationMetadata> argumentAnnotationMetadata, Map<String,Map<String,Object>> genericTypes, AnnotationMetadata annotationMetadata) Visits a method injection point.
void	visitPreDestroyMethod(Object declaringType, boolean requiresReflection, Object returnType, String methodName, Map<String,Object> argumentTypes, Map<String,AnnotationMetadata> argumentAnnotationMetadata, Map<String,Map<String,Object>> genericTypes, AnnotationMetadata annotationMetadata) Visits a method injection point.
void	visitSetterValue(Object declaringType, Object returnType, AnnotationMetadata methodMetadata, boolean requiresReflection, Object valueType, String setterName, Map<String,Object> genericTypes, AnnotationMetadata setterArgumentMetadata, boolean isOptional) Visits an injection point for a setter.
void	visitSetterValue(Object declaringType, Object returnType, AnnotationMetadata annotationMetadata, boolean requiresReflection, Object fieldType, String fieldName, String setterName, Map<String,Object> genericTypes, boolean isOptional) Visits an injection point for a field and setter pairing.
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,Object>> typeArguments) Visits the type arguments for the bean.
void	writeTo(File compilationDir) Write the state of the writer to the given compilation directory.

Field Detail

PROXY_SUFFIX

static final String PROXY_SUFFIX

The suffix use for generated AOP intercepted types.

See Also:

Constant Field Values

Method Detail

visitBeanDefinitionConstructor

void visitBeanDefinitionConstructor(AnnotationMetadata annotationMetadata,
                                    boolean requiresReflection)

Visits a no arguments constructor. Either this method or visitBeanDefinitionConstructor(AnnotationMetadata, boolean, Map, Map, Map) should be called at least once.

Parameters:

annotationMetadata - The annotation metadata for the constructor.

requiresReflection - Whether invoking the constructor requires reflection.

visitBeanDefinitionConstructor

void visitBeanDefinitionConstructor(AnnotationMetadata annotationMetadata,
                                    boolean requiresReflection,
                                    Map<String,Object> argumentTypes,
                                    Map<String,AnnotationMetadata> argumentAnnotationMetadata,
                                    Map<String,Map<String,Object>> genericTypes)

Visits the constructor used to create the bean definition.

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 argument annotation metadata

genericTypes - The generic types for each parameter

isInterface

boolean isInterface()

Returns:

Whether the provided type an interface

isSingleton

boolean isSingleton()

Returns:

Is the bean singleton

visitBeanDefinitionInterface

void visitBeanDefinitionInterface(Class<? extends BeanDefinition> interfaceType)

Visit a marker interface on the generated bean definition.

Parameters:

interfaceType - The interface type

visitSuperBeanDefinition

void visitSuperBeanDefinition(String name)

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

Parameters:

name - The super type

visitSuperBeanDefinitionFactory

void visitSuperBeanDefinitionFactory(String beanName)

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

Parameters:

beanName - The bean name

getBeanTypeName

String getBeanTypeName()

Returns:

The full class name of the bean

getProvidedType

org.objectweb.asm.Type getProvidedType()

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

Returns:

The provided type

setValidated

void setValidated(boolean validated)

Make the bean definition as validated by javax.validation.

Parameters:

validated - Whether the bean definition is validated

isValidated

boolean isValidated()

Returns:

Return whether the bean definition is validated.

getBeanDefinitionName

String getBeanDefinitionName()

Returns:

The name of the bean definition class

visitBeanDefinitionEnd

void visitBeanDefinitionEnd()

Finalize the bean definition to the given output stream.

writeTo

void writeTo(File compilationDir)
      throws IOException

Write the state of the writer to the given compilation directory.

Parameters:

compilationDir - The compilation directory

Throws:

IOException - If an I/O error occurs

accept

void accept(ClassWriterOutputVisitor visitor)
     throws IOException

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

Parameters:

visitor - the writer output visitor

Throws:

IOException - If an error occurs

visitSetterValue

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

Visits an injection point for a field and setter pairing.

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

void visitSetterValue(Object declaringType,
                      Object returnType,
                      AnnotationMetadata methodMetadata,
                      boolean requiresReflection,
                      Object valueType,
                      String setterName,
                      Map<String,Object> genericTypes,
                      AnnotationMetadata setterArgumentMetadata,
                      boolean isOptional)

Visits an injection point for a setter.

Parameters:

declaringType - The declaring type

returnType - The return type

methodMetadata - 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

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

Visits a method injection point.

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

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

Visits a method injection point.

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

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

Visits a method injection point.

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

ExecutableMethodWriter visitExecutableMethod(Object declaringType,
                                             Object returnType,
                                             Object genericReturnType,
                                             Map<String,Object> returnTypeGenericTypes,
                                             String methodName,
                                             Map<String,Object> argumentTypes,
                                             Map<String,Object> genericArgumentTypes,
                                             Map<String,AnnotationMetadata> argumentAnnotationMetadata,
                                             Map<String,Map<String,Object>> genericTypes,
                                             @Nullable
                                             AnnotationMetadata annotationMetadata)

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

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

Returns:

The ExecutableMethodWriter.

visitFieldInjectionPoint

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

Visits a field injection point.

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

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

Visits a field injection point.

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

getPackageName

String getPackageName()

Returns:

The package name of the bean

getBeanSimpleName

String getBeanSimpleName()

Returns:

The short name of the bean

getAnnotationMetadata

AnnotationMetadata getAnnotationMetadata()

Returns:

The annotation metadata

visitConfigBuilderField

void visitConfigBuilderField(Object type,
                             String field,
                             AnnotationMetadata annotationMetadata,
                             ConfigurationMetadataBuilder metadataBuilder)

Begin defining a configuration builder.

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

See Also:

ConfigurationBuilder

visitConfigBuilderMethod

void visitConfigBuilderMethod(Object type,
                              String methodName,
                              AnnotationMetadata annotationMetadata,
                              ConfigurationMetadataBuilder metadataBuilder)

Begin defining a configuration builder.

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

See Also:

ConfigurationBuilder

visitConfigBuilderMethod

void visitConfigBuilderMethod(String prefix,
                              Object returnType,
                              String methodName,
                              Object paramType,
                              Map<String,Object> generics,
                              String path)

Visit a configuration builder method.

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

visitConfigBuilderDurationMethod

void visitConfigBuilderDurationMethod(String prefix,
                                      Object returnType,
                                      String methodName,
                                      String path)

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

Parameters:

prefix - The prefix used for the method

returnType - The return type

methodName - The method name

path - The property path

See Also:

ConfigurationBuilder

visitConfigBuilderEnd

void visitConfigBuilderEnd()

Finalize a configuration builder field.

See Also:

ConfigurationBuilder

requiresMethodProcessing

default boolean requiresMethodProcessing()

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

Returns:

Whether the bean definition requires method processing

See Also:

Executable.processOnStartup()

setRequiresMethodProcessing

void setRequiresMethodProcessing(boolean shouldPreProcess)

Sets whether the BeanType.requiresMethodProcessing() returns true.

Parameters:

shouldPreProcess - True if they should be pre-processed

visitTypeArguments

void visitTypeArguments(Map<String,Map<String,Object>> typeArguments)

Visits the type arguments for the bean.

Parameters:

typeArguments - The type arguments