io.micronaut.context

Interface ApplicationContextBuilder

All Known Implementing Classes:

DefaultApplicationContextBuilder, Micronaut

public interface ApplicationContextBuilder

An interface for building an application context.

Since:

1.0

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
ApplicationContext	build() Builds the ApplicationContext, but does not start it.
ApplicationContextBuilder	classLoader(ClassLoader classLoader) The class loader to be used.
ApplicationContextBuilder	environments(String... environments) The environments to use.
ApplicationContextBuilder	exclude(String... configurations) Allow customizing the configurations that will be loaded.
ApplicationContextBuilder	include(String... configurations) Allow customizing the configurations that will be loaded.
ApplicationContextBuilder	mainClass(Class mainClass) The main class used by this application.
ApplicationContextBuilder	packages(String... packages) The packages to include for package scanning.
ApplicationContextBuilder	properties(Map<String,Object> properties) Properties to override from the environment.
ApplicationContextBuilder	propertySources(PropertySource... propertySources) Additional property sources.
default <T extends AutoCloseable> T	run(Class<T> type) Run the ApplicationContext with the given type.
ApplicationContextBuilder	singletons(Object... beans) Additional singletons to register prior to startup.
default ApplicationContext	start() Starts the ApplicationContext.

Method Detail

singletons

ApplicationContextBuilder singletons(Object... beans)

Additional singletons to register prior to startup.

Parameters:

beans - The beans

Returns:

This builder

environments

ApplicationContextBuilder environments(@Nullable
                                       String... environments)

The environments to use.

Parameters:

environments - The environments

Returns:

This builder

packages

ApplicationContextBuilder packages(@Nullable
                                   String... packages)

The packages to include for package scanning.

Parameters:

packages - The packages

Returns:

This builder

properties

ApplicationContextBuilder properties(@Nullable
                                     Map<String,Object> properties)

Properties to override from the environment.

Parameters:

properties - The properties

Returns:

This builder

propertySources

ApplicationContextBuilder propertySources(@Nullable
                                          PropertySource... propertySources)

Additional property sources.

Parameters:

propertySources - The property sources to include

Returns:

This builder

mainClass

ApplicationContextBuilder mainClass(Class mainClass)

The main class used by this application.

Parameters:

mainClass - The main class

Returns:

This builder

classLoader

ApplicationContextBuilder classLoader(ClassLoader classLoader)

The class loader to be used.

Parameters:

classLoader - The classloader

Returns:

This builder

build

ApplicationContext build()

Builds the ApplicationContext, but does not start it.

Returns:

The built, but not running ApplicationContext

include

ApplicationContextBuilder include(@Nullable
                                  String... configurations)

Allow customizing the configurations that will be loaded.

Parameters:

configurations - The configurations to include

Returns:

This application

exclude

ApplicationContextBuilder exclude(@Nullable
                                  String... configurations)

Allow customizing the configurations that will be loaded.

Parameters:

configurations - The configurations to exclude

Returns:

This application

start

default ApplicationContext start()

Starts the ApplicationContext.

Returns:

The running ApplicationContext

run

default <T extends AutoCloseable> T run(Class<T> type)

Run the ApplicationContext with the given type. Returning an instance of the type.

Type Parameters:

T - The type, a subclass of ApplicationContextLifeCycle

Parameters:

type - The type of the bean to run

Returns:

The running bean