ApplicationContextBuilder (micronaut 2.0.0 API)

All Known Implementing Classes:

DefaultApplicationContextBuilder, Micronaut
```
public interface ApplicationContextBuilder
```
An interface for building an application context.

Since:

1.0

Author:

graemerocher

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default ApplicationContextBuilder`	`args(String... args)` Set the command line arguments.
`ApplicationContext`	`build()` Builds the `ApplicationContext`, but does not start it.
`ApplicationContextBuilder`	`classLoader(ClassLoader classLoader)` The class loader to be used.
`ApplicationContextBuilder`	`deduceEnvironment(Boolean deduceEnvironment)` Whether to deduce environments.
`ApplicationContextBuilder`	`eagerInitAnnotated(Class<? extends Annotation>... annotations)` Specifies to eager init the given annotated types.
`default ApplicationContextBuilder`	`eagerInitConfiguration(boolean eagerInitConfiguration)` Whether to eager initialize `ConfigurationProperties` beans.
`default ApplicationContextBuilder`	`eagerInitSingletons(boolean eagerInitSingletons)` Whether to eager initialize singleton beans.
`ApplicationContextBuilder`	`environmentPropertySource(boolean environmentPropertySource)` Set whether environment variables should contribute to configuration.
`ApplicationContextBuilder`	`environments(String... environments)` The environments to use.
`ApplicationContextBuilder`	`environmentVariableExcludes(String... environmentVariables)` Which environment variables should not contribute to configuration.
`ApplicationContextBuilder`	`environmentVariableIncludes(String... environmentVariables)` Which environment variables should contribute to configuration.
`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`	`overrideConfigLocations(String... configLocations)` Override default config locations
`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

eagerInitConfiguration
```
@NonNull
default ApplicationContextBuilder eagerInitConfiguration(boolean eagerInitConfiguration)
```
Whether to eager initialize ConfigurationProperties beans.

Parameters:

eagerInitConfiguration - True if configuration properties should be eagerly initialized

Returns:

The context builder

Since:

2.0

eagerInitSingletons
```
@NonNull
default ApplicationContextBuilder eagerInitSingletons(boolean eagerInitSingletons)
```
Whether to eager initialize singleton beans.

Parameters:

eagerInitSingletons - True if singletons should be eagerly initialized

Returns:

The context builder

Since:

2.0

eagerInitAnnotated
```
@NonNull
ApplicationContextBuilder eagerInitAnnotated(Class<? extends Annotation>... annotations)
```
Specifies to eager init the given annotated types.

Parameters:

annotations - The annotation stereotypes

Returns:

The context builder

Since:

2.0

overrideConfigLocations
```
@NonNull
ApplicationContextBuilder overrideConfigLocations(String... configLocations)
```
Override default config locations

Parameters:

configLocations - The config locations

Returns:

This environment

Since:

2.0

singletons

@NonNull
ApplicationContextBuilder singletons(@Nullable
                                              Object... beans)

Additional singletons to register prior to startup.

Parameters:: beans - The beans
Returns:: This builder

deduceEnvironment

@NonNull
ApplicationContextBuilder deduceEnvironment(@Nullable
                                                     Boolean deduceEnvironment)

Whether to deduce environments.

Parameters:: deduceEnvironment - The boolean
Returns:: This builder

environments

@NonNull
ApplicationContextBuilder environments(@Nullable
                                                String... environments)

The environments to use.

Parameters:: environments - The environments
Returns:: This builder

packages

@NonNull
ApplicationContextBuilder packages(@Nullable
                                            String... packages)

The packages to include for package scanning.

Parameters:: packages - The packages
Returns:: This builder

properties

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

Properties to override from the environment.

Parameters:: properties - The properties
Returns:: This builder

propertySources

@NonNull
ApplicationContextBuilder propertySources(@Nullable
                                                   PropertySource... propertySources)

Additional property sources.

Parameters:: propertySources - The property sources to include
Returns:: This builder

environmentPropertySource
```
@NonNull
ApplicationContextBuilder environmentPropertySource(boolean environmentPropertySource)
```
Set whether environment variables should contribute to configuration.

Parameters:

environmentPropertySource - The boolean

Returns:

This builder

environmentVariableIncludes

@NonNull
ApplicationContextBuilder environmentVariableIncludes(@Nullable
                                                               String... environmentVariables)

Which environment variables should contribute to configuration.

Parameters:: environmentVariables - The environment variables
Returns:: This builder

environmentVariableExcludes

@NonNull
ApplicationContextBuilder environmentVariableExcludes(@Nullable
                                                               String... environmentVariables)

Which environment variables should not contribute to configuration.

Parameters:: environmentVariables - The environment variables
Returns:: This builder

mainClass

@NonNull
ApplicationContextBuilder mainClass(@Nullable
                                             Class mainClass)

The main class used by this application.

Parameters:: mainClass - The main class
Returns:: This builder

classLoader

@NonNull
ApplicationContextBuilder classLoader(@Nullable
                                               ClassLoader classLoader)

The class loader to be used.

Parameters:: classLoader - The classloader
Returns:: This builder

build
```
@NonNull
ApplicationContext build()
```
Builds the ApplicationContext, but does not start it.

Returns:

The built, but not running ApplicationContext

include

@NonNull
ApplicationContextBuilder include(@Nullable
                                           String... configurations)

Allow customizing the configurations that will be loaded.

Parameters:: configurations - The configurations to include
Returns:: This application

exclude

@NonNull
ApplicationContextBuilder exclude(@Nullable
                                           String... configurations)

Allow customizing the configurations that will be loaded.

Parameters:: configurations - The configurations to exclude
Returns:: This application

args

@NonNull
default ApplicationContextBuilder args(@Nullable
                                                String... args)

Set the command line arguments.

Parameters:: args - The arguments
Returns:: This application

start
```
@NonNull
default ApplicationContext start()
```
Starts the ApplicationContext.

Returns:

The running ApplicationContext

run
```
@NonNull
default <T extends AutoCloseable> T run(@NonNull
                                                 Class<T> type)
```
Run the ApplicationContext with the given type. Returning an instance of the type.

Type Parameters:

T - The type, a subclass of AutoCloseable. The close method of the implementation should shutdown the context.

Parameters:

type - The type of the bean to run

Returns:

The running bean

Interface ApplicationContextBuilder

Method Summary

Method Detail

eagerInitConfiguration

eagerInitSingletons

eagerInitAnnotated

overrideConfigLocations