io.micronaut.inject.provider

Class AbstractProviderDefinition<T>

java.lang.Object

io.micronaut.inject.provider.AbstractProviderDefinition<T>

Type Parameters:

T - The generic type

All Implemented Interfaces:

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

Direct Known Subclasses:

BeanProviderDefinition, JakartaProviderBeanDefinition, JavaxProviderBeanDefinition

public abstract class AbstractProviderDefinition<T>
extends Object
implements BeanDefinition<T>, BeanFactory<T>, BeanDefinitionReference<T>

Abstract bean definition for other providers to extend from.

Since:

3.0.0

Author:

graemerocher

Field Summary

Fields inherited from interface io.micronaut.inject.BeanDefinition

NAMED_ATTRIBUTE

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

Constructor and Description
AbstractProviderDefinition()

Method Summary

Modifier and Type	Method and Description
T	build(BeanResolutionContext resolutionContext, BeanContext context, BeanDefinition<T> definition) Builds a bean instance.
protected abstract T	buildProvider(BeanResolutionContext resolutionContext, BeanContext context, Argument<Object> argument, Qualifier<Object> qualifier, boolean singleton) Builds a provider implementation.
boolean	equals(Object o)
AnnotationMetadata	getAnnotationMetadata() Supplies the metadata.
String	getBeanDefinitionName()
Qualifier<T>	getDeclaredQualifier() Resolve the declared qualifier for this bean.
List<Argument<?>>	getTypeArguments() If the bean itself declares any type arguments this method will return the classes that represent those types.
List<Argument<?>>	getTypeArguments(Class<?> type) Return the type arguments for the given interface or super type for this bean.
int	hashCode()
boolean	isAbstract()
protected boolean	isAllowEmptyProviders(BeanContext context) Return whether missing providers are allowed for this implementation.
boolean	isContainerType() Checks whether the bean type is a container type.
boolean	isEnabled(BeanContext context, BeanResolutionContext resolutionContext) Return whether this component is enabled for the given context.
boolean	isPresent()
boolean	isSingleton()
BeanDefinition<T>	load() Loads the bean definition.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.inject.BeanDefinition

asArgument, findMethod, findPossibleMethods, getBeanType, getConstructor, getContainerElement, getDeclaringType, getExecutableMethods, getInjectedFields, getInjectedMethods, getName, getPostConstructMethods, getPreDestroyMethods, getRequiredComponents, getRequiredMethod, getScope, getScopeName, getTypeArguments, getTypeParameters, getTypeParameters, inject, inject, isCandidateBean, isIterable, isProvided, isProxy, 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, getDeclaredStereotypeAnnotationNames, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getStereotypeAnnotationNames, 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, getAnnotationValuesByStereotype, getDeclaredAnnotationValuesByName, getValues, hasDeclaredStereotype, isAnnotationPresent, isDeclaredAnnotationPresent

Methods inherited from interface io.micronaut.inject.BeanFactory

build

Methods inherited from interface io.micronaut.inject.BeanDefinitionReference

isConfigurationProperties, isContextScope, load

Methods inherited from interface io.micronaut.inject.BeanType

getExposedTypes, isPrimary, requiresMethodProcessing

Methods inherited from interface io.micronaut.inject.BeanContextConditional

isEnabled

Constructor Detail

AbstractProviderDefinition

public AbstractProviderDefinition()

Method Detail

isContainerType

public boolean isContainerType()

Description copied from interface: BeanType

Checks whether the bean type is a container type.

Specified by:

isContainerType in interface BeanType<T>

Returns:

Whether the type is a container type like Iterable.

isEnabled

public boolean isEnabled(@NonNull
                         BeanContext context,
                         @Nullable
                         BeanResolutionContext resolutionContext)

Description copied from interface: BeanContextConditional

Return whether this component is enabled for the given context.

Specified by:

isEnabled in interface BeanContextConditional

Parameters:

context - The context

resolutionContext - The bean resolution context

Returns:

True if it is

getBeanDefinitionName

public String getBeanDefinitionName()

Specified by:

getBeanDefinitionName in interface BeanDefinitionReference<T>

Returns:

The class name of the backing BeanDefinition

load

public BeanDefinition<T> load()

Description copied from interface: BeanDefinitionReference

Loads the bean definition.

Specified by:

load in interface BeanDefinitionReference<T>

Returns:

The loaded component definition or null if it shouldn't be loaded

isPresent

public boolean isPresent()

Specified by:

isPresent in interface BeanDefinitionReference<T>

Returns:

Is the underlying bean type present on the classpath

buildProvider

@NonNull
protected abstract T buildProvider(@NonNull
                                            BeanResolutionContext resolutionContext,
                                            @NonNull
                                            BeanContext context,
                                            @NonNull
                                            Argument<Object> argument,
                                            @Nullable
                                            Qualifier<Object> qualifier,
                                            boolean singleton)

Builds a provider implementation.

Parameters:

resolutionContext - The resolution context

context - The context

argument - The argument

qualifier - The qualifier

singleton - Whether the bean is a singleton

Returns:

The provider

build

public T build(BeanResolutionContext resolutionContext,
               BeanContext context,
               BeanDefinition<T> definition)
        throws BeanInstantiationException

Description copied from interface: BeanFactory

Builds a bean instance.

Specified by:

build in interface BeanFactory<T>

Parameters:

resolutionContext - The bean resolution context

context - The context

definition - The definition

Returns:

The instance

Throws:

BeanInstantiationException - if the instance could not be instantiated

isAllowEmptyProviders

protected boolean isAllowEmptyProviders(BeanContext context)

Return whether missing providers are allowed for this implementation. If false a NoSuchBeanException is thrown.

Parameters:

context - The context

Returns:

Returns true if missing providers are allowed

isAbstract

public final boolean isAbstract()

Specified by:

isAbstract in interface BeanDefinition<T>

Returns:

Whether the bean definition is abstract

isSingleton

public final boolean isSingleton()

Specified by:

isSingleton in interface BeanDefinition<T>

Specified by:

isSingleton in interface BeanDefinitionReference<T>

Returns:

Whether the scope is singleton

getTypeArguments

@NonNull
public final List<Argument<?>> getTypeArguments(Class<?> type)

Description copied from interface: BeanDefinition

Return the type arguments for the given interface or super type for this bean.

Specified by:

getTypeArguments in interface BeanDefinition<T>

Parameters:

type - The super class or interface type

Returns:

The type arguments

getTypeArguments

@NonNull
public final List<Argument<?>> getTypeArguments()

Description copied from interface: BeanDefinition

If the bean itself declares any type arguments this method will return the classes that represent those types.

Specified by:

getTypeArguments in interface BeanDefinition<T>

Returns:

The type arguments

getAnnotationMetadata

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

getDeclaredQualifier

public Qualifier<T> getDeclaredQualifier()

Description copied from interface: BeanDefinition

Resolve the declared qualifier for this bean.

Specified by:

getDeclaredQualifier in interface BeanDefinition<T>

Returns:

The qualifier or null if this isn't one

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object