io.micronaut.inject

Interface BeanDefinition<T>

Type Parameters:

T - The bean type

All Superinterfaces:

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

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractBeanDefinition, AbstractParametrizedBeanDefinition

public interface BeanDefinition<T>
extends AnnotationMetadataDelegate, Named, BeanType<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 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
<R> Optional<ExecutableMethod<T,R>>	findMethod(String name, Class... argumentTypes) Finds a single ExecutableMethod for the given name and argument types.
<R> Stream<ExecutableMethod<T,R>>	findPossibleMethods(String name) Finds possible methods for the given method name.
Class<T>	getBeanType() Returns the bean type.
ConstructorInjectionPoint<T>	getConstructor() The single concrete constructor that is an injection point for creating the bean.
Optional<Class<?>>	getDeclaringType()
Collection<ExecutableMethod<T,?>>	getExecutableMethods()
Collection<FieldInjectionPoint>	getInjectedFields() All the fields that require injection.
Collection<MethodInjectionPoint>	getInjectedMethods() All methods that require injection.
String	getName()
Collection<MethodInjectionPoint>	getPostConstructMethods() All the methods that should be called once the bean has been fully initialized and constructed.
Collection<MethodInjectionPoint>	getPreDestroyMethods() All the methods that should be called when the object is to be destroyed.
Collection<Class>	getRequiredComponents()
default <R> ExecutableMethod<T,R>	getRequiredMethod(String name, Class... argumentTypes) Finds a single ExecutableMethod for the given name and argument types.
Optional<Class<? extends Annotation>>	getScope()
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.
T	inject(BeanContext context, T bean) Inject the given bean with the context.
T	inject(BeanResolutionContext resolutionContext, BeanContext context, T bean) Inject the given bean with the context.
default boolean	isAbstract()
boolean	isIterable()
boolean	isProvided()
default boolean	isProxy() Whether this bean definition represents a proxy.
boolean	isSingleton()

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, findAnnotation, findAnnotation, findDeclaredAnnotation, findDeclaredAnnotation, getAnnotation, getAnnotation, getAnnotationNameByStereotype, getAnnotationNameByStereotype, getAnnotationNames, getAnnotationNamesByStereotype, getAnnotationNamesByStereotype, getAnnotationType, getAnnotationTypeByStereotype, getAnnotationTypeByStereotype, getAnnotationTypesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByType, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasStereotype, hasStereotype, hasStereotype, hasStereotype, intValue, intValue, intValue, isAnnotationPresent, isDeclaredAnnotationPresent, isEmpty, isFalse, isFalse, isPresent, isPresent, isTrue, isTrue, longValue, longValue, stringValue, stringValue, stringValue, stringValue, stringValues, stringValues, synthesize, synthesizeAll, synthesizeAnnotationsByType, synthesizeDeclared, synthesizeDeclared, synthesizeDeclaredAnnotationsByType

Methods inherited from interface io.micronaut.inject.BeanType

isPrimary, requiresMethodProcessing

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

getAnnotationMetadata

Methods inherited from interface io.micronaut.inject.BeanContextConditional

isEnabled

Method Detail

getScope

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

Returns:

The scope of the bean

isSingleton

boolean isSingleton()

Returns:

Whether the scope is singleton

isProvided

boolean isProvided()

Returns:

Is this definition provided by another bean

isIterable

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

Optional<Class<?>> getDeclaringType()

Returns:

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

getConstructor

ConstructorInjectionPoint<T> getConstructor()

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

Returns:

The constructor injection point

getRequiredComponents

Collection<Class> getRequiredComponents()

Returns:

All required components for this entity definition

getInjectedMethods

Collection<MethodInjectionPoint> getInjectedMethods()

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

Returns:

The required properties

getInjectedFields

Collection<FieldInjectionPoint> getInjectedFields()

All the fields that require injection.

Returns:

The required fields

getPostConstructMethods

Collection<MethodInjectionPoint> getPostConstructMethods()

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

Returns:

Methods to call post construct

getPreDestroyMethods

Collection<MethodInjectionPoint> getPreDestroyMethods()

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

Returns:

Methods to call pre-destroy

getName

String getName()

Specified by:

getName in interface BeanType<T>

Specified by:

getName in interface Named

Returns:

The class name

findMethod

<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

<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

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

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

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

Returns:

The ExecutableMethod instances for this definition

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