Package io.micronaut.inject

Interface BeanType<T>

Type Parameters:
T - The bean type
All Superinterfaces:
io.micronaut.core.annotation.AnnotationMetadataProvider, io.micronaut.core.annotation.AnnotationSource, io.micronaut.core.type.ArgumentCoercible<T>, BeanContextConditional, io.micronaut.core.beans.BeanInfo<T>
All Known Subinterfaces:
AdvisedBeanType<T>, BeanDefinition<T>, BeanDefinitionReference<T>, DelegatingBeanDefinition<T>, DisposableBeanDefinition<T>, InitializingBeanDefinition<T>, InjectableBeanDefinition<T>, InstantiatableBeanDefinition<T>, ParametrizedInstantiatableBeanDefinition<T>, ProxyBeanDefinition<T>, QualifiedBeanType<T>, RuntimeBeanDefinition<T>, ValidatedBeanDefinition<T>
All Known Implementing Classes:
AbstractInitializableBeanDefinition, AbstractInitializableBeanDefinitionReference, AbstractProviderDefinition, ApplicationEventPublisherFactory, ArgumentBeanType, BeanProviderDefinition, BeanRegistration, DisabledBean, JakartaProviderBeanDefinition, JavaxProviderBeanDefinition
public interface BeanType<T> extends io.micronaut.core.annotation.AnnotationMetadataProvider, BeanContextConditional, io.micronaut.core.beans.BeanInfo<T>
A reference to a bean. Implemented by bother BeanDefinitionReference and BeanDefinition.
Since:
1.0

  • Field Summary

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

    EMPTY

  • Method Summary

    Modifier and Type
    Method
    Description
    default Optional<String>
    getBeanName()
    Returns the name of the bean usually resolved via the Named annotation.
    @NonNull Class<T>
    getBeanType()
    Returns the bean type.
    default @NonNull Set<Class<?>>
    getExposedTypes()
    Returns a potentially limited subset of bean types exposed by this bean.
    default String
    getName()
     
    default boolean
    isCandidateBean(@Nullable io.micronaut.core.type.Argument<?> beanType)
    Return whether this bean type is a candidate for dependency injection for the passed type.
    default boolean
    isContainerType()
    Checks whether the bean type is a container type.
    default boolean
    isPrimary()
     
    default boolean
    requiresMethodProcessing()
    By default, when the BeanContext is started, the BeanDefinition.getExecutableMethods() are not processed by registered ExecutableMethodProcessor instances unless this method returns true.

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

    findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotationMetadata, getTargetAnnotationMetadata, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

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

    getAnnotation, getAnnotation, getDeclaredAnnotation, getDeclaredAnnotation, isAnnotationPresent, isDeclaredAnnotationPresent, synthesize, synthesizeDeclared

    Methods inherited from interface io.micronaut.inject.BeanContextConditional

    isEnabled, isEnabled

    Methods inherited from interface io.micronaut.core.beans.BeanInfo

    asArgument, getGenericBeanType

  • Method Details

    • isPrimary

      default boolean isPrimary()
      Returns:
      Whether the bean definition is the Primary

    • getBeanType

      @NonNull @NonNull Class<T> getBeanType()
      Returns the bean type.
      Specified by:
      getBeanType in interface io.micronaut.core.beans.BeanInfo<T>
      Returns:
      The underlying bean type

    • getBeanName

      default Optional<String> getBeanName()
      Returns the name of the bean usually resolved via the Named annotation.
      Returns:
      The name of the bean if any
      Since:
      4.0.0

    • isContainerType

      default boolean isContainerType()
      Checks whether the bean type is a container type.
      Returns:
      Whether the type is a container type like Iterable.
      Since:
      3.0.0

    • getExposedTypes

      @NonNull default @NonNull Set<Class<?>> getExposedTypes()
      Returns a potentially limited subset of bean types exposed by this bean. The types to be exposed can be defined by the Type annotation.
      Returns:
      The exposed types
      Since:
      3.0.0

    • isCandidateBean

      default boolean isCandidateBean(@Nullable @Nullable io.micronaut.core.type.Argument<?> beanType)
      Return whether this bean type is a candidate for dependency injection for the passed type.
      Parameters:
      beanType - The bean type
      Returns:
      True if it is
      Since:
      3.0.0

    • getName

      default String getName()
      Returns:
      The class name

    • requiresMethodProcessing

      default boolean requiresMethodProcessing()
      By default, when the BeanContext is started, the BeanDefinition.getExecutableMethods() are not processed by registered ExecutableMethodProcessor instances unless this method returns true.
      Returns:
      Whether the bean definition requires method processing
      See Also: