Interface BeanElementBuilder

All Superinterfaces:

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

All Known Implementing Classes:

AbstractBeanDefinitionBuilder

public interface BeanElementBuilder
extends ConfigurableElement

Interface for defining beans at compilation time from an originating element.

Since:

3.0.0

Author:

graemerocher

Field Summary

Fields inherited from interface AnnotationMetadata

CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER

Fields inherited from interface AnnotationSource

EMPTY

Fields inherited from interface Element

EMPTY_ELEMENT_ARRAY

Fields inherited from interface MutableAnnotationMetadataDelegate

EMPTY

Method Summary

Modifier and Type	Method	Description
default <T extends Annotation> BeanElementBuilder	annotate(Class<T> annotationType)	Annotate this element with the given annotation type.
default <T extends Annotation> BeanElementBuilder	annotate(Class<T> annotationType, Consumer<AnnotationValueBuilder<T>> consumer)	Annotate this element with the given annotation type.
default BeanElementBuilder	annotate(String annotationType)	Annotate this element with the given annotation type.
default <T extends Annotation> BeanElementBuilder	annotate(String annotationType, Consumer<AnnotationValueBuilder<T>> consumer)	Annotate this element with the given annotation type.
BeanElementBuilder	createWith(MethodElement element)	Specifies the bean will be created with the given method element.
ClassElement	getBeanType()
default ClassElement	getDeclaringElement()	Returns the class that declares the bean.
Element	getOriginatingElement()
default Element	getProducingElement()
BeanElementBuilder	inject()	Dependency inject this bean.
default BeanElementBuilder	intercept(AnnotationValue<?>... annotationValue)	Intercept the bean.
default <E extends MemberElement> BeanElementBuilder	produceBeans(ElementQuery<E> methodsOrFields)	Produce additional beans from the given methods.
<E extends MemberElement> BeanElementBuilder	produceBeans(ElementQuery<E> methodsOrFields, @Nullable Consumer<BeanElementBuilder> childBeanBuilder)	Produce additional beans from the given methods.
default BeanElementBuilder	qualifier(AnnotationValue<?> qualifier)	Adds a qualifier for the given annotation value to the element.
default BeanElementBuilder	qualifier(@Nullable String qualifier)	Adds a Named qualifier to the element.
default <T extends Annotation> BeanElementBuilder	removeAnnotation(Class<T> annotationType)
default BeanElementBuilder	removeAnnotation(String annotationType)	Removes an annotation of the given type from the element.
default <T extends Annotation> BeanElementBuilder	removeAnnotationIf(Predicate<AnnotationValue<T>> predicate)	Removes all annotations that pass the given predicate.
default <T extends Annotation> BeanElementBuilder	removeStereotype(Class<T> annotationType)	Removes a stereotype annotation of the given type from the element.
default BeanElementBuilder	removeStereotype(String annotationType)	Removes a stereotype of the given name from the element.
default BeanElementBuilder	scope(AnnotationValue<?> scope)	Adds a scope for the given annotation value to the bean.
default BeanElementBuilder	scope(String scope)	Adds a scope for the given annotation value to the bean.
BeanElementBuilder	typeArguments(ClassElement... types)	Fills the type arguments for the bean with the given types.
BeanElementBuilder	typeArgumentsForType(@Nullable 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(Consumer<BeanConstructorElement> constructorElement)	Allows configuring the bean constructor.
BeanElementBuilder	withFields(ElementQuery<FieldElement> fields, Consumer<BeanFieldElement> beanFields)	Allows configuring fields of the bean.
BeanElementBuilder	withMethods(ElementQuery<MethodElement> methods, Consumer<BeanMethodElement> beanMethods)	Allows configuring methods of the bean.
BeanElementBuilder	withParameters(Consumer<BeanParameterElement[]> parameters)	Allows configuring the parameters for the current constructor.

Methods inherited from interface AnnotatedElement

isDeclaredNonNull, isDeclaredNullable, isNonNull, isNullable

Methods inherited from interface AnnotationMetadata

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

Methods inherited from interface 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 AnnotationMetadataProvider

getAnnotationMetadata

Methods inherited from interface Element

annotate, getDescription, getDescription, getDocumentation, getDocumentation, getModifiers, getName, getNativeType, getSimpleName, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isSynthetic, withAnnotationMetadata

Method Details

intercept

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

Intercept the bean.

Parameters:

annotationValue - The annotation to intercept

Returns:

This bean method

Since:

3.5.2

getOriginatingElement

Element getOriginatingElement()

Returns:

The originating element

getBeanType

ClassElement getBeanType()

Returns:

The bean type

getProducingElement

default Element getProducingElement()

Returns:

The element that produces the bean.

getDeclaringElement

default ClassElement getDeclaringElement()

Returns the class that declares the bean. In case of a bean defined by a class, that is the bean class directly. In case of a producer method or field, that is the class that declares the producer method or field.

Returns:

The element declares the bean.

createWith

BeanElementBuilder createWith(MethodElement element)

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

Parameters:

element - The element

Returns:

This bean builder

typed

BeanElementBuilder typed(ClassElement... types)

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

Parameters:

types - 1 or more types to expose

Returns:

This builder

typeArguments

BeanElementBuilder typeArguments(ClassElement... types)

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

Specified by:

typeArguments in interface ConfigurableElement

Parameters:

types - The types

Returns:

This bean builder

typeArgumentsForType

BeanElementBuilder typeArgumentsForType(@Nullable ClassElement type,
 ClassElement... types)

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

Parameters:

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

types - The types

Returns:

This bean builder

scope

default BeanElementBuilder scope(AnnotationValue<?> scope)

Adds a scope for the given annotation value to the bean.

Parameters:

scope - The scope

Returns:

This bean element builder

scope

default BeanElementBuilder scope(String scope)

Adds a scope for the given annotation value to the bean.

Parameters:

scope - The full qualified scope annotation name

Returns:

This bean element builder

withConstructor

BeanElementBuilder withConstructor(Consumer<BeanConstructorElement> constructorElement)

Allows configuring the bean constructor.

Parameters:

constructorElement - The constructor element

Returns:

This bean builder

withMethods

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

Allows configuring methods of the bean.

Parameters:

methods - The ElementQuery to locate selected methods.

beanMethods - A consumer that receives each BeanMethodElement

Returns:

This builder

withFields

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

Allows configuring fields of the bean.

Parameters:

fields - The ElementQuery to locate fields.

beanFields - The bean fields

Returns:

This builder

withParameters

BeanElementBuilder withParameters(Consumer<BeanParameterElement[]> parameters)

Allows configuring the parameters for the current constructor.

Parameters:

parameters - The parameters

Returns:

This builder

qualifier

default BeanElementBuilder qualifier(@Nullable String qualifier)

Description copied from interface: ConfigurableElement

Adds a Named qualifier to the element.

Specified by:

qualifier in interface ConfigurableElement

Parameters:

qualifier - The qualifier. If null a named annotation with no value is added assuming the default name.

Returns:

This element

qualifier

default BeanElementBuilder qualifier(AnnotationValue<?> qualifier)

Description copied from interface: ConfigurableElement

Adds a qualifier for the given annotation value to the element.

Specified by:

qualifier in interface ConfigurableElement

Parameters:

qualifier - The qualifier

Returns:

This element

annotate

default <T extends Annotation> BeanElementBuilder 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

default BeanElementBuilder 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

removeAnnotation

default <T extends Annotation> BeanElementBuilder removeAnnotation(Class<T> annotationType)

Specified by:

removeAnnotation in interface Element

Specified by:

removeAnnotation in interface MutableAnnotationMetadataDelegate<Element>

Type Parameters:

T - The annotation generic type

Parameters:

annotationType - The annotation type

Returns:

This element

See Also:

• MutableAnnotationMetadataDelegate.removeAnnotation(String)

removeAnnotationIf

default <T extends Annotation> BeanElementBuilder 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

default BeanElementBuilder 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

removeStereotype

default <T extends Annotation> BeanElementBuilder removeStereotype(Class<T> annotationType)

Description copied from interface: MutableAnnotationMetadataDelegate

Removes a stereotype annotation of the given type from the element.

Specified by:

removeStereotype in interface Element

Specified by:

removeStereotype in interface MutableAnnotationMetadataDelegate<Element>

Type Parameters:

T - The annotation generic type

Parameters:

annotationType - The annotation type

Returns:

This element

annotate

default BeanElementBuilder annotate(String annotationType)

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>

Parameters:

annotationType - The annotation type

Returns:

This element

annotate

default <T extends Annotation> BeanElementBuilder annotate(Class<T> 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

annotate

default <T extends Annotation> BeanElementBuilder annotate(Class<T> annotationType)

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

Returns:

This element

inject

BeanElementBuilder inject()

Dependency inject this bean.

Returns:

this bean builder

produceBeans

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

Produce additional beans from the given methods.

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

produceBeans

default <E extends MemberElement>
BeanElementBuilder produceBeans(ElementQuery<E> methodsOrFields)

Produce additional beans from the given methods.

Type Parameters:

E - A type variable to

Parameters:

methodsOrFields - The ElementQuery representing the methods or fields

Returns:

This bean builder