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

Description

@NonNull ApplicationContextBuilder

allowEmptyProviders(boolean shouldAllow)

Whether to error on an empty bean provider.

default @NonNull ApplicationContextBuilder

args(@Nullable String... args)

Set the command line arguments.

@NonNull ApplicationContextBuilder

banner(boolean isEnabled)

Whether the banner is enabled or not.

default @NonNull ApplicationContextBuilder

bootstrapEnvironment(boolean bootstrapEnv)

Sets whether the bootstrap environment should be initialized.

@NonNull ApplicationContext

build()

Builds the ApplicationContext, but does not start it.

@NonNull ApplicationContextBuilder

classLoader(@Nullable ClassLoader classLoader)

The class loader to be used.

@NonNull ApplicationContextBuilder

deduceCloudEnvironment(boolean deduceEnvironment)

If set to true (the default value is false) Micronaut will attempt to automatically deduce the Cloud environment it is running within.

@NonNull ApplicationContextBuilder

deduceEnvironment(@Nullable Boolean deduceEnvironment)

If set to true (the default is true) Micronaut will attempt to automatically deduce the environment it is running in using environment variables and/or stack trace inspection.

@NonNull ApplicationContextBuilder

defaultEnvironments(@Nullable String... environments)

The environments to use if no other environments are specified.

@NonNull ApplicationContextBuilder

eagerInitAnnotated(Class<? extends Annotation>... annotations)

Specifies to eager init the given annotated types.

default @NonNull ApplicationContextBuilder

eagerInitConfiguration(boolean eagerInitConfiguration)

Whether to eager initialize ConfigurationProperties beans.

default @NonNull ApplicationContextBuilder

eagerInitSingletons(boolean eagerInitSingletons)

Whether to eager initialize singleton beans.

default @NonNull ApplicationContextBuilder

enableDefaultPropertySources(boolean areEnabled)

Specify whether the default set of property sources should be enabled (default is true).

@NonNull ApplicationContextBuilder

environmentPropertySource(boolean environmentPropertySource)

Set whether environment variables should contribute to configuration.

@NonNull ApplicationContextBuilder

environments(@Nullable String... environments)

The environments to use.

@NonNull ApplicationContextBuilder

environmentVariableExcludes(@Nullable String... environmentVariables)

Which environment variables should not contribute to configuration.

@NonNull ApplicationContextBuilder

environmentVariableIncludes(@Nullable String... environmentVariables)

Which environment variables should contribute to configuration.

@NonNull ApplicationContextBuilder

exclude(@Nullable String... configurations)

Allow customizing the configurations that will be loaded.

@NonNull ApplicationContextBuilder

include(@Nullable String... configurations)

Allow customizing the configurations that will be loaded.

@NonNull ApplicationContextBuilder

mainClass(@Nullable Class<?> mainClass)

The main class used by this application.

@NonNull ApplicationContextBuilder

overrideConfigLocations(String... configLocations)

Override default config locations.

@NonNull ApplicationContextBuilder

packages(@Nullable String... packages)

The packages to include for package scanning.

@NonNull ApplicationContextBuilder

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

Properties to override from the environment.

@NonNull ApplicationContextBuilder

propertySources(@Nullable PropertySource... propertySources)

Additional property sources.

default <T extends AutoCloseable> T

run(@NonNull Class<T> type)

Run the ApplicationContext with the given type.

@NonNull ApplicationContextBuilder

singletons(@Nullable Object... beans)

Additional singletons to register prior to startup.

default @NonNull ApplicationContext

start()

Starts the ApplicationContext.

Method Details
- eagerInitConfiguration
  
  @NonNull default @NonNull 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 @NonNull 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
- enableDefaultPropertySources
  
  @NonNull default @NonNull ApplicationContextBuilder enableDefaultPropertySources(boolean areEnabled)
  
  Specify whether the default set of property sources should be enabled (default is true).
  
  Parameters:
  
  areEnabled - Whether the default property sources are enabled
  
  Returns:
  
  This builder
  
  Since:
  
  3.7.0
- eagerInitAnnotated
  
  @NonNull @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 @NonNull ApplicationContextBuilder overrideConfigLocations(String... configLocations)
  
  Override default config locations.
  
  Parameters:
  
  configLocations - The config locations
  
  Returns:
  
  This environment
  
  Since:
  
  2.0
- singletons
  
  @NonNull @NonNull ApplicationContextBuilder singletons(@Nullable @Nullable Object... beans)
  
  Additional singletons to register prior to startup.
  
  Parameters:
  
  beans - The beans
  
  Returns:
  
  This builder
- deduceEnvironment
  
  @NonNull @NonNull ApplicationContextBuilder deduceEnvironment(@Nullable @Nullable Boolean deduceEnvironment)
  
  If set to true (the default is true) Micronaut will attempt to automatically deduce the environment it is running in using environment variables and/or stack trace inspection.
  This method differs from deduceCloudEnvironment(boolean) which performs extended network and/or disk probes to try and automatically establish the Cloud environment.
  
  This behaviour controls the automatic activation of, for example, the Environment.TEST when running tests.
  
  Parameters:
  
  deduceEnvironment - The boolean
  
  Returns:
  
  This builder
- deduceCloudEnvironment
  
  @NonNull @NonNull ApplicationContextBuilder deduceCloudEnvironment(boolean deduceEnvironment)
  
  If set to true (the default value is false) Micronaut will attempt to automatically deduce the Cloud environment it is running within.
  Enabling this should be done with caution since network probes are required to figure out whether the application is running in certain clouds like GCP.
  
  Parameters:
  
  deduceEnvironment - The boolean
  
  Returns:
  
  This builder
  
  Since:
  
  4.0.0
- environments
  
  @NonNull @NonNull ApplicationContextBuilder environments(@Nullable @Nullable String... environments)
  
  The environments to use.
  
  Parameters:
  
  environments - The environments
  
  Returns:
  
  This builder
- defaultEnvironments
  
  @NonNull @NonNull ApplicationContextBuilder defaultEnvironments(@Nullable @Nullable String... environments)
  
  The environments to use if no other environments are specified.
  
  Parameters:
  
  environments - The environments
  
  Returns:
  
  This builder
- packages
  
  @NonNull @NonNull ApplicationContextBuilder packages(@Nullable @Nullable String... packages)
  
  The packages to include for package scanning.
  
  Parameters:
  
  packages - The packages
  
  Returns:
  
  This builder
- properties
  
  @NonNull @NonNull ApplicationContextBuilder properties(@Nullable @Nullable Map<String,Object> properties)
  
  Properties to override from the environment.
  
  Parameters:
  
  properties - The properties
  
  Returns:
  
  This builder
- propertySources
  
  @NonNull @NonNull ApplicationContextBuilder propertySources(@Nullable @Nullable PropertySource... propertySources)
  
  Additional property sources.
  
  Parameters:
  
  propertySources - The property sources to include
  
  Returns:
  
  This builder
- environmentPropertySource
  
  @NonNull @NonNull ApplicationContextBuilder environmentPropertySource(boolean environmentPropertySource)
  
  Set whether environment variables should contribute to configuration.
  
  Parameters:
  
  environmentPropertySource - The boolean
  
  Returns:
  
  This builder
- environmentVariableIncludes
  
  @NonNull @NonNull ApplicationContextBuilder environmentVariableIncludes(@Nullable @Nullable String... environmentVariables)
  
  Which environment variables should contribute to configuration.
  
  Parameters:
  
  environmentVariables - The environment variables
  
  Returns:
  
  This builder
- environmentVariableExcludes
  
  @NonNull @NonNull ApplicationContextBuilder environmentVariableExcludes(@Nullable @Nullable String... environmentVariables)
  
  Which environment variables should not contribute to configuration.
  
  Parameters:
  
  environmentVariables - The environment variables
  
  Returns:
  
  This builder
- mainClass
  
  @NonNull @NonNull ApplicationContextBuilder mainClass(@Nullable @Nullable Class<?> mainClass)
  
  The main class used by this application.
  
  Parameters:
  
  mainClass - The main class
  
  Returns:
  
  This builder
- classLoader
  
  @NonNull @NonNull ApplicationContextBuilder classLoader(@Nullable @Nullable ClassLoader classLoader)
  
  The class loader to be used.
  
  Parameters:
  
  classLoader - The classloader
  
  Returns:
  
  This builder
- build
  
  @NonNull @NonNull ApplicationContext build()
  
  Builds the ApplicationContext, but does not start it.
  
  Returns:
  
  The built, but not running ApplicationContext
- include
  
  @NonNull @NonNull ApplicationContextBuilder include(@Nullable @Nullable String... configurations)
  
  Allow customizing the configurations that will be loaded.
  
  Parameters:
  
  configurations - The configurations to include
  
  Returns:
  
  This application
- exclude
  
  @NonNull @NonNull ApplicationContextBuilder exclude(@Nullable @Nullable String... configurations)
  
  Allow customizing the configurations that will be loaded.
  
  Parameters:
  
  configurations - The configurations to exclude
  
  Returns:
  
  This application
- banner
  
  @NonNull @NonNull ApplicationContextBuilder banner(boolean isEnabled)
  
  Whether the banner is enabled or not.
  
  Parameters:
  
  isEnabled - Whether the banner is enabled or not
  
  Returns:
  
  This application
- allowEmptyProviders
  
  @NonNull @NonNull ApplicationContextBuilder allowEmptyProviders(boolean shouldAllow)
  
  Whether to error on an empty bean provider. Defaults to false.
  
  Parameters:
  
  shouldAllow - True if empty Provider instances are allowed
  
  Returns:
  
  This application
  
  Since:
  
  3.0.0
- args
  
  @NonNull default @NonNull ApplicationContextBuilder args(@Nullable @Nullable String... args)
  
  Set the command line arguments.
  
  Parameters:
  
  args - The arguments
  
  Returns:
  
  This application
- bootstrapEnvironment
  
  @NonNull default @NonNull ApplicationContextBuilder bootstrapEnvironment(boolean bootstrapEnv)
  
  Sets whether the bootstrap environment should be initialized.
  
  Parameters:
  
  bootstrapEnv - True if it should be initialized. Default true
  
  Returns:
  
  This application
  
  Since:
  
  3.1.0
- start
  
  @NonNull default @NonNull ApplicationContext start()
  
  Starts the ApplicationContext.
  
  Returns:
  
  The running ApplicationContext
- run
  
  @NonNull default <T extends AutoCloseable> T run(@NonNull @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 Details

eagerInitConfiguration

eagerInitSingletons

enableDefaultPropertySources

eagerInitAnnotated

overrideConfigLocations

singletons

deduceEnvironment

deduceCloudEnvironment

environments

defaultEnvironments

packages

properties

propertySources

environmentPropertySource

environmentVariableIncludes

environmentVariableExcludes

mainClass

classLoader

build

include

exclude

banner

allowEmptyProviders

args

bootstrapEnvironment

start

run