Package io.micronaut.inject.writer

Class BeanDefinitionWriter

java.lang.Object

io.micronaut.inject.writer.BeanDefinitionWriter

All Implemented Interfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Described, Named, Toggleable, MutableAnnotationMetadataDelegate<Element>, BeanElement, Element, BeanDefinitionVisitor, ClassOutputWriter, OriginatingElements

@Internal
public final class BeanDefinitionWriter
extends Object
implements ClassOutputWriter, BeanDefinitionVisitor, BeanElement, Toggleable

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", "jakarta.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, Denis Stepanov

See Also:

• BeanDefinition

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLASS_SUFFIX
static final String	OMIT_CONFPROP_INJECTION_POINTS

Fields inherited from interface io.micronaut.core.annotation.AnnotationMetadata

CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER

Fields inherited from interface io.micronaut.core.annotation.AnnotationSource

EMPTY

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

PROXY_SUFFIX

Fields inherited from interface io.micronaut.inject.ast.Element

EMPTY_ELEMENT_ARRAY

Fields inherited from interface io.micronaut.inject.ast.annotation.MutableAnnotationMetadataDelegate

EMPTY

Constructor Summary

Constructors

Constructor	Description
BeanDefinitionWriter(ClassElement classElement, VisitorContext visitorContext)	Creates a bean definition writer.
BeanDefinitionWriter(ClassElement classElement, OriginatingElements originatingElements, VisitorContext visitorContext)	Creates a bean definition writer.
BeanDefinitionWriter(Element beanProducingElement, OriginatingElements originatingElements, VisitorContext visitorContext, @Nullable Integer uniqueIdentifier)	Creates a bean definition writer.

Method Summary

Modifier and Type	Method	Description
void	accept(ClassWriterOutputVisitor visitor)	Accept a ClassWriterOutputVisitor to write this writer to disk.
BeanElementBuilder	addAssociatedBean(ClassElement type, VisitorContext visitorContext)	This method adds an associated bean using this class element as the originating element.
void	addOriginatingElement(Element element)	Add another element that should be included in the originating elements.
<T extends Annotation> Element	annotate(String annotationType, Consumer<AnnotationValueBuilder<T>> consumer)	Annotate this element with the given annotation type.
static void	finish()	Finish any work writing beans.
void	generateProxyReference(String proxyBeanDefinitionName, String proxyBeanTypeName)	Mark to generate proxy methods.
AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
String	getBeanDefinitionName()
@NonNull String	getBeanDefinitionReferenceClassName()
String	getBeanSimpleName()
String	getBeanTypeName()
Set<ClassElement>	getBeanTypes()	The type names produced by the bean.
ClassElement	getDeclaringClass()	Returns the declaring ClassElement which may differ from the BeanElement.getBeanTypes() in the case of factory beans.
@Nullable ExecutableMethodsDefinitionWriter	getExecutableMethodsWriter()	Returns ExecutableMethodsDefinitionWriter of one exists.
Collection<Element>	getInjectionPoints()	Returns all injection points for the bean.
Optional<String>	getInterceptedType()
String	getName()
Object	getNativeType()	Returns the native underlying type.
Element	getOriginatingElement()
Element[]	getOriginatingElements()
String	getPackageName()
List<BeanDefinitionWriter.MethodVisitData>	getPostConstructMethodVisits()
Element	getProducingElement()	The element that produces the bean, this could be a ClassElement for regular beans, or either a MethodElement or FieldElement for factory beans.
Collection<String>	getQualifiers()
Optional<String>	getScope()	The scope of the bean.
@NonNull Map<String,ClassElement>	getTypeArgumentMap()
@NonNull ClassElement[]	getTypeArguments()
boolean	isAbstract()
boolean	isEnabled()
boolean	isInterface()
boolean	isProtected()
boolean	isProxiedBean()	Returns whether another bean exists that proxies this bean.
boolean	isProxyTarget()	Returns whether another bean is a proxy target that needs to be retained.
boolean	isPublic()
boolean	isSingleton()
boolean	isValidated()
Element	removeAnnotation(String annotationType)	Removes an annotation of the given type from the element.
<T extends Annotation> Element	removeAnnotationIf(Predicate<AnnotationValue<T>> predicate)	Removes all annotations that pass the given predicate.
Element	removeStereotype(String annotationType)	Removes a stereotype of the given name from the element.
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	setProxiedBean(boolean proxiedBean, boolean isProxyTarget)	Sets whether this bean is a proxied 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.
byte[]	toByteArray()
String	toString()
void	visitAnnotationMemberPropertyInjectionPoint(TypedElement annotationMemberBeanType, String annotationMemberProperty, @Nullable String requiredValue, @Nullable String notEqualsValue)	Visits an annotation injection point.
void	visitBeanDefinitionConstructor(MethodElement constructor, boolean requiresReflection, VisitorContext visitorContext)	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	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 path)	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 path)	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.
int	visitExecutableMethod(TypedElement declaringType, MethodElement methodElement, io.micronaut.sourcegen.model.ClassTypeDef interceptedProxyType, io.micronaut.sourcegen.model.MethodDef interceptedProxyBridgeMethod)	Visit a method that is to be made executable allow invocation of said method without reflection.
void	visitFieldInjectionPoint(TypedElement declaringType, FieldElement fieldElement, boolean requiresReflection, VisitorContext visitorContext)	Visits a field injection point.
void	visitFieldValue(TypedElement declaringType, FieldElement fieldElement, boolean requiresReflection, boolean isOptional)	Visits a field injection point.
void	visitMethodInjectionPoint(TypedElement declaringType, 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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.annotation.AnnotatedElement

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadata

enumValuesSet, enumValuesSet, getValues, hasDeclaredStereotype, hasEvaluatedExpressions, hasStereotypeNonRepeating, isAnnotationPresent, isDeclaredAnnotationPresent

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataDelegate

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, copyAnnotationMetadata, doubleValue, doubleValue, doubleValue, enumValue, enumValue, enumValue, enumValue, enumValues, enumValues, enumValues, enumValues, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, findRepeatableAnnotation, findRepeatableAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByName, getAnnotationValuesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByName, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDeclaredStereotypeAnnotationNames, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getStereotypeAnnotationNames, getTargetAnnotationMetadata, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasPropertyExpressions, hasSimpleAnnotation, hasSimpleDeclaredAnnotation, hasStereotype, hasStereotype, hasStereotype, hasStereotype, intValue, intValue, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isEmpty, isFalse, isFalse, isPresent, isPresent, isRepeatableAnnotation, isRepeatableAnnotation, isTrue, isTrue, longValue, longValue, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, stringValues, stringValues, synthesize, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

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

writeTo

Methods inherited from interface io.micronaut.inject.ast.Element

annotate, annotate, annotate, annotate, getDescription, getDescription, getDocumentation, getModifiers, getSimpleName, isFinal, isPackagePrivate, isPrivate, isStatic, isSynthetic, removeAnnotation, removeStereotype, withAnnotationMetadata

Field Details

OMIT_CONFPROP_INJECTION_POINTS

@NextMajorVersion("Inline as true")
public static final String OMIT_CONFPROP_INJECTION_POINTS

See Also:

• Constant Field Values

CLASS_SUFFIX

public static final String CLASS_SUFFIX

See Also:

• Constant Field Values

Constructor Details

BeanDefinitionWriter

public BeanDefinitionWriter(ClassElement classElement,
 VisitorContext visitorContext)

Creates a bean definition writer.

Parameters:

classElement - The class element

visitorContext - The visitor context

BeanDefinitionWriter

public BeanDefinitionWriter(ClassElement classElement,
 OriginatingElements originatingElements,
 VisitorContext visitorContext)

Creates a bean definition writer.

Parameters:

classElement - The class element

originatingElements - The originating elements

visitorContext - The visitor context

BeanDefinitionWriter

public BeanDefinitionWriter(Element beanProducingElement,
 OriginatingElements originatingElements,
 VisitorContext visitorContext,
 @Nullable
 @Nullable Integer uniqueIdentifier)

Creates a bean definition writer.

Parameters:

beanProducingElement - The bean producing element

originatingElements - The originating elements

visitorContext - The visitor context

uniqueIdentifier - An optional unique identifier to include in the bean name

Method Details

generateProxyReference

public void generateProxyReference(String proxyBeanDefinitionName,
 String proxyBeanTypeName)

Mark to generate proxy methods.

Parameters:

proxyBeanDefinitionName - The definition name

proxyBeanTypeName - The proxy bean name

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Toggleable

Returns:

Whether the component is enabled

getExecutableMethodsWriter

@Nullable
public @Nullable ExecutableMethodsDefinitionWriter getExecutableMethodsWriter()

Returns ExecutableMethodsDefinitionWriter of one exists.

Returns:

An instance of ExecutableMethodsDefinitionWriter

getTypeArguments

@NonNull
public @NonNull ClassElement[] getTypeArguments()

Specified by:

getTypeArguments in interface BeanDefinitionVisitor

Returns:

The generic type arguments for the bean type.

getTypeArgumentMap

@NonNull
public @NonNull Map<String,ClassElement> getTypeArgumentMap()

Specified by:

getTypeArgumentMap in interface BeanDefinitionVisitor

Returns:

A map of the type arguments for the bean.

getBeanDefinitionReferenceClassName

@NonNull
public @NonNull String getBeanDefinitionReferenceClassName()

Specified by:

getBeanDefinitionReferenceClassName in interface BeanDefinitionVisitor

Returns:

The name of the bean definition reference class.

getPostConstructMethodVisits

public List<BeanDefinitionWriter.MethodVisitData> getPostConstructMethodVisits()

Returns:

The data for any post construct methods that were visited

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

getBeanTypeName

public String getBeanTypeName()

Specified by:

getBeanTypeName in interface BeanDefinitionVisitor

Returns:

The full class name of the bean

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

getOriginatingElement

public Element getOriginatingElement()

Specified by:

getOriginatingElement in interface BeanDefinitionVisitor

Specified by:

getOriginatingElement in interface BeanElement

Returns:

The element where the bean definition originated from.

visitBeanFactoryMethod

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

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)

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)

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

visitBeanDefinitionConstructor

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

Visits the constructor used to create the bean definition.

Specified by:

visitBeanDefinitionConstructor in interface BeanDefinitionVisitor

Parameters:

constructor - The constructor

requiresReflection - Whether invoking the constructor requires reflection

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

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 IOException

Description copied from interface: ClassOutputWriter

Accept a ClassWriterOutputVisitor to write this writer to disk.

Specified by:

accept in interface BeanDefinitionVisitor

Specified by:

accept in interface ClassOutputWriter

Parameters:

visitor - The ClassWriterOutputVisitor

Throws:

IOException - if there is an error writing to disk

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 declaringType,
 MethodElement methodElement,
 boolean requiresReflection,
 VisitorContext visitorContext)

Description copied from interface: BeanDefinitionVisitor

Visits a method injection point.

Specified by:

visitMethodInjectionPoint 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

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

visitExecutableMethod

public int visitExecutableMethod(TypedElement declaringType,
 MethodElement methodElement,
 io.micronaut.sourcegen.model.ClassTypeDef interceptedProxyType,
 io.micronaut.sourcegen.model.MethodDef interceptedProxyBridgeMethod)

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

methodElement - The method element

interceptedProxyType - The intercepted proxy type

interceptedProxyBridgeMethod - The intercepted proxy bridge method name

Returns:

The index of a new method.

toString

public String toString()

Overrides:

toString in class Object

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()

Description copied from interface: AnnotationMetadataProvider

Supplies the metadata. Defaults to AnnotationMetadata.EMPTY_METADATA.

Specified by:

getAnnotationMetadata in interface AnnotationMetadataProvider

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

visitConfigBuilderDurationMethod

public void visitConfigBuilderDurationMethod(String propertyName,
 ClassElement returnType,
 String methodName,
 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:

propertyName - The property name

returnType - The return type

methodName - The method name

path - The property path

See Also:

• ConfigurationBuilder

visitConfigBuilderMethod

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

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

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(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()

visitFieldInjectionPoint

public void visitFieldInjectionPoint(TypedElement declaringType,
 FieldElement fieldElement,
 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

fieldElement - The field element

requiresReflection - Whether accessing the field requires reflection

visitorContext - The visitor context

visitAnnotationMemberPropertyInjectionPoint

public void visitAnnotationMemberPropertyInjectionPoint(TypedElement annotationMemberBeanType,
 String annotationMemberProperty,
 @Nullable
 @Nullable String requiredValue,
 @Nullable
 @Nullable 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 fieldElement,
 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

fieldElement - The field element

requiresReflection - Whether accessing the field requires reflection

isOptional - Is the value optional

getName

public String getName()

Specified by:

getName in interface Element

Specified by:

getName in interface Named

Returns:

The name of the element. For a type this represents the binary name.

isProtected

public boolean isProtected()

Specified by:

isProtected in interface Element

Returns:

True if the element is protected.

isPublic

public boolean isPublic()

Specified by:

isPublic in interface Element

Returns:

True if the element is public.

getNativeType

public Object getNativeType()

Description copied from interface: Element

Returns the native underlying type. This API is extended by all inject language implementations. The object returned by this method will be the language native type the information is being retrieved from.

Specified by:

getNativeType in interface Element

Returns:

The native type

getInjectionPoints

public Collection<Element> getInjectionPoints()

Description copied from interface: BeanElement

Returns all injection points for the bean. These will be a combination of FieldElement and MethodElement instances.

Specified by:

getInjectionPoints in interface BeanElement

Returns:

The injection points for the bean.

isAbstract

public boolean isAbstract()

Specified by:

isAbstract in interface Element

Returns:

True if the element is abstract.

annotate

public <T extends Annotation> Element annotate(String annotationType,
 Consumer<AnnotationValueBuilder<T>> consumer)

Description copied from interface: MutableAnnotationMetadataDelegate

Annotate this element with the given annotation type. If the annotation is already present then any values populated by the builder will be merged/overridden with the existing values.

Specified by:

annotate in interface Element

Specified by:

annotate in interface MutableAnnotationMetadataDelegate<Element>

Type Parameters:

T - The annotation generic type

Parameters:

annotationType - The annotation type

consumer - A function that receives the AnnotationValueBuilder

Returns:

This element

removeAnnotation

public Element removeAnnotation(String annotationType)

Description copied from interface: MutableAnnotationMetadataDelegate

Removes an annotation of the given type from the element.

If the annotation features any stereotypes these will also be removed unless there are other annotations that reference the stereotype to be removed.

In the case of repeatable annotations this method will remove all repeated annotations, effectively clearing out all declared repeated annotations of the given type.

Specified by:

removeAnnotation in interface Element

Specified by:

removeAnnotation in interface MutableAnnotationMetadataDelegate<Element>

Parameters:

annotationType - The annotation type

Returns:

This element

removeAnnotationIf

public <T extends Annotation> Element removeAnnotationIf(Predicate<AnnotationValue<T>> predicate)

Description copied from interface: MutableAnnotationMetadataDelegate

Removes all annotations that pass the given predicate.

Specified by:

removeAnnotationIf in interface Element

Specified by:

removeAnnotationIf in interface MutableAnnotationMetadataDelegate<Element>

Type Parameters:

T - The annotation generic type

Parameters:

predicate - The predicate

Returns:

This element

removeStereotype

public Element removeStereotype(String annotationType)

Description copied from interface: MutableAnnotationMetadataDelegate

Removes a stereotype of the given name from the element.

Specified by:

removeStereotype in interface Element

Specified by:

removeStereotype in interface MutableAnnotationMetadataDelegate<Element>

Parameters:

annotationType - The annotation type

Returns:

This element

getDeclaringClass

public ClassElement getDeclaringClass()

Description copied from interface: BeanElement

Returns the declaring ClassElement which may differ from the BeanElement.getBeanTypes() in the case of factory beans.

Specified by:

getDeclaringClass in interface BeanElement

Returns:

The declaring class of the bean.

getProducingElement

public Element getProducingElement()

Description copied from interface: BeanElement

The element that produces the bean, this could be a ClassElement for regular beans, or either a MethodElement or FieldElement for factory beans.

Specified by:

getProducingElement in interface BeanElement

Returns:

The producing element

getBeanTypes

public Set<ClassElement> getBeanTypes()

Description copied from interface: BeanElement

The type names produced by the bean.

Specified by:

getBeanTypes in interface BeanElement

Returns:

A set of types

getScope

public Optional<String> getScope()

Description copied from interface: BeanElement

The scope of the bean.

Specified by:

getScope in interface BeanElement

Returns:

The fully qualified name of the scope or empty if no scope is defined.

getQualifiers

public Collection<String> getQualifiers()

Specified by:

getQualifiers in interface BeanElement

Returns:

One or more fully qualified qualifier types defined by the bean.

addAssociatedBean

public BeanElementBuilder addAssociatedBean(ClassElement type,
 VisitorContext visitorContext)

Description copied from interface: BeanElement

This method adds an associated bean using this class element as the originating element.

Note that this method can only be called on classes being directly compiled by Micronaut. If the ClassElement is loaded from pre-compiled code an UnsupportedOperationException will be thrown.

Specified by:

addAssociatedBean in interface BeanElement

Parameters:

type - The type of the bean

visitorContext - The visitor context

Returns:

A bean builder

getOriginatingElements

public Element[] getOriginatingElements()

Specified by:

getOriginatingElements in interface OriginatingElements

Returns:

The elements where the bean definition originated from as an array.

addOriginatingElement

public void addOriginatingElement(Element element)

Description copied from interface: OriginatingElements

Add another element that should be included in the originating elements.

Specified by:

addOriginatingElement in interface OriginatingElements

Parameters:

element - The element to add

setProxiedBean

public void setProxiedBean(boolean proxiedBean,
 boolean isProxyTarget)

Sets whether this bean is a proxied type.

Parameters:

proxiedBean - True if it proxied

isProxyTarget - True if the proxied bean is a retained target

isProxyTarget

public boolean isProxyTarget()

Description copied from interface: BeanDefinitionVisitor

Returns whether another bean is a proxy target that needs to be retained.

Specified by:

isProxyTarget in interface BeanDefinitionVisitor

Returns:

Is the reference a proxy target.

isProxiedBean

public boolean isProxiedBean()

Description copied from interface: BeanDefinitionVisitor

Returns whether another bean exists that proxies this bean. In other words this bean is the target of a proxy.

Specified by:

isProxiedBean in interface BeanDefinitionVisitor

Returns:

Is the reference a proxy target.

finish

@Internal
public static void finish()

Finish any work writing beans.