Interface RuntimeBeanDefinition<T>

Type Parameters:

T - The bean type

All Superinterfaces:

AnnotationMetadata, AnnotationMetadataDelegate, AnnotationMetadataProvider, AnnotationSource, ArgumentCoercible<T>, BeanContextConditional, BeanDefinition<T>, BeanDefinitionReference<T>, BeanInfo<T>, BeanType<T>, InstantiatableBeanDefinition<T>, Named, Ordered, QualifiedBeanType<T>

All Known Implementing Classes:

ReflectionBeanDefinition

public interface RuntimeBeanDefinition<T>
extends BeanDefinitionReference<T>, InstantiatableBeanDefinition<T>, BeanContextConditional

Allow the construction for bean definitions programmatically that can be registered via BeanDefinitionRegistry at runtime.

This differs from BeanDefinitionRegistry.registerSingleton(Object) in that beans registered this way can be created lazily or not at all and participate more completely in the life cycle of the BeanContext (for examples event listeners like BeanCreatedEventListener will be fired).

Note that it is generally not recommended to use this approach and build time bean computation is preferred. This type is designed to support a few limited use cases where runtime bean registration is required.

Since:

3.6.0

Author:

graemerocher

See Also:

• BeanDefinitionRegistry.registerBeanDefinition(RuntimeBeanDefinition)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RuntimeBeanDefinition.Builder<B>	A builder for constructing RuntimeBeanDefinition instances.
static interface	RuntimeBeanDefinition.CreationContext	The context of a single creation of a bean built at runtime, passed to the bean factory of a definition built with builder(Argument, Function).
static interface	RuntimeBeanDefinition.DisposalContext	The context of a single disposal of a bean built at runtime, passed to the disposer of a definition built with RuntimeBeanDefinition.Builder.injectedDisposer(BiConsumer).
static interface	RuntimeBeanDefinition.LookupContext	The lookups a runtime built bean can perform while it is being created or disposed of.

Field Summary

Fields inherited from interface AnnotationMetadata

CLASS_NAME_SUFFIX, EMPTY_METADATA, VALUE_MEMBER

Fields inherited from interface AnnotationSource

EMPTY

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method	Description
static <B> RuntimeBeanDefinition.Builder<B>	builder(B bean)	A new builder for constructing and configuring runtime created beans.
static <B> RuntimeBeanDefinition.Builder<B>	builder(Argument<B> beanType, Function<RuntimeBeanDefinition.CreationContext, B> beanFactory)	A new builder for constructing and configuring runtime created beans where the bean factory receives the RuntimeBeanDefinition.CreationContext of each creation.
static <B> RuntimeBeanDefinition.Builder<B>	builder(Argument<B> beanType, Supplier<B> beanSupplier)	A new builder for constructing and configuring runtime created beans.
static <B> RuntimeBeanDefinition.Builder<B>	builder(Class<B> beanType, Function<RuntimeBeanDefinition.CreationContext, B> beanFactory)	A new builder for constructing and configuring runtime created beans where the bean factory receives the RuntimeBeanDefinition.CreationContext of each creation.
static <B> RuntimeBeanDefinition.Builder<B>	builder(Class<B> beanType, Supplier<B> beanSupplier)	A new builder for constructing and configuring runtime created beans.
default AnnotationMetadata	getAnnotationMetadata()	Supplies the metadata.
default String	getBeanDefinitionName()
default Collection<String>	getTypeArgumentKeys()	The types this definition can answer BeanDefinition.getTypeArguments(String) for.
default List<Argument<?>>	getTypeArguments(@Nullable String type)	Return the type arguments for the given interface or super type for this bean.
default List<Argument<?>>	getTypeArguments(Class<?> type)	Return the type arguments for the given interface or super type for this bean.
default boolean	isConfigurationProperties()
default boolean	isContextScope()
default boolean	isEnabled(BeanContext context, @Nullable BeanResolutionContext resolutionContext)	Return whether this component is enabled for the given context.
default boolean	isPresent()
default boolean	isSingleton()
default BeanDefinition<T>	load()	Loads the bean definition.
default BeanDefinition<T>	load(BeanContext context)	Loads the bean definition for the current BeanContext.
static <B> RuntimeBeanDefinition<B>	of(B bean)	Creates a new effectively singleton bean definition that references the given bean.
static <B> RuntimeBeanDefinition<B>	of(Class<B> beanType, Supplier<B> beanSupplier)	Creates a new bean definition that will resolve the bean from the given supplier.

