io.micronaut.context

Interface BeanContext

All Superinterfaces:

AnnotationMetadataResolver, ApplicationEventPublisher, AttributeHolder, java.lang.AutoCloseable, BeanDefinitionRegistry, BeanLocator, java.io.Closeable, ExecutionHandleLocator, LifeCycle<BeanContext>, MutableAttributeHolder

All Known Subinterfaces:

ApplicationContext

All Known Implementing Classes:

DefaultApplicationContext, DefaultBeanContext

public interface BeanContext
extends LifeCycle<BeanContext>, ExecutionHandleLocator, BeanLocator, BeanDefinitionRegistry, ApplicationEventPublisher, AnnotationMetadataResolver, MutableAttributeHolder

The core BeanContext abstraction which allows for dependency injection of classes annotated with Inject.

Apart of the standard javax.inject annotations for dependency injection, additional annotations within the io.micronaut.context.annotation package allow control over configuration of the bean context.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields inherited from interface io.micronaut.context.ExecutionHandleLocator

EMPTY

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

DEFAULT

Method Summary

Modifier and Type	Method and Description
static BeanContext	build() Build a BeanContext.
static BeanContext	build(java.lang.ClassLoader classLoader) Build a BeanContext.
default <T> T	createBean(java.lang.Class<T> beanType) Creates a new instance of the given bean performing dependency injection and returning a new instance.
default <T> T	createBean(java.lang.Class<T> beanType, java.util.Map<java.lang.String,java.lang.Object> argumentValues) Creates a new instance of the given bean performing dependency injection and returning a new instance.
default <T> T	createBean(java.lang.Class<T> beanType, java.lang.Object... args) Creates a new instance of the given bean performing dependency injection and returning a new instance.
<T> T	createBean(java.lang.Class<T> beanType, Qualifier<T> qualifier) Creates a new instance of the given bean performing dependency injection and returning a new instance.
<T> T	createBean(java.lang.Class<T> beanType, Qualifier<T> qualifier, java.util.Map<java.lang.String,java.lang.Object> argumentValues) Creates a new instance of the given bean performing dependency injection and returning a new instance.
<T> T	createBean(java.lang.Class<T> beanType, Qualifier<T> qualifier, java.lang.Object... args) Creates a new instance of the given bean performing dependency injection and returning a new instance.
<T> T	destroyBean(java.lang.Class<T> beanType) Destroys the bean for the given type causing it to be re-created.
BeanDefinitionValidator	getBeanValidator()
java.lang.ClassLoader	getClassLoader()
<T> T	inject(T instance) Inject an existing instance.
<T> java.util.Optional<T>	refreshBean(BeanIdentifier identifier) Refresh the state of the given registered bean applying dependency injection and configuration wiring again.
default <T> BeanContext	registerSingleton(java.lang.Class<T> type, T singleton) Registers a new singleton bean at runtime.
default <T> BeanContext	registerSingleton(java.lang.Class<T> type, T singleton, Qualifier<T> qualifier) Registers a new singleton bean at runtime.
<T> BeanContext	registerSingleton(java.lang.Class<T> type, T singleton, Qualifier<T> qualifier, boolean inject) Registers a new singleton bean at runtime.
default BeanContext	registerSingleton(java.lang.Object singleton) Registers a new singleton bean at runtime.
default @NotNull BeanContext	registerSingleton(@NotNull java.lang.Object singleton, boolean inject) Registers a new singleton bean at runtime.
static BeanContext	run() Run the BeanContext.
static BeanContext	run(java.lang.ClassLoader classLoader) Run the BeanContext.

Methods inherited from interface io.micronaut.context.LifeCycle

close, isRunning, refresh, start, stop

Methods inherited from interface io.micronaut.context.ExecutionHandleLocator

createExecutionHandle, findExecutableMethod, findExecutionHandle, findExecutionHandle, findExecutionHandle, findProxyTargetMethod, findProxyTargetMethod, getExecutableMethod, getExecutionHandle, getExecutionHandle, getProxyTargetMethod, getProxyTargetMethod

Methods inherited from interface io.micronaut.context.BeanLocator

findBean, findBean, findOrInstantiateBean, getBean, getBean, getBean, getBeansOfType, getBeansOfType, getProxyTargetBean, streamOfType, streamOfType

Methods inherited from interface io.micronaut.context.BeanDefinitionRegistry

containsBean, containsBean, findBeanConfiguration, findBeanDefinition, findBeanDefinition, findBeanRegistration, findProxyBeanDefinition, findProxyTargetBeanDefinition, getActiveBeanRegistrations, getActiveBeanRegistrations, getAllBeanDefinitions, getBeanDefinition, getBeanDefinition, getBeanDefinitionReferences, getBeanDefinitions, getBeanDefinitions, getBeanDefinitions, getBeanRegistrations, getProxyTargetBeanDefinition

Methods inherited from interface io.micronaut.context.event.ApplicationEventPublisher

publishEvent, publishEventAsync

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

resolveMetadata, resolveMetadata

Methods inherited from interface io.micronaut.core.attr.MutableAttributeHolder

getAttributes, removeAttribute, setAttribute

Methods inherited from interface io.micronaut.core.attr.AttributeHolder

getAttribute, getAttribute

Method Detail

inject

@NonNull
<T> T inject(@NonNull
                      T instance)

Inject an existing instance.

Type Parameters:

T - The bean generic type

Parameters:

instance - The instance to inject

Returns:

The instance to inject

createBean

@NonNull
default <T> T createBean(@NonNull
                                  java.lang.Class<T> beanType)

Creates a new instance of the given bean performing dependency injection and returning a new instance.

Note that the instance returned is not saved as a singleton in the context.

Type Parameters:

T - The bean generic type

Parameters:

beanType - The bean type

Returns:

The instance

createBean

@NonNull
<T> T createBean(@NonNull
                          java.lang.Class<T> beanType,
                          @Nullable
                          Qualifier<T> qualifier)

Creates a new instance of the given bean performing dependency injection and returning a new instance.

Note that the instance returned is not saved as a singleton in the context.

Type Parameters:

T - The bean generic type

Parameters:

beanType - The bean type

qualifier - The qualifier

Returns:

The instance

createBean

@NonNull
<T> T createBean(@NonNull
                          java.lang.Class<T> beanType,
                          @Nullable
                          Qualifier<T> qualifier,
                          @Nullable
                          java.util.Map<java.lang.String,java.lang.Object> argumentValues)

Creates a new instance of the given bean performing dependency injection and returning a new instance.

If the bean defines any Parameter values then the values passed in the argumentValues parameter will be used

Note that the instance returned is not saved as a singleton in the context.

Type Parameters:

T - The bean generic type

Parameters:

beanType - The bean type

qualifier - The qualifier

argumentValues - The argument values

Returns:

The instance

createBean

@NonNull
<T> T createBean(@NonNull
                          java.lang.Class<T> beanType,
                          @Nullable
                          Qualifier<T> qualifier,
                          @Nullable
                          java.lang.Object... args)

Creates a new instance of the given bean performing dependency injection and returning a new instance.

If the bean defines any Parameter values then the values passed in the argumentValues parameter will be used

Note that the instance returned is not saved as a singleton in the context.

Type Parameters:

T - The bean generic type

Parameters:

beanType - The bean type

qualifier - The qualifier

args - The argument values

Returns:

The instance

createBean

@NonNull
default <T> T createBean(@NonNull
                                  java.lang.Class<T> beanType,
                                  @Nullable
                                  java.lang.Object... args)

Creates a new instance of the given bean performing dependency injection and returning a new instance.

If the bean defines any Parameter values then the values passed in the argumentValues parameter will be used

Note that the instance returned is not saved as a singleton in the context.

Type Parameters:

T - The bean generic type

Parameters:

beanType - The bean type

args - The argument values

Returns:

The instance

createBean

@NonNull
default <T> T createBean(@NonNull
                                  java.lang.Class<T> beanType,
                                  @Nullable
                                  java.util.Map<java.lang.String,java.lang.Object> argumentValues)

Creates a new instance of the given bean performing dependency injection and returning a new instance.

If the bean defines any Parameter values then the values passed in the argumentValues parameter will be used

Note that the instance returned is not saved as a singleton in the context.

Type Parameters:

T - The bean generic type

Parameters:

beanType - The bean type

argumentValues - The argument values

Returns:

The instance

destroyBean

@Nullable
<T> T destroyBean(@NonNull
                            java.lang.Class<T> beanType)

Destroys the bean for the given type causing it to be re-created. If a singleton has been loaded it will be destroyed and removed from the context, otherwise null will be returned.

Type Parameters:

T - The concrete class

Parameters:

beanType - The bean type

Returns:

The destroy instance or null if no such bean exists

refreshBean

@NonNull
<T> java.util.Optional<T> refreshBean(@Nullable
                                               BeanIdentifier identifier)

Refresh the state of the given registered bean applying dependency injection and configuration wiring again.

Note that if the bean was produced by a Factory then this method will refresh the factory too

Type Parameters:

T - The concrete class

Parameters:

identifier - The BeanIdentifier

Returns:

An Optional of the instance if it exists for the given registration

getClassLoader

@NonNull
java.lang.ClassLoader getClassLoader()

Returns:

The class loader used by this context

getBeanValidator

@NonNull
BeanDefinitionValidator getBeanValidator()

Returns:

Get the configured bean validator, if any.

registerSingleton

@NonNull
<T> BeanContext registerSingleton(@NonNull
                                           java.lang.Class<T> type,
                                           @NonNull
                                           T singleton,
                                           @Nullable
                                           Qualifier<T> qualifier,
                                           boolean inject)

Description copied from interface: BeanDefinitionRegistry

Registers a new singleton bean at runtime. This method expects that the bean definition data will have been compiled ahead of time.

If bean definition data is found the method will perform dependency injection on the instance followed by invoking any PostConstruct hooks.

If no bean definition data is found the bean is registered as is.

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Type Parameters:

T - The concrete type

Parameters:

type - The bean type

singleton - The singleton bean

qualifier - The bean qualifier

inject - Whether the singleton should be injected (defaults to true)

Returns:

This bean context

registerSingleton

default BeanContext registerSingleton(@NonNull
                                      java.lang.Object singleton)

Description copied from interface: BeanDefinitionRegistry

Registers a new singleton bean at runtime. This method expects that the bean definition data will have been compiled ahead of time.

If bean definition data is found the method will perform dependency injection on the instance followed by invoking any PostConstruct hooks.

If no bean definition data is found the bean is registered as is.

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Parameters:

singleton - The singleton bean

Returns:

This bean context

registerSingleton

default <T> BeanContext registerSingleton(java.lang.Class<T> type,
                                          T singleton,
                                          Qualifier<T> qualifier)

Description copied from interface: BeanDefinitionRegistry

Registers a new singleton bean at runtime. This method expects that the bean definition data will have been compiled ahead of time.

If bean definition data is found the method will perform dependency injection on the instance followed by invoking any PostConstruct hooks.

If no bean definition data is found the bean is registered as is.

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Type Parameters:

T - The concrete type

Parameters:

type - The bean type

singleton - The singleton bean

qualifier - The bean qualifier

Returns:

This bean context

registerSingleton

default <T> BeanContext registerSingleton(java.lang.Class<T> type,
                                          T singleton)

Description copied from interface: BeanDefinitionRegistry

Registers a new singleton bean at runtime. This method expects that the bean definition data will have been compiled ahead of time.

If bean definition data is found the method will perform dependency injection on the instance followed by invoking any PostConstruct hooks.

If no bean definition data is found the bean is registered as is.

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Type Parameters:

T - The concrete type

Parameters:

type - the bean type

singleton - The singleton bean

Returns:

This bean context

registerSingleton

@NotNull
default @NotNull BeanContext registerSingleton(@NotNull
                                                        @NotNull java.lang.Object singleton,
                                                        boolean inject)

Description copied from interface: BeanDefinitionRegistry

Registers a new singleton bean at runtime. This method expects that the bean definition data will have been compiled ahead of time.

If bean definition data is found the method will perform dependency injection on the instance followed by invoking any PostConstruct hooks.

If no bean definition data is found the bean is registered as is.

Specified by:

registerSingleton in interface BeanDefinitionRegistry

Parameters:

singleton - The singleton bean

inject - Whether the singleton should be injected (defaults to true)

Returns:

This bean context

run

@NonNull
static BeanContext run()

Run the BeanContext. This method will instantiate a new BeanContext and call LifeCycle.start().

Returns:

The running BeanContext

build

@NonNull
static BeanContext build()

Build a BeanContext.

Returns:

The built, but not yet running BeanContext

run

@NonNull
static BeanContext run(java.lang.ClassLoader classLoader)

Run the BeanContext. This method will instantiate a new BeanContext and call LifeCycle.start().

Parameters:

classLoader - The classloader to use

Returns:

The running BeanContext

build

@NonNull
static BeanContext build(java.lang.ClassLoader classLoader)

Build a BeanContext.

Parameters:

classLoader - The classloader to use

Returns:

The built, but not yet running BeanContext