io.micronaut.inject.writer

Class AbstractBeanDefinitionBuilder

java.lang.Object

io.micronaut.inject.writer.AbstractBeanDefinitionBuilder

All Implemented Interfaces:

AnnotatedElement, AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, Described, Named, BeanElementBuilder, ConfigurableElement, Element

@Internal
public abstract class AbstractBeanDefinitionBuilder
extends java.lang.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 and Description
protected ConfigurationMetadataBuilder<?>	metadataBuilder
protected VisitorContext	visitorContext

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

EMPTY_ELEMENT_ARRAY

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBeanDefinitionBuilder(Element originatingElement, ClassElement beanType, ConfigurationMetadataBuilder<?> metadataBuilder, VisitorContext visitorContext) Default constructor.

Method Summary

Modifier and Type	Method and Description
protected abstract <T extends java.lang.annotation.Annotation> void	annotate(AnnotationMetadata annotationMetadata, java.lang.String annotationType, java.util.function.Consumer<AnnotationValueBuilder<T>> consumer) Add an annotation to the given metadata.
<T extends java.lang.annotation.Annotation> BeanElementBuilder	annotate(java.lang.String annotationType, java.util.function.Consumer<AnnotationValueBuilder<T>> consumer) Annotate this element with the given annotation type.
BeanDefinitionWriter	build() Build the bean definition writer.
protected BeanDefinitionWriter	createBeanDefinitionWriter()
protected abstract AbstractBeanDefinitionBuilder	createChildBean(FieldElement producerField) Creates a child bean for the given producer field.
protected abstract AbstractBeanDefinitionBuilder	createChildBean(MethodElement producerMethod) Creates a child bean for the given producer method.
BeanElementBuilder	createWith(MethodElement element) Specifies the bean will created with the given method element.
AnnotationMetadata	getAnnotationMetadata() Supplies the metadata.
ClassElement	getBeanType()
java.util.List<AbstractBeanDefinitionBuilder>	getChildBeans() Any child bean definitions.
java.lang.String	getName()
java.lang.Object	getNativeType() Returns the native underlying type.
Element	getOriginatingElement()
BeanElementBuilder	inject() Dependency inject this bean.
boolean	isProtected()
boolean	isPublic()
<E extends MemberElement> BeanElementBuilder	produceBeans(ElementQuery<E> methodsOrFields, java.util.function.Consumer<BeanElementBuilder> childBeanBuilder) Produce additional beans from the given methods.
protected abstract void	removeAnnotation(AnnotationMetadata annotationMetadata, java.lang.String annotationType) Remove an annotation for the given name.
BeanElementBuilder	removeAnnotation(java.lang.String annotationType) Removes an annotation of the given type from the element.
protected abstract <T extends java.lang.annotation.Annotation> void	removeAnnotationIf(AnnotationMetadata annotationMetadata, java.util.function.Predicate<AnnotationValue<T>> predicate) Remove an annotation if it matches the given condition.
<T extends java.lang.annotation.Annotation> BeanElementBuilder	removeAnnotationIf(java.util.function.Predicate<AnnotationValue<T>> predicate) Removes all annotations that pass the given predicate.
protected abstract void	removeStereotype(AnnotationMetadata annotationMetadata, java.lang.String annotationType) Remove a stereotype from the given metadata.
BeanElementBuilder	removeStereotype(java.lang.String annotationType) Removes a stereotype of the given name from the element.
BeanElementBuilder	typeArguments(ClassElement... types) Fills the type arguments for the bean with the given types.
BeanElementBuilder	typeArgumentsForType(ClassElement type, ClassElement... types) Fills the type arguments for the given interface or super class with the given types.
BeanElementBuilder	typed(ClassElement... types) Alters the exposed types for the bean limiting the exposed type to the given types.
BeanElementBuilder	withConstructor(java.util.function.Consumer<BeanConstructorElement> constructorElement) Allows configuring the bean constructor.
BeanElementBuilder	withFields(ElementQuery<FieldElement> fields, java.util.function.Consumer<BeanFieldElement> beanFields) Allows configuring fields of the bean.
BeanElementBuilder	withMethods(ElementQuery<MethodElement> methods, java.util.function.Consumer<BeanMethodElement> beanMethods) Allows configuring methods of the bean.
BeanElementBuilder	withParameters(java.util.function.Consumer<BeanParameterElement[]> parameters) Allows configuring the parameters for the current constructor.
static void	writeBeanDefinitionBuilders(ClassWriterOutputVisitor classWriterOutputVisitor, java.util.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.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

annotate, getDescription, getDescription, getDocumentation, getModifiers, getSimpleName, isAbstract, isFinal, isPackagePrivate, isPrivate, isStatic

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

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, 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, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, 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.core.annotation.AnnotationMetadata

getValues, hasDeclaredStereotype, isAnnotationPresent, isDeclaredAnnotationPresent

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

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

Field Detail

metadataBuilder

protected final ConfigurationMetadataBuilder<?> metadataBuilder

visitorContext

protected final VisitorContext visitorContext

Constructor Detail

AbstractBeanDefinitionBuilder

protected AbstractBeanDefinitionBuilder(Element originatingElement,
                                        ClassElement beanType,
                                        ConfigurationMetadataBuilder<?> metadataBuilder,
                                        VisitorContext visitorContext)

Default constructor.

Parameters:

originatingElement - The originating element

beanType - The bean type

metadataBuilder - the metadata builder

visitorContext - the visitor context

Method Detail

writeBeanDefinitionBuilders

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

Throws:

java.io.IOException

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 java.util.List<AbstractBeanDefinitionBuilder> getChildBeans()

Any child bean definitions.

Returns:

The child beans

getOriginatingElement

@NonNull
public Element getOriginatingElement()

Specified by:

getOriginatingElement in interface BeanElementBuilder

Returns:

The originating element

getBeanType

@NonNull
public ClassElement getBeanType()

Specified by:

getBeanType in interface BeanElementBuilder

Returns:

The bean type

getAnnotationMetadata

@NonNull
public 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 BeanElementBuilder createWith(@NonNull
                                              MethodElement element)

Description copied from interface: BeanElementBuilder

Specifies the bean will 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 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 BeanElementBuilder typeArguments(@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 BeanElementBuilder typeArgumentsForType(ClassElement type,
                                                        @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(java.util.function.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 BeanElementBuilder withMethods(@NonNull
                                               ElementQuery<MethodElement> methods,
                                               @NonNull
                                               java.util.function.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 BeanElementBuilder withFields(@NonNull
                                              ElementQuery<FieldElement> fields,
                                              @NonNull
                                              java.util.function.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 BeanElementBuilder withParameters(java.util.function.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

getName

@NonNull
public java.lang.String getName()

Specified by:

getName in interface Named

Specified by:

getName in interface Element

Returns:

The name of the element.

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 java.lang.Object getNativeType()

Description copied from interface: Element

Returns the native underlying type. This API is extended by all of the 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 java.lang.annotation.Annotation> BeanElementBuilder annotate(@NonNull
                                                                                        java.lang.String annotationType,
                                                                                        @NonNull
                                                                                        java.util.function.Consumer<AnnotationValueBuilder<T>> consumer)

Description copied from interface: Element

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

Type Parameters:

T - The annotation generic type

Parameters:

annotationType - The annotation type

consumer - A function that receives the AnnotationValueBuilder

Returns:

This element

removeAnnotation

public BeanElementBuilder removeAnnotation(@NonNull
                                           java.lang.String annotationType)

Description copied from interface: Element

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

Parameters:

annotationType - The annotation type

Returns:

This element

removeAnnotationIf

public <T extends java.lang.annotation.Annotation> BeanElementBuilder removeAnnotationIf(@NonNull
                                                                                         java.util.function.Predicate<AnnotationValue<T>> predicate)

Description copied from interface: Element

Removes all annotations that pass the given predicate.

Specified by:

removeAnnotationIf in interface BeanElementBuilder

Specified by:

removeAnnotationIf in interface Element

Type Parameters:

T - The annotation generic type

Parameters:

predicate - The predicate

Returns:

This element

removeStereotype

public BeanElementBuilder removeStereotype(@NonNull
                                           java.lang.String annotationType)

Description copied from interface: Element

Removes a stereotype of the given name from the element.

Specified by:

removeStereotype in interface BeanElementBuilder

Specified by:

removeStereotype in interface Element

Parameters:

annotationType - The annotation type

Returns:

This element

produceBeans

public <E extends MemberElement> BeanElementBuilder produceBeans(ElementQuery<E> methodsOrFields,
                                                                 java.util.function.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 AbstractBeanDefinitionBuilder createChildBean(FieldElement producerField)

Creates a child bean for the given producer field.

Parameters:

producerField - The producer field

Returns:

The child bean builder

createChildBean

@NonNull
protected abstract 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 BeanDefinitionWriter build()

Build the bean definition writer.

Returns:

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

createBeanDefinitionWriter

protected BeanDefinitionWriter createBeanDefinitionWriter()

Returns:

Creates the bean definition writer.

annotate

protected abstract <T extends java.lang.annotation.Annotation> void annotate(AnnotationMetadata annotationMetadata,
                                                                             java.lang.String annotationType,
                                                                             java.util.function.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

removeStereotype

protected abstract void removeStereotype(AnnotationMetadata annotationMetadata,
                                         java.lang.String annotationType)

Remove a stereotype from the given metadata.

Parameters:

annotationMetadata - The metadata

annotationType - The stereotype

removeAnnotationIf

protected abstract <T extends java.lang.annotation.Annotation> void removeAnnotationIf(AnnotationMetadata annotationMetadata,
                                                                                       java.util.function.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,
                                         java.lang.String annotationType)

Remove an annotation for the given name.

Parameters:

annotationMetadata - The metadata

annotationType - The type