io.micronaut.inject

Interface DelegatingBeanDefinition<T>

Type Parameters:

T - The bean definition type

All Superinterfaces:

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

public interface DelegatingBeanDefinition<T>
extends BeanDefinition<T>

An interface for wrapping a BeanDefinition with another that delegates and potentially decorates the BeanDefinition instance.

Since:

1.0

Author:

Graeme Rocher

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

Method Summary

Modifier and Type	Method and Description
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.
default AnnotationMetadata	getAnnotationMetadata() Supplies the metadata.
default 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<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()
BeanDefinition<T>	getTarget()
default List<Argument<?>>	getTypeArguments(String type) Return the type arguments for the given interface or super type for this bean.
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	isEnabled(BeanContext context) Return whether this component is enabled for the given context.
default boolean	isEnabled(BeanContext context, BeanResolutionContext resolutionContext) Return whether this component is enabled for the given context.
default boolean	isIterable()
default boolean	isPrimary()
default boolean	isProvided()
default boolean	isSingleton()
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.inject.BeanDefinition

asArgument, getContainerElement, getDeclaredQualifier, getTypeArguments, getTypeArguments, getTypeParameters, getTypeParameters, isCandidateBean, 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.BeanType

getExposedTypes, isContainerType

Method Detail

getTarget

BeanDefinition<T> getTarget()

Returns:

The target definition

requiresMethodProcessing

default boolean requiresMethodProcessing()

Description copied from interface: BeanType

By default, when the BeanContext is started, the BeanDefinition.getExecutableMethods() are not processed by registered ExecutableMethodProcessor instances unless this method returns true.

Specified by:

requiresMethodProcessing in interface BeanType<T>

Returns:

Whether the bean definition requires method processing

See Also:

Executable.processOnStartup()

getScope

default Optional<Class<? extends Annotation>> getScope()

Specified by:

getScope in interface BeanDefinition<T>

Returns:

The scope of the bean

getScopeName

default Optional<String> getScopeName()

Specified by:

getScopeName in interface BeanDefinition<T>

Returns:

The name of the scope

getAnnotationMetadata

default AnnotationMetadata getAnnotationMetadata()

Description copied from interface: AnnotationMetadataProvider

Supplies the metadata. Defaults to AnnotationMetadata.EMPTY_METADATA.

Specified by:

getAnnotationMetadata in interface AnnotationMetadataProvider

Returns:

The AnnotationMetadata

getRequiredMethod

default <R> ExecutableMethod<T,R> getRequiredMethod(String name,
                                                    Class<?>... argumentTypes)

Description copied from interface: BeanDefinition

Finds a single ExecutableMethod for the given name and argument types.

Specified by:

getRequiredMethod in interface BeanDefinition<T>

Type Parameters:

R - The return type

Parameters:

name - The method name

argumentTypes - The argument types

Returns:

An optional ExecutableMethod

isAbstract

default boolean isAbstract()

Specified by:

isAbstract in interface BeanDefinition<T>

Returns:

Whether the bean definition is abstract

isSingleton

default boolean isSingleton()

Specified by:

isSingleton in interface BeanDefinition<T>

Returns:

Whether the scope is singleton

isProvided

default boolean isProvided()

Specified by:

isProvided in interface BeanDefinition<T>

Returns:

Is this definition provided by another bean

See Also:

Provided

isIterable

default boolean isIterable()

Specified by:

isIterable in interface BeanDefinition<T>

Returns:

Whether the bean declared with EachProperty or EachBean

getBeanType

default Class<T> getBeanType()

Description copied from interface: BeanType

Returns the bean type.

Specified by:

getBeanType in interface BeanDefinition<T>

Specified by:

getBeanType in interface BeanType<T>

Returns:

The produced bean type

getConstructor

default ConstructorInjectionPoint<T> getConstructor()

Description copied from interface: BeanDefinition

The single concrete constructor that is an injection point for creating the bean.

Specified by:

getConstructor in interface BeanDefinition<T>

Returns:

The constructor injection point

getRequiredComponents

default Collection<Class<?>> getRequiredComponents()

Specified by:

getRequiredComponents in interface BeanDefinition<T>

Returns:

All required components for this entity definition

getInjectedMethods

default Collection<MethodInjectionPoint<T,?>> getInjectedMethods()

Description copied from interface: BeanDefinition

All methods that require injection. This is a subset of all the methods in the class.

Specified by:

getInjectedMethods in interface BeanDefinition<T>

Returns:

The required properties

getInjectedFields

default Collection<FieldInjectionPoint<T,?>> getInjectedFields()

Description copied from interface: BeanDefinition

All the fields that require injection.

Specified by:

getInjectedFields in interface BeanDefinition<T>

Returns:

The required fields

getPostConstructMethods

default Collection<MethodInjectionPoint<T,?>> getPostConstructMethods()

Description copied from interface: BeanDefinition

All the methods that should be called once the bean has been fully initialized and constructed.

Specified by:

getPostConstructMethods in interface BeanDefinition<T>

Returns:

Methods to call post construct

getPreDestroyMethods

default Collection<MethodInjectionPoint<T,?>> getPreDestroyMethods()

Description copied from interface: BeanDefinition

All the methods that should be called when the object is to be destroyed.

Specified by:

getPreDestroyMethods in interface BeanDefinition<T>

Returns:

Methods to call pre-destroy

getName

@NonNull
default String getName()

Specified by:

getName in interface BeanDefinition<T>

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)

Description copied from interface: BeanDefinition

Finds a single ExecutableMethod for the given name and argument types.

Specified by:

findMethod in interface BeanDefinition<T>

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)

Description copied from interface: BeanDefinition

Finds possible methods for the given method name.

Specified by:

findPossibleMethods in interface BeanDefinition<T>

Type Parameters:

R - The return type

Parameters:

name - The method name

Returns:

The possible methods

inject

default T inject(BeanContext context,
                 T bean)

Description copied from interface: BeanDefinition

Inject the given bean with the context.

Specified by:

inject in interface BeanDefinition<T>

Parameters:

context - The context

bean - The bean

Returns:

The injected bean

inject

default T inject(BeanResolutionContext resolutionContext,
                 BeanContext context,
                 T bean)

Description copied from interface: BeanDefinition

Inject the given bean with the context.

Specified by:

inject in interface BeanDefinition<T>

Parameters:

resolutionContext - the resolution context

context - The context

bean - The bean

Returns:

The injected bean

getExecutableMethods

default Collection<ExecutableMethod<T,?>> getExecutableMethods()

Specified by:

getExecutableMethods in interface BeanDefinition<T>

Returns:

The ExecutableMethod instances for this definition

isPrimary

default boolean isPrimary()

Specified by:

isPrimary in interface BeanType<T>

Returns:

Whether the bean definition is the Primary

isEnabled

default boolean isEnabled(BeanContext context)

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

Returns:

True if it is

isEnabled

default 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

getDeclaringType

default Optional<Class<?>> getDeclaringType()

Specified by:

getDeclaringType in interface BeanDefinition<T>

Returns:

The type that declares this definition, null if not applicable.

getTypeArguments

@NonNull
default List<Argument<?>> getTypeArguments(String 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