BeanDefinition (micronaut 3.4.0 API)

Type Parameters:

T - The bean type

All Superinterfaces:

AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, ArgumentCoercible<T>, BeanContextConditional, BeanType<T>, Named

All Known Subinterfaces:

DelegatingBeanDefinition<T>, DisposableBeanDefinition<T>, InitializingBeanDefinition<T>, ProxyBeanDefinition<T>, ValidatedBeanDefinition<T>

All Known Implementing Classes:

AbstractBeanDefinition, AbstractInitializableBeanDefinition, AbstractParametrizedBeanDefinition, AbstractProviderDefinition, ApplicationEventPublisherFactory, BeanProviderDefinition, InterceptorRegistryBean, JakartaProviderBeanDefinition, JavaxProviderBeanDefinition
```
public interface BeanDefinition<T>
extends AnnotationMetadataDelegate, Named, BeanType<T>, ArgumentCoercible<T>
```
Defines a bean definition and its requirements. A bean definition must have a singled injectable constructor or a no-args constructor.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields
Modifier and Type Field and Description

static String NAMED_ATTRIBUTE
Attribute used to store a dynamic bean name.
- 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
Modifier and Type	Field and Description
`static String`	`NAMED_ATTRIBUTE` Attribute used to store a dynamic bean name.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default Argument<T>`	`asArgument()`
`default <R> Optional<ExecutableMethod<T,R>>`	`findMethod(String name, Class<?>... argumentTypes)` Finds a single `ExecutableMethod` for the given name and argument types.
`default <R> Stream<ExecutableMethod<T,R>>`	`findPossibleMethods(String name)` Finds possible methods for the given method name.
`Class<T>`	`getBeanType()` Returns the bean type.
`default ConstructorInjectionPoint<T>`	`getConstructor()` The single concrete constructor that is an injection point for creating the bean.
`default Optional<Argument<?>>`	`getContainerElement()` If `BeanType.isContainerType()` returns true this will return the container element.
`default Qualifier<T>`	`getDeclaredQualifier()` Resolve the declared qualifier for this bean.
`default Optional<Class<?>>`	`getDeclaringType()`
`default Collection<ExecutableMethod<T,?>>`	`getExecutableMethods()`
`default Collection<FieldInjectionPoint<T,?>>`	`getInjectedFields()` All the fields that require injection.
`default Collection<MethodInjectionPoint<T,?>>`	`getInjectedMethods()` All methods that require injection.
`default String`	`getName()`
`default Collection<MethodInjectionPoint<T,?>>`	`getPostConstructMethods()` All the methods that should be called once the bean has been fully initialized and constructed.
`default Collection<MethodInjectionPoint<T,?>>`	`getPreDestroyMethods()` All the methods that should be called when the object is to be destroyed.
`default Collection<Class<?>>`	`getRequiredComponents()`
`default <R> ExecutableMethod<T,R>`	`getRequiredMethod(String name, Class<?>... argumentTypes)` Finds a single `ExecutableMethod` for the given name and argument types.
`default Optional<Class<? extends Annotation>>`	`getScope()`
`default Optional<String>`	`getScopeName()`
`default List<Argument<?>>`	`getTypeArguments()` If the bean itself declares any type arguments this method will return the classes that represent those types.
`default List<Argument<?>>`	`getTypeArguments(Class<?> type)` Return the type arguments for the given interface or super type for this bean.
`default List<Argument<?>>`	`getTypeArguments(String type)` Return the type arguments for the given interface or super type for this bean.
`default Class<?>[]`	`getTypeParameters()` Returns the type parameters as a class array for the bean type.
`default Class<?>[]`	`getTypeParameters(Class<?> type)` Returns the type parameters as a class array for the given type.
`default T`	`inject(BeanContext context, T bean)` Inject the given bean with the context.
`default T`	`inject(BeanResolutionContext resolutionContext, BeanContext context, T bean)` Inject the given bean with the context.
`default boolean`	`isAbstract()`
`default boolean`	`isCandidateBean(Argument<?> beanType)` Return whether this bean type is a candidate for dependency injection for the passed type.
`default boolean`	`isIterable()`
`default boolean`	`isProvided()` Deprecated. Provided beans are deprecated
`default boolean`	`isProxy()` Whether this bean definition represents a proxy.
`default boolean`	`isSingleton()`
`default Qualifier<T>`	`resolveDynamicQualifier()`

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
getAnnotationValuesByName, getDeclaredAnnotationValuesByName, getValues, hasDeclaredStereotype, isAnnotationPresent, isDeclaredAnnotationPresent

Methods inherited from interface io.micronaut.inject.BeanType
getExposedTypes, isContainerType, isPrimary, requiresMethodProcessing

Methods inherited from interface io.micronaut.core.annotation.AnnotationMetadataProvider
getAnnotationMetadata

Methods inherited from interface io.micronaut.inject.BeanContextConditional
isEnabled, isEnabled

- Field Detail
  - NAMED_ATTRIBUTE
```
static final String NAMED_ATTRIBUTE
```
    Attribute used to store a dynamic bean name.
- Method Detail
  - getScope
```
default Optional<Class<? extends Annotation>> getScope()
```
    Returns:
    
    The scope of the bean
  - getScopeName
```
default Optional<String> getScopeName()
```
    Returns:
    
    The name of the scope
  - isSingleton
```
default boolean isSingleton()
```
    Returns:
    
    Whether the scope is singleton
  - getContainerElement
```
default Optional<Argument<?>> getContainerElement()
```
    If BeanType.isContainerType() returns true this will return the container element.
    
    Returns:
    
    The container element.
  - isCandidateBean
```
default boolean isCandidateBean(@Nullable
                                Argument<?> beanType)
```
    Description copied from interface: BeanType
    
    Return whether this bean type is a candidate for dependency injection for the passed type.
    
    Specified by:
    
    isCandidateBean in interface BeanType<T>
    
    Parameters:
    
    beanType - The bean type
    
    Returns:
    
    True if it is
  - isProvided
```
@Deprecated
default boolean isProvided()
```
    Deprecated. Provided beans are deprecated
    
    Returns:
    
    Is this definition provided by another bean
    
    See Also:
    
    Provided
  - isIterable
```
default boolean isIterable()
```
    Returns:
    
    Whether the bean declared with EachProperty or EachBean
  - getBeanType
```
Class<T> getBeanType()
```
    Description copied from interface: BeanType
    
    Returns the bean type.
    
    Specified by:
    
    getBeanType in interface BeanType<T>
    
    Returns:
    
    The produced bean type
  - getDeclaringType
```
default Optional<Class<?>> getDeclaringType()
```
    Returns:
    
    The type that declares this definition, null if not applicable.
  - getConstructor
```
default ConstructorInjectionPoint<T> getConstructor()
```
    The single concrete constructor that is an injection point for creating the bean.
    
    Returns:
    
    The constructor injection point
  - getRequiredComponents
```
default Collection<Class<?>> getRequiredComponents()
```
    Returns:
    
    All required components for this entity definition
  - getInjectedMethods
```
default Collection<MethodInjectionPoint<T,?>> getInjectedMethods()
```
    All methods that require injection. This is a subset of all the methods in the class.
    
    Returns:
    
    The required properties
  - getInjectedFields
```
default Collection<FieldInjectionPoint<T,?>> getInjectedFields()
```
    All the fields that require injection.
    
    Returns:
    
    The required fields
  - getPostConstructMethods
```
default Collection<MethodInjectionPoint<T,?>> getPostConstructMethods()
```
    All the methods that should be called once the bean has been fully initialized and constructed.
    
    Returns:
    
    Methods to call post construct
  - getPreDestroyMethods
```
default Collection<MethodInjectionPoint<T,?>> getPreDestroyMethods()
```
    All the methods that should be called when the object is to be destroyed.
    
    Returns:
    
    Methods to call pre-destroy
  - getName
```
@NonNull
default String getName()
```
    Specified by:
    
    getName in interface BeanType<T>
    
    Specified by:
    
    getName in interface Named
    
    Returns:
    
    The class name
  - findMethod
```
default <R> Optional<ExecutableMethod<T,R>> findMethod(String name,
                                                       Class<?>... argumentTypes)
```
    Finds a single ExecutableMethod for the given name and argument types.
    
    Type Parameters:
    
    R - The return type
    
    Parameters:
    
    name - The method name
    
    argumentTypes - The argument types
    
    Returns:
    
    An optional ExecutableMethod
  - findPossibleMethods
```
default <R> Stream<ExecutableMethod<T,R>> findPossibleMethods(String name)
```
    Finds possible methods for the given method name.
    
    Type Parameters:
    
    R - The return type
    
    Parameters:
    
    name - The method name
    
    Returns:
    
    The possible methods
  - inject
```
default T inject(BeanContext context,
                 T bean)
```
    Inject the given bean with the context.
    
    Parameters:
    
    context - The context
    
    bean - The bean
    
    Returns:
    
    The injected bean
  - inject
```
default T inject(BeanResolutionContext resolutionContext,
                 BeanContext context,
                 T bean)
```
    Inject the given bean with the context.
    
    Parameters:
    
    resolutionContext - the resolution context
    
    context - The context
    
    bean - The bean
    
    Returns:
    
    The injected bean
  - getExecutableMethods
```
default Collection<ExecutableMethod<T,?>> getExecutableMethods()
```
    Returns:
    
    The ExecutableMethod instances for this definition
  - asArgument
```
@NonNull
default Argument<T> asArgument()
```
    Specified by:
    
    asArgument in interface ArgumentCoercible<T>
    
    Returns:
    
    The argument
  - isProxy
```
default boolean isProxy()
```
    Whether this bean definition represents a proxy.
    
    Returns:
    
    True if it represents a proxy
  - getTypeArguments
```
@NonNull
default List<Argument<?>> getTypeArguments()
```
    If the bean itself declares any type arguments this method will return the classes that represent those types.
    
    Returns:
    
    The type arguments
  - getTypeArguments
```
@NonNull
default List<Argument<?>> getTypeArguments(Class<?> type)
```
    Return the type arguments for the given interface or super type for this bean.
    
    Parameters:
    
    type - The super class or interface type
    
    Returns:
    
    The type arguments
  - getTypeParameters
```
@NonNull
default Class<?>[] getTypeParameters(@Nullable
                                              Class<?> type)
```
    Returns the type parameters as a class array for the given type.
    
    Parameters:
    
    type - The type
    
    Returns:
    
    The type parameters
  - getTypeParameters
```
@NonNull
default Class<?>[] getTypeParameters()
```
    Returns the type parameters as a class array for the bean type.
    
    Returns:
    
    The type parameters for the bean type as a class array.
  - getTypeArguments
```
@NonNull
default List<Argument<?>> getTypeArguments(String type)
```
    Return the type arguments for the given interface or super type for this bean.
    
    Parameters:
    
    type - The super class or interface type
    
    Returns:
    
    The type arguments
  - getRequiredMethod
```
default <R> ExecutableMethod<T,R> getRequiredMethod(String name,
                                                    Class<?>... argumentTypes)
```
    Finds a single ExecutableMethod for the given name and argument types.
    
    Type Parameters:
    
    R - The return type
    
    Parameters:
    
    name - The method name
    
    argumentTypes - The argument types
    
    Returns:
    
    An optional ExecutableMethod
    
    Throws:
    
    IllegalStateException - If the method cannot be found
  - isAbstract
```
default boolean isAbstract()
```
    Returns:
    
    Whether the bean definition is abstract
  - getDeclaredQualifier
```
@Nullable
default Qualifier<T> getDeclaredQualifier()
```
    Resolve the declared qualifier for this bean.
    
    Returns:
    
    The qualifier or null if this isn't one
  - resolveDynamicQualifier
```
@Nullable
default Qualifier<T> resolveDynamicQualifier()
```
    Returns:
    
    Method that can be overridden to resolve a dynamic qualifier

Interface BeanDefinition<T>

Field Summary

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

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

Method Summary

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

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

Methods inherited from interface io.micronaut.inject.BeanType

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

Methods inherited from interface io.micronaut.inject.BeanContextConditional

Field Detail

NAMED_ATTRIBUTE

Method Detail

getScope

getScopeName

isSingleton

getContainerElement

isCandidateBean

isProvided

isIterable

getBeanType

getDeclaringType

getConstructor

getRequiredComponents

getInjectedMethods

getInjectedFields

getPostConstructMethods

getPreDestroyMethods

getName

findMethod

findPossibleMethods

inject

inject

getExecutableMethods

asArgument

isProxy

getTypeArguments

getTypeArguments

getTypeParameters

getTypeParameters

getTypeArguments

getRequiredMethod

isAbstract

getDeclaredQualifier

resolveDynamicQualifier