Package io.micronaut.inject.writer

Class AbstractBeanDefinitionBuilder

java.lang.Object

io.micronaut.inject.writer.AbstractBeanDefinitionBuilder

All Implemented Interfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Described, Named, MutableAnnotationMetadataDelegate<Element>, BeanElementBuilder, ConfigurableElement, Element

@Internal
public abstract class AbstractBeanDefinitionBuilder
extends Object
implements BeanElementBuilder

Abstract implementation of the BeanElementBuilder interface that should be implemented by downstream language specific implementations.

Since:

3.0.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field	Description
protected final ElementAnnotationMetadataFactory	elementAnnotationMetadataFactory
protected final ConfigurationMetadataBuilder	metadataBuilder
protected final VisitorContext	visitorContext

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.ast.Element

EMPTY_ELEMENT_ARRAY

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

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractBeanDefinitionBuilder(Element originatingElement, ClassElement beanType, ConfigurationMetadataBuilder metadataBuilder, VisitorContext visitorContext, ElementAnnotationMetadataFactory elementAnnotationMetadataFactory)	Default constructor.

Method Summary

Modifier and Type	Method	Description
protected abstract <T extends Annotation> void	annotate(@NonNull AnnotationMetadata annotationMetadata, @NonNull AnnotationValue<T> annotationValue)	Add an annotation to the given metadata.
<T extends Annotation> @NonNull BeanElementBuilder	annotate(@NonNull String annotationType, @NonNull Consumer<AnnotationValueBuilder<T>> consumer)	Annotate this element with the given annotation type.
protected abstract <T extends Annotation> void	annotate(AnnotationMetadata annotationMetadata, String annotationType, Consumer<AnnotationValueBuilder<T>> consumer)	Add an annotation to the given metadata.
<T extends Annotation> Element	annotate(AnnotationValue<T> annotationValue)	Annotate this element with the given annotation type.
@Nullable BeanClassWriter	build()	Build the bean definition writer.
protected boolean	configureBeanVisitor(BeanDefinitionVisitor beanDefinitionWriter)	Configure the bean visitor for this builder.
protected abstract @NonNull BeanDefinitionVisitor	createAopWriter(BeanDefinitionWriter beanDefinitionWriter, AnnotationMetadata annotationMetadata)	Creates the AOP writer.
protected abstract @NonNull BiConsumer<TypedElement,MethodElement>	createAroundMethodVisitor(BeanDefinitionVisitor aopProxyWriter)	Creates the around method visitor.
protected BeanDefinitionVisitor	createBeanDefinitionWriter()
protected abstract @NonNull AbstractBeanDefinitionBuilder	createChildBean(FieldElement producerField)	Creates a child bean for the given producer field.
protected abstract @NonNull AbstractBeanDefinitionBuilder	createChildBean(MethodElement producerMethod)	Creates a child bean for the given producer method.
@NonNull BeanElementBuilder	createWith(@NonNull MethodElement element)	Specifies the bean will be created with the given method element.
protected void	finalizeAndWriteBean(ClassWriterOutputVisitor classWriterOutputVisitor, BeanDefinitionVisitor beanDefinitionWriter)	Finish the given bean and write it to the output.
@NonNull AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
@NonNull ClassElement	getBeanType()
List<AbstractBeanDefinitionBuilder>	getChildBeans()	Any child bean definitions.
@NonNull String	getName()
@NonNull Object	getNativeType()	Returns the native underlying type.
@NonNull Element	getOriginatingElement()
protected @NonNull BeanParameterElement[]	getParameters()
protected final BeanParameterElement[]	initBeanParameters(@NonNull ParameterElement[] constructorParameters)	Initialize the bean parameters.
BeanElementBuilder	inject()	Dependency inject this bean.
BeanElementBuilder	intercept(AnnotationValue<?>... annotationValue)	Intercept the bean.
protected boolean	isIntercepted()	Is the bean to be built intercepted?
boolean	isProtected()
boolean	isPublic()
<E extends MemberElement> BeanElementBuilder	produceBeans(ElementQuery<E> methodsOrFields, Consumer<BeanElementBuilder> childBeanBuilder)	Produce additional beans from the given methods.
BeanElementBuilder	removeAnnotation(@NonNull String annotationType)	Removes an annotation of the given type from the element.
protected abstract void	removeAnnotation(AnnotationMetadata annotationMetadata, String annotationType)	Remove an annotation for the given name.
<T extends Annotation> BeanElementBuilder	removeAnnotationIf(@NonNull Predicate<AnnotationValue<T>> predicate)	Removes all annotations that pass the given predicate.
protected abstract <T extends Annotation> void	removeAnnotationIf(AnnotationMetadata annotationMetadata, Predicate<AnnotationValue<T>> predicate)	Remove an annotation if it matches the given condition.
BeanElementBuilder	removeStereotype(@NonNull String annotationType)	Removes a stereotype of the given name from the element.
protected abstract void	removeStereotype(AnnotationMetadata annotationMetadata, String annotationType)	Remove a stereotype from the given metadata.
@NonNull BeanElementBuilder	typeArguments(@NonNull ClassElement... types)	Fills the type arguments for the bean with the given types.
@NonNull BeanElementBuilder	typeArgumentsForType(ClassElement type, @NonNull ClassElement... types)	Fills the type arguments for the given interface or super class with the given types.
@NonNull BeanElementBuilder	typed(ClassElement... types)	Alters the exposed types for the bean limiting the exposed type to the given types.
protected void	visitInterceptedMethods(BiConsumer<TypedElement,MethodElement> consumer)	Visit the intercepted methods of this type.
BeanElementBuilder	withConstructor(Consumer<BeanConstructorElement> constructorElement)	Allows configuring the bean constructor.
@NonNull BeanElementBuilder	withFields(@NonNull ElementQuery<FieldElement> fields, @NonNull Consumer<BeanFieldElement> beanFields)	Allows configuring fields of the bean.
@NonNull BeanElementBuilder	withMethods(@NonNull ElementQuery<MethodElement> methods, @NonNull Consumer<BeanMethodElement> beanMethods)	Allows configuring methods of the bean.
@NonNull BeanElementBuilder	withParameters(Consumer<BeanParameterElement[]> parameters)	Allows configuring the parameters for the current constructor.
static void	writeBeanDefinitionBuilders(ClassWriterOutputVisitor classWriterOutputVisitor, List<AbstractBeanDefinitionBuilder> beanDefinitionBuilders)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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.ast.beans.BeanElementBuilder

annotate, annotate, annotate, getDeclaringElement, getProducingElement, produceBeans, qualifier, qualifier, removeAnnotation, removeStereotype, scope, scope

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

getDescription, getDescription, getDocumentation, getModifiers, getSimpleName, isAbstract, isFinal, isPackagePrivate, isPrivate, isStatic, isSynthetic, withAnnotationMetadata

Field Details

metadataBuilder

protected final ConfigurationMetadataBuilder metadataBuilder

visitorContext

protected final VisitorContext visitorContext

elementAnnotationMetadataFactory

protected final ElementAnnotationMetadataFactory elementAnnotationMetadataFactory

Constructor Details

AbstractBeanDefinitionBuilder

protected AbstractBeanDefinitionBuilder(Element originatingElement,
 ClassElement beanType,
 ConfigurationMetadataBuilder metadataBuilder,
 VisitorContext visitorContext,
 ElementAnnotationMetadataFactory elementAnnotationMetadataFactory)

Default constructor.

Parameters:

originatingElement - The originating element

beanType - The bean type

metadataBuilder - the metadata builder

visitorContext - the visitor context

elementAnnotationMetadataFactory - The element annotation metadata factory

Method Details

intercept

public BeanElementBuilder intercept(AnnotationValue<?>... annotationValue)

Description copied from interface: BeanElementBuilder

Intercept the bean.

Specified by:

intercept in interface BeanElementBuilder

Parameters:

annotationValue - The annotation to intercept

Returns:

This bean method

writeBeanDefinitionBuilders

@Internal
public static void writeBeanDefinitionBuilders(ClassWriterOutputVisitor classWriterOutputVisitor,
 List<AbstractBeanDefinitionBuilder> beanDefinitionBuilders)
                                        throws IOException

Throws:

IOException

isIntercepted

protected boolean isIntercepted()

Is the bean to be built intercepted?

Returns:

True if it is

inject

public BeanElementBuilder inject()

Description copied from interface: BeanElementBuilder

Dependency inject this bean.

Specified by:

inject in interface BeanElementBuilder

Returns:

this bean builder

getChildBeans

public List<AbstractBeanDefinitionBuilder> getChildBeans()

Any child bean definitions.

Returns:

The child beans

getOriginatingElement

@NonNull
public @NonNull Element getOriginatingElement()

Specified by:

getOriginatingElement in interface BeanElementBuilder

Returns:

The originating element

getBeanType

@NonNull
public @NonNull ClassElement getBeanType()

Specified by:

getBeanType in interface BeanElementBuilder

Returns:

The bean type

initBeanParameters

protected final BeanParameterElement[] initBeanParameters(@NonNull
 @NonNull ParameterElement[] constructorParameters)

Initialize the bean parameters.

Parameters:

constructorParameters - The parameters to use.

Returns:

The initialized parameters

getAnnotationMetadata

@NonNull
public @NonNull AnnotationMetadata getAnnotationMetadata()

Description copied from interface: AnnotationMetadataProvider

Supplies the metadata. Defaults to AnnotationMetadata.EMPTY_METADATA.

Specified by:

getAnnotationMetadata in interface AnnotationMetadataProvider

Returns:

The AnnotationMetadata

createWith

@NonNull
public @NonNull BeanElementBuilder createWith(@NonNull
 @NonNull MethodElement element)

Description copied from interface: BeanElementBuilder

Specifies the bean will be created with the given method element. If not specified the bean will be created with ClassElement.getPrimaryConstructor().

Note that the method can be a one of the following:

• An accessible constructor on the bean type being generated
• An accessible static method on the bean type being generated

Specified by:

createWith in interface BeanElementBuilder

Parameters:

element - The element

Returns:

This bean builder

typed

@NonNull
public @NonNull BeanElementBuilder typed(ClassElement... types)

Description copied from interface: BeanElementBuilder

Alters the exposed types for the bean limiting the exposed type to the given types.

Specified by:

typed in interface BeanElementBuilder

Parameters:

types - 1 or more types to expose

Returns:

This builder

typeArguments

@NonNull
public @NonNull BeanElementBuilder typeArguments(@NonNull
 @NonNull ClassElement... types)

Description copied from interface: BeanElementBuilder

Fills the type arguments for the bean with the given types.

Specified by:

typeArguments in interface BeanElementBuilder

Specified by:

typeArguments in interface ConfigurableElement

Parameters:

types - The types

Returns:

This bean builder

typeArgumentsForType

@NonNull
public @NonNull BeanElementBuilder typeArgumentsForType(ClassElement type,
 @NonNull
 @NonNull ClassElement... types)

Description copied from interface: BeanElementBuilder

Fills the type arguments for the given interface or super class with the given types.

Specified by:

typeArgumentsForType in interface BeanElementBuilder

Parameters:

type - The type or interface. If null, results in a no-op

types - The types

Returns:

This bean builder

withConstructor

public BeanElementBuilder withConstructor(Consumer<BeanConstructorElement> constructorElement)

Description copied from interface: BeanElementBuilder

Allows configuring the bean constructor.

Specified by:

withConstructor in interface BeanElementBuilder

Parameters:

constructorElement - The constructor element

Returns:

This bean builder

withMethods

@NonNull
public @NonNull BeanElementBuilder withMethods(@NonNull
 @NonNull ElementQuery<MethodElement> methods,
 @NonNull
 @NonNull Consumer<BeanMethodElement> beanMethods)

Description copied from interface: BeanElementBuilder

Allows configuring methods of the bean.

Specified by:

withMethods in interface BeanElementBuilder

Parameters:

methods - The ElementQuery to locate selected methods.

beanMethods - A consumer that receives each BeanMethodElement

Returns:

This builder

withFields

@NonNull
public @NonNull BeanElementBuilder withFields(@NonNull
 @NonNull ElementQuery<FieldElement> fields,
 @NonNull
 @NonNull Consumer<BeanFieldElement> beanFields)

Description copied from interface: BeanElementBuilder

Allows configuring fields of the bean.

Specified by:

withFields in interface BeanElementBuilder

Parameters:

fields - The ElementQuery to locate fields.

beanFields - The bean fields

Returns:

This builder

withParameters

@NonNull
public @NonNull BeanElementBuilder withParameters(Consumer<BeanParameterElement[]> parameters)

Description copied from interface: BeanElementBuilder

Allows configuring the parameters for the current constructor.

Specified by:

withParameters in interface BeanElementBuilder

Parameters:

parameters - The parameters

Returns:

This builder

getParameters

@NonNull
protected @NonNull BeanParameterElement[] getParameters()

Returns:

The bean creation parameters.

getName

@NonNull
public @NonNull 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

@NonNull
public @NonNull 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

annotate

@NonNull
public <T extends Annotation>
@NonNull BeanElementBuilder annotate(@NonNull
 @NonNull String annotationType,
 @NonNull
 @NonNull 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 BeanElementBuilder

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

annotate

public <T extends Annotation> Element annotate(AnnotationValue<T> annotationValue)

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:

annotationValue - The annotation type

Returns:

This element

removeAnnotation

public BeanElementBuilder removeAnnotation(@NonNull
 @NonNull 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 BeanElementBuilder

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> BeanElementBuilder removeAnnotationIf(@NonNull
 @NonNull Predicate<AnnotationValue<T>> predicate)

Description copied from interface: MutableAnnotationMetadataDelegate

Removes all annotations that pass the given predicate.

Specified by:

removeAnnotationIf in interface BeanElementBuilder

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 BeanElementBuilder removeStereotype(@NonNull
 @NonNull String annotationType)

Description copied from interface: MutableAnnotationMetadataDelegate

Removes a stereotype of the given name from the element.

Specified by:

removeStereotype in interface BeanElementBuilder

Specified by:

removeStereotype in interface Element

Specified by:

removeStereotype in interface MutableAnnotationMetadataDelegate<Element>

Parameters:

annotationType - The annotation type

Returns:

This element

produceBeans

public <E extends MemberElement> BeanElementBuilder produceBeans(ElementQuery<E> methodsOrFields,
 Consumer<BeanElementBuilder> childBeanBuilder)

Description copied from interface: BeanElementBuilder

Produce additional beans from the given methods.

Specified by:

produceBeans in interface BeanElementBuilder

Type Parameters:

E - A type variable to

Parameters:

methodsOrFields - The ElementQuery representing the methods or fields

childBeanBuilder - Configure the child bean builder

Returns:

This bean builder

createChildBean

@NonNull
protected abstract @NonNull AbstractBeanDefinitionBuilder createChildBean(FieldElement producerField)

Creates a child bean for the given producer field.

Parameters:

producerField - The producer field

Returns:

The child bean builder

visitInterceptedMethods

protected void visitInterceptedMethods(BiConsumer<TypedElement,MethodElement> consumer)

Visit the intercepted methods of this type.

Parameters:

consumer - A consumer to handle the method

createChildBean

@NonNull
protected abstract @NonNull AbstractBeanDefinitionBuilder createChildBean(MethodElement producerMethod)

Creates a child bean for the given producer method.

Parameters:

producerMethod - The producer method

Returns:

The child bean builder

build

@Nullable
public @Nullable BeanClassWriter build()

Build the bean definition writer.

Returns:

The writer, possibly null if it wasn't possible to build it

createAroundMethodVisitor

@NonNull
protected abstract @NonNull BiConsumer<TypedElement,MethodElement> createAroundMethodVisitor(BeanDefinitionVisitor aopProxyWriter)

Creates the around method visitor.

Parameters:

aopProxyWriter - The AOP writer

Returns:

The visitor

createAopWriter

@NonNull
protected abstract @NonNull BeanDefinitionVisitor createAopWriter(BeanDefinitionWriter beanDefinitionWriter,
 AnnotationMetadata annotationMetadata)

Creates the AOP writer.

Parameters:

beanDefinitionWriter - The bean definition writer

annotationMetadata - The annotation metadata

Returns:

The AOP writer

finalizeAndWriteBean

protected void finalizeAndWriteBean(ClassWriterOutputVisitor classWriterOutputVisitor,
 BeanDefinitionVisitor beanDefinitionWriter)
                             throws IOException

Finish the given bean and write it to the output.

Parameters:

classWriterOutputVisitor - The output

beanDefinitionWriter - The writer

Throws:

IOException - If an error occurred

configureBeanVisitor

protected boolean configureBeanVisitor(BeanDefinitionVisitor beanDefinitionWriter)

Configure the bean visitor for this builder.

Parameters:

beanDefinitionWriter - The bean visitor

Returns:

True if an error occurred

createBeanDefinitionWriter

protected BeanDefinitionVisitor createBeanDefinitionWriter()

Returns:

Creates the bean definition writer.

annotate

protected abstract <T extends Annotation> void annotate(AnnotationMetadata annotationMetadata,
 String annotationType,
 Consumer<AnnotationValueBuilder<T>> consumer)

Add an annotation to the given metadata.

Type Parameters:

T - The annotation generic type

Parameters:

annotationMetadata - The annotation metadata

annotationType - the annotation type

consumer - The builder

annotate

protected abstract <T extends Annotation> void annotate(@NonNull
 @NonNull AnnotationMetadata annotationMetadata,
 @NonNull
 @NonNull AnnotationValue<T> annotationValue)

Add an annotation to the given metadata.

Type Parameters:

T - The annotation generic type

Parameters:

annotationMetadata - The annotation metadata

annotationValue - The value

Since:

3.3.0

removeStereotype

protected abstract void removeStereotype(AnnotationMetadata annotationMetadata,
 String annotationType)

Remove a stereotype from the given metadata.

Parameters:

annotationMetadata - The metadata

annotationType - The stereotype

removeAnnotationIf

protected abstract <T extends Annotation> void removeAnnotationIf(AnnotationMetadata annotationMetadata,
 Predicate<AnnotationValue<T>> predicate)

Remove an annotation if it matches the given condition.

Type Parameters:

T - The annotation type

Parameters:

annotationMetadata - The metadata

predicate - The predicate

removeAnnotation

protected abstract void removeAnnotation(AnnotationMetadata annotationMetadata,
 String annotationType)

Remove an annotation for the given name.

Parameters:

annotationMetadata - The metadata

annotationType - The type