Methods inherited from interface AnnotationMetadata

enumValuesSet, enumValuesSet, getValues, hasDeclaredStereotype, hasStereotypeNonRepeating, isAnnotationPresent, isDeclaredAnnotationPresent

Methods inherited from interface AnnotationMetadataDelegate

booleanValue, booleanValue, booleanValue, booleanValue, classValue, classValue, classValue, classValue, classValues, classValues, classValues, classValues, copyAnnotationMetadata, 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, getAnnotationValuesByName, getAnnotationValuesByStereotype, getAnnotationValuesByType, getDeclaredAnnotation, getDeclaredAnnotation, getDeclaredAnnotationNameByStereotype, getDeclaredAnnotationNames, getDeclaredAnnotationNamesByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationTypeByStereotype, getDeclaredAnnotationValuesByName, getDeclaredAnnotationValuesByType, getDeclaredMetadata, getDeclaredStereotypeAnnotationNames, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValue, getDefaultValues, getStereotypeAnnotationNames, getTargetAnnotationMetadata, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValues, getValues, hasAnnotation, hasAnnotation, hasDeclaredAnnotation, hasDeclaredAnnotation, hasDeclaredStereotype, hasDeclaredStereotype, hasDeclaredStereotype, hasEvaluatedExpressions, 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 BeanContextConditional

isEnabled

Methods inherited from interface BeanDefinition

asArgument, findMethod, findPossibleMethods, getBeanDescription, getBeanDescription, getBeanType, getConstructor, getContainerElement, getDeclaringType, getDefaultImplementation, getExecutableMethods, getExecutableMethodsForProcessing, getGenericBeanType, getInjectedFields, getInjectedMethods, getName, getPostConstructMethods, getPreDestroyMethods, getReplacesDefinition, getRequiredComponents, getRequiredMethod, getScope, getScopeName, getTypeArguments, getTypeInformation, getTypeParameters, getTypeParameters, hasAnnotatedMethod, isAbstract, isCanBeReplaced, isCandidateBean, isIterable, isProxy

Methods inherited from interface BeanDefinitionReference

getIndexes, isParallel, isProxiedBean, isProxyTarget

Methods inherited from interface BeanInfo

getOrder

Methods inherited from interface BeanType

getBeanName, getExposedTypes, isContainerType, isPrimary, requiresMethodProcessing

Methods inherited from interface InstantiatableBeanDefinition

instantiate, instantiate

Methods inherited from interface QualifiedBeanType

getDeclaredQualifier, resolveDynamicQualifier

Method Details

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

isEnabled

default boolean isEnabled(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

getTypeArguments

default 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

default List<Argument<?>> getTypeArguments(@Nullable String type)

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

A runtime definition has no recorded arguments to look the name up in, so it resolves the name against the bean type's own hierarchy and then answers as getTypeArguments(Class) does, which keeps the two lookups in agreement. A name that is not a super type of the bean answers empty.

Specified by:

getTypeArguments in interface BeanDefinition<T>

Parameters:

type - The super class or interface type

Returns:

The type arguments

getTypeArgumentKeys

default Collection<String> getTypeArgumentKeys()

The types this definition can answer BeanDefinition.getTypeArguments(String) for.

A definition computed at build time records the type arguments the compiler resolved for the bean type and for every super class and interface above it, keyed by type. This returns those keys, so a consumer that needs every super type the bean supplies arguments to can read what was recorded instead of rediscovering the hierarchy reflectively.

A key is a class name in the form Class.getName() returns, which is what the definition stores; nothing here loads it. A caller that only needs the arguments passes the key straight back to BeanDefinition.getTypeArguments(String), and one that needs a Class loads the name itself. Every key answers that lookup, though the answer may be an empty list: a super type that carries no arguments of its own is still part of what was recorded.

The iteration order is unspecified and is not the order of the hierarchy. A definition that records nothing answers empty - including for its own BeanDefinition.getBeanType(), which BeanDefinition.getTypeArguments() then answers empty for as well.

A ProxyBeanDefinition answers for the hierarchy of the type it proxies rather than for the generated proxy class, so its keys name ProxyBeanDefinition.getTargetType() and the super types above it.

Nothing is recorded for a runtime definition, so this is the bean type and every super class and interface above it, which is the hierarchy a build time definition records for the same classes. It answers empty when none of them declares a type parameter, again as a build time definition does.

The test is what the hierarchy declares rather than what resolves, so that the keys do not depend on whether an argument could be resolved. A bean implementing a raw or unbound super type - RawRepo implements Repo - names Repo here exactly as a build time definition does, even though getTypeArguments(Class) answers nothing for it where a build time definition answers the erased variable.

Specified by:

getTypeArgumentKeys in interface BeanDefinition<T>

Returns:

The recorded type keys, never null

isContextScope

default boolean isContextScope()

Specified by:

isContextScope in interface BeanDefinitionReference<T>

Returns:

Is this class context scope

isConfigurationProperties

default boolean isConfigurationProperties()

Specified by:

isConfigurationProperties in interface BeanDefinition<T>

Specified by:

isConfigurationProperties in interface BeanDefinitionReference<T>

Returns:

Is this bean a configuration properties.

load

default 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

getBeanDefinitionName

default String getBeanDefinitionName()

Specified by:

getBeanDefinitionName in interface BeanDefinitionReference<T>

Returns:

The class name of the backing BeanDefinition

load

default BeanDefinition<T> load(BeanContext context)

Description copied from interface: BeanDefinitionReference

Loads the bean definition for the current BeanContext.

Specified by:

load in interface BeanDefinitionReference<T>

Parameters:

context - The bean context

Returns:

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

isPresent

default boolean isPresent()

Specified by:

isPresent in interface BeanDefinitionReference<T>

Returns:

Is the underlying bean type present on the classpath

isSingleton

default boolean isSingleton()

Specified by:

isSingleton in interface BeanDefinition<T>

Specified by:

isSingleton in interface BeanDefinitionReference<T>

Returns:

Is this bean a singleton.

of

static <B> RuntimeBeanDefinition<B> of(B bean)

Creates a new effectively singleton bean definition that references the given bean.

Type Parameters:

B - The bean type

Parameters:

bean - The bean

Returns:

The BeanDefinitionReference

Since:

3.6.0

of

static <B> RuntimeBeanDefinition<B> of(Class<B> beanType,
 Supplier<B> beanSupplier)

Creates a new bean definition that will resolve the bean from the given supplier.

The bean is by default not singleton and the supplier will be invoked for each injection point.

Type Parameters:

B - The bean type

Parameters:

beanType - The bean type

beanSupplier - The bean supplier

Returns:

The BeanDefinitionReference

Since:

3.6.0

builder

static <B> RuntimeBeanDefinition.Builder<B> builder(B bean)

A new builder for constructing and configuring runtime created beans.

Type Parameters:

B - The bean type

Parameters:

bean - The bean to use

Returns:

The builder

builder

static <B> RuntimeBeanDefinition.Builder<B> builder(Class<B> beanType,
 Supplier<B> beanSupplier)

A new builder for constructing and configuring runtime created beans.

Type Parameters:

B - The bean type

Parameters:

beanType - The bean type

beanSupplier - The bean supplier

Returns:

The builder

builder

static <B> RuntimeBeanDefinition.Builder<B> builder(Argument<B> beanType,
 Supplier<B> beanSupplier)

A new builder for constructing and configuring runtime created beans.

Type Parameters:

B - The bean type

Parameters:

beanType - The bean type

beanSupplier - The bean supplier

Returns:

The builder

builder

static <B> RuntimeBeanDefinition.Builder<B> builder(Class<B> beanType,
 Function<RuntimeBeanDefinition.CreationContext, B> beanFactory)

A new builder for constructing and configuring runtime created beans where the bean factory receives the RuntimeBeanDefinition.CreationContext of each creation.

The creation context carries the beans resolved for the injection points declared with RuntimeBeanDefinition.Builder.injectionPoint(Argument) and the injection point the bean is being created for.

Type Parameters:

B - The bean type

Parameters:

beanType - The bean type

beanFactory - The bean factory that receives the RuntimeBeanDefinition.CreationContext

Returns:

The builder

Since:

5.2.0

builder

static <B> RuntimeBeanDefinition.Builder<B> builder(Argument<B> beanType,
 Function<RuntimeBeanDefinition.CreationContext, B> beanFactory)

A new builder for constructing and configuring runtime created beans where the bean factory receives the RuntimeBeanDefinition.CreationContext of each creation.

The creation context carries the beans resolved for the injection points declared with RuntimeBeanDefinition.Builder.injectionPoint(Argument) and the injection point the bean is being created for.

Type Parameters:

B - The bean type

Parameters:

beanType - The bean type

beanFactory - The bean factory that receives the RuntimeBeanDefinition.CreationContext

Returns:

The builder

Since:

5.2.0