Package io.micronaut.inject.ast.beans

Interface BeanElement

All Superinterfaces:

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

All Known Implementing Classes:

BeanDefinitionWriter

public interface BeanElement
extends Element

Models a bean that will be produced by Micronaut.

Since:

3.0.0

Author:

graemerocher

Field Summary

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

Method Summary

Modifier and Type	Method	Description
default @NonNull BeanElementBuilder	addAssociatedBean(@NonNull ClassElement type, @NonNull VisitorContext visitorContext)	This method adds an associated bean using this class element as the originating element.
@NonNull Set<ClassElement>	getBeanTypes()	The type names produced by the bean.
@NonNull ClassElement	getDeclaringClass()	Returns the declaring ClassElement which may differ from the getBeanTypes() in the case of factory beans.
@NonNull Collection<Element>	getInjectionPoints()	Returns all of the injection points for the bean.
@NonNull Element	getOriginatingElement()
@NonNull 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.
@NonNull Collection<String>	getQualifiers()
@NonNull Optional<String>	getScope()	The scope of the bean.

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.core.annotation.AnnotationMetadataProvider

getAnnotationMetadata

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

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

Method Details

getInjectionPoints

@NonNull
@NonNull Collection<Element> getInjectionPoints()

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

Returns:

The injection points for the bean.

getOriginatingElement

@NonNull
@NonNull Element getOriginatingElement()

Returns:

The originating element.

getDeclaringClass

@NonNull
@NonNull ClassElement getDeclaringClass()

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

Returns:

The declaring class of the bean.

getProducingElement

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

Returns:

The producing element

getBeanTypes

@NonNull
@NonNull Set<ClassElement> getBeanTypes()

The type names produced by the bean.

Returns:

A set of types

getScope

@NonNull
@NonNull Optional<String> getScope()

The scope of the bean.

Returns:

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

getQualifiers

@NonNull
@NonNull Collection<String> getQualifiers()

Returns:

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

addAssociatedBean

@NonNull
default @NonNull BeanElementBuilder addAssociatedBean(@NonNull
 @NonNull ClassElement type,
 @NonNull
 @NonNull VisitorContext visitorContext)

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.

Parameters:

type - The type of the bean

visitorContext - The visitor context

Returns:

A bean builder