Package io.micronaut.context
Class DefaultApplicationContextBuilder
- java.lang.Object
-
- io.micronaut.context.DefaultApplicationContextBuilder
-
- All Implemented Interfaces:
ApplicationContextBuilder,ApplicationContextConfiguration,BeanContextConfiguration
public class DefaultApplicationContextBuilder extends java.lang.Object implements ApplicationContextBuilder, ApplicationContextConfiguration
Implementation ofApplicationContextBuilder.- Since:
- 1.0
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedDefaultApplicationContextBuilder()Default constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ApplicationContextBuilderallowEmptyProviders(boolean shouldAllow)Whether to error on an empty bean provider.ApplicationContextBuilderargs(java.lang.String... args)Set the command line arguments.ApplicationContextBuilderbanner(boolean isEnabled)Whether the banner is enabled or not.ApplicationContextBuilderbootstrapEnvironment(boolean bootstrapEnv)Sets whether the bootstrap environment should be initialized.ApplicationContextbuild()Builds theApplicationContext, but does not start it.ApplicationContextBuilderclassLoader(java.lang.ClassLoader classLoader)The class loader to be used.ApplicationContextBuilderdeduceEnvironment(java.lang.Boolean deduceEnvironments)Whether to deduce environments.ApplicationContextBuilderdefaultEnvironments(java.lang.String... environments)The environments to use if no other environments are specified.ApplicationContextBuildereagerInitAnnotated(java.lang.Class<? extends java.lang.annotation.Annotation>... annotations)Specifies to eager init the given annotated types.ApplicationContextBuilderenvironmentPropertySource(boolean environmentPropertySource)Set whether environment variables should contribute to configuration.ApplicationContextBuilderenvironments(java.lang.String... environments)The environments to use.ApplicationContextBuilderenvironmentVariableExcludes(java.lang.String... environmentVariables)Which environment variables should not contribute to configuration.ApplicationContextBuilderenvironmentVariableIncludes(java.lang.String... environmentVariables)Which environment variables should contribute to configuration.ApplicationContextBuilderexclude(java.lang.String... configurations)Allow customizing the configurations that will be loaded.java.lang.ClassLoadergetClassLoader()The class loader to use.java.util.Optional<java.lang.Boolean>getDeduceEnvironments()java.util.List<java.lang.String>getDefaultEnvironments()java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>>getEagerInitAnnotated()java.util.List<java.lang.String>getEnvironments()java.util.List<java.lang.String>getEnvironmentVariableExcludes()java.util.List<java.lang.String>getEnvironmentVariableIncludes()java.util.List<java.lang.String>getOverrideConfigLocations()The config locations.io.micronaut.core.io.scan.ClassPathResourceLoadergetResourceLoader()The class path resource loader to use.ApplicationContextBuilderinclude(java.lang.String... configurations)Allow customizing the configurations that will be loaded.booleanisAllowEmptyProviders()booleanisBannerEnabled()The banner is enabled by default.java.lang.BooleanisBootstrapEnvironmentEnabled()booleanisEnvironmentPropertySource()ApplicationContextBuildermainClass(java.lang.Class mainClass)The main class used by this application.protected ApplicationContextnewApplicationContext()Creates theApplicationContextinstance.ApplicationContextBuilderoverrideConfigLocations(java.lang.String... configLocations)Override default config locations.ApplicationContextBuilderpackages(java.lang.String... packages)The packages to include for package scanning.ApplicationContextBuilderproperties(java.util.Map<java.lang.String,java.lang.Object> properties)Properties to override from the environment.ApplicationContextBuilderpropertySources(PropertySource... propertySources)Additional property sources.ApplicationContextBuildersingletons(java.lang.Object... beans)Additional singletons to register prior to startup.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface io.micronaut.context.ApplicationContextBuilder
eagerInitConfiguration, eagerInitSingletons, run, start
-
Methods inherited from interface io.micronaut.context.ApplicationContextConfiguration
getConversionService
-
Methods inherited from interface io.micronaut.context.BeanContextConfiguration
isEagerInitConfiguration, isEagerInitSingletons
-
-
-
-
Method Detail
-
isAllowEmptyProviders
public boolean isAllowEmptyProviders()
- Specified by:
isAllowEmptyProvidersin interfaceBeanContextConfiguration- Returns:
- If a
NoSuchBeanExceptionshould be thrown on a missingBeanProviderorProvider
-
eagerInitAnnotated
@NonNull public ApplicationContextBuilder eagerInitAnnotated(java.lang.Class<? extends java.lang.annotation.Annotation>... annotations)
Description copied from interface:ApplicationContextBuilderSpecifies to eager init the given annotated types.- Specified by:
eagerInitAnnotatedin interfaceApplicationContextBuilder- Parameters:
annotations- The annotation stereotypes- Returns:
- The context builder
-
overrideConfigLocations
@NonNull public ApplicationContextBuilder overrideConfigLocations(java.lang.String... configLocations)
Description copied from interface:ApplicationContextBuilderOverride default config locations.- Specified by:
overrideConfigLocationsin interfaceApplicationContextBuilder- Parameters:
configLocations- The config locations- Returns:
- This environment
-
getOverrideConfigLocations
@Nullable public java.util.List<java.lang.String> getOverrideConfigLocations()
Description copied from interface:ApplicationContextConfigurationThe config locations.- Specified by:
getOverrideConfigLocationsin interfaceApplicationContextConfiguration- Returns:
- The config locations
-
isBannerEnabled
public boolean isBannerEnabled()
Description copied from interface:ApplicationContextConfigurationThe banner is enabled by default.- Specified by:
isBannerEnabledin interfaceApplicationContextConfiguration- Returns:
- The banner is enabled by default
-
isBootstrapEnvironmentEnabled
@Nullable public java.lang.Boolean isBootstrapEnvironmentEnabled()
- Specified by:
isBootstrapEnvironmentEnabledin interfaceApplicationContextConfiguration
-
getEagerInitAnnotated
public java.util.Set<java.lang.Class<? extends java.lang.annotation.Annotation>> getEagerInitAnnotated()
- Specified by:
getEagerInitAnnotatedin interfaceBeanContextConfiguration- Returns:
- A set of annotated classes that should be eagerly initialized
-
singletons
@NonNull public ApplicationContextBuilder singletons(java.lang.Object... beans)
Description copied from interface:ApplicationContextBuilderAdditional singletons to register prior to startup.- Specified by:
singletonsin interfaceApplicationContextBuilder- Parameters:
beans- The beans- Returns:
- This builder
-
getResourceLoader
@NonNull public io.micronaut.core.io.scan.ClassPathResourceLoader getResourceLoader()
Description copied from interface:ApplicationContextConfigurationThe class path resource loader to use.- Specified by:
getResourceLoaderin interfaceApplicationContextConfiguration- Returns:
- The classpath resource loader
-
getClassLoader
@NonNull public java.lang.ClassLoader getClassLoader()
Description copied from interface:BeanContextConfigurationThe class loader to use.- Specified by:
getClassLoaderin interfaceBeanContextConfiguration- Returns:
- The class loader.
-
deduceEnvironment
@NonNull public ApplicationContextBuilder deduceEnvironment(@Nullable java.lang.Boolean deduceEnvironments)
Description copied from interface:ApplicationContextBuilderWhether to deduce environments.- Specified by:
deduceEnvironmentin interfaceApplicationContextBuilder- Parameters:
deduceEnvironments- The boolean- Returns:
- This builder
-
environments
@NonNull public ApplicationContextBuilder environments(@Nullable java.lang.String... environments)
Description copied from interface:ApplicationContextBuilderThe environments to use.- Specified by:
environmentsin interfaceApplicationContextBuilder- Parameters:
environments- The environments- Returns:
- This builder
-
defaultEnvironments
@NonNull public ApplicationContextBuilder defaultEnvironments(@Nullable java.lang.String... environments)
Description copied from interface:ApplicationContextBuilderThe environments to use if no other environments are specified.- Specified by:
defaultEnvironmentsin interfaceApplicationContextBuilder- Parameters:
environments- The environments- Returns:
- This builder
-
packages
@NonNull public ApplicationContextBuilder packages(@Nullable java.lang.String... packages)
Description copied from interface:ApplicationContextBuilderThe packages to include for package scanning.- Specified by:
packagesin interfaceApplicationContextBuilder- Parameters:
packages- The packages- Returns:
- This builder
-
properties
@NonNull public ApplicationContextBuilder properties(@Nullable java.util.Map<java.lang.String,java.lang.Object> properties)
Description copied from interface:ApplicationContextBuilderProperties to override from the environment.- Specified by:
propertiesin interfaceApplicationContextBuilder- Parameters:
properties- The properties- Returns:
- This builder
-
propertySources
@NonNull public ApplicationContextBuilder propertySources(@Nullable PropertySource... propertySources)
Description copied from interface:ApplicationContextBuilderAdditional property sources.- Specified by:
propertySourcesin interfaceApplicationContextBuilder- Parameters:
propertySources- The property sources to include- Returns:
- This builder
-
environmentPropertySource
@NonNull public ApplicationContextBuilder environmentPropertySource(boolean environmentPropertySource)
Description copied from interface:ApplicationContextBuilderSet whether environment variables should contribute to configuration.- Specified by:
environmentPropertySourcein interfaceApplicationContextBuilder- Parameters:
environmentPropertySource- The boolean- Returns:
- This builder
-
environmentVariableIncludes
@NonNull public ApplicationContextBuilder environmentVariableIncludes(@Nullable java.lang.String... environmentVariables)
Description copied from interface:ApplicationContextBuilderWhich environment variables should contribute to configuration.- Specified by:
environmentVariableIncludesin interfaceApplicationContextBuilder- Parameters:
environmentVariables- The environment variables- Returns:
- This builder
-
environmentVariableExcludes
@NonNull public ApplicationContextBuilder environmentVariableExcludes(@Nullable java.lang.String... environmentVariables)
Description copied from interface:ApplicationContextBuilderWhich environment variables should not contribute to configuration.- Specified by:
environmentVariableExcludesin interfaceApplicationContextBuilder- Parameters:
environmentVariables- The environment variables- Returns:
- This builder
-
getDeduceEnvironments
public java.util.Optional<java.lang.Boolean> getDeduceEnvironments()
- Specified by:
getDeduceEnvironmentsin interfaceApplicationContextConfiguration- Returns:
- True if the environments should be deduced
-
getEnvironments
@NonNull public java.util.List<java.lang.String> getEnvironments()
- Specified by:
getEnvironmentsin interfaceApplicationContextConfiguration- Returns:
- The environment names
-
getDefaultEnvironments
@NonNull public java.util.List<java.lang.String> getDefaultEnvironments()
- Specified by:
getDefaultEnvironmentsin interfaceApplicationContextConfiguration- Returns:
- The default environments to be applied if no other environments are explicitly specified or deduced.
-
isEnvironmentPropertySource
public boolean isEnvironmentPropertySource()
- Specified by:
isEnvironmentPropertySourcein interfaceApplicationContextConfiguration- Returns:
- True if environment variables should contribute to configuration
-
getEnvironmentVariableIncludes
@Nullable public java.util.List<java.lang.String> getEnvironmentVariableIncludes()
- Specified by:
getEnvironmentVariableIncludesin interfaceApplicationContextConfiguration- Returns:
- The environment variables to include in configuration
-
getEnvironmentVariableExcludes
@Nullable public java.util.List<java.lang.String> getEnvironmentVariableExcludes()
- Specified by:
getEnvironmentVariableExcludesin interfaceApplicationContextConfiguration- Returns:
- The environment variables to exclude from configuration
-
mainClass
@NonNull public ApplicationContextBuilder mainClass(java.lang.Class mainClass)
Description copied from interface:ApplicationContextBuilderThe main class used by this application.- Specified by:
mainClassin interfaceApplicationContextBuilder- Parameters:
mainClass- The main class- Returns:
- This builder
-
classLoader
@NonNull public ApplicationContextBuilder classLoader(java.lang.ClassLoader classLoader)
Description copied from interface:ApplicationContextBuilderThe class loader to be used.- Specified by:
classLoaderin interfaceApplicationContextBuilder- Parameters:
classLoader- The classloader- Returns:
- This builder
-
args
@NonNull public ApplicationContextBuilder args(@Nullable java.lang.String... args)
Description copied from interface:ApplicationContextBuilderSet the command line arguments.- Specified by:
argsin interfaceApplicationContextBuilder- Parameters:
args- The arguments- Returns:
- This application
-
bootstrapEnvironment
@NonNull public ApplicationContextBuilder bootstrapEnvironment(boolean bootstrapEnv)
Description copied from interface:ApplicationContextBuilderSets whether the bootstrap environment should be initialized.- Specified by:
bootstrapEnvironmentin interfaceApplicationContextBuilder- Parameters:
bootstrapEnv- True if it should be initialized. Default true- Returns:
- This application
-
build
@NonNull public ApplicationContext build()
Description copied from interface:ApplicationContextBuilderBuilds theApplicationContext, but does not start it.- Specified by:
buildin interfaceApplicationContextBuilder- Returns:
- The built, but not running
ApplicationContext
-
newApplicationContext
@NonNull protected ApplicationContext newApplicationContext()
Creates theApplicationContextinstance.- Returns:
- The application context
- Since:
- 2.0
-
include
@NonNull public ApplicationContextBuilder include(@Nullable java.lang.String... configurations)
Allow customizing the configurations that will be loaded.- Specified by:
includein interfaceApplicationContextBuilder- Parameters:
configurations- The configurations to include- Returns:
- This application
-
exclude
@NonNull public ApplicationContextBuilder exclude(@Nullable java.lang.String... configurations)
Allow customizing the configurations that will be loaded.- Specified by:
excludein interfaceApplicationContextBuilder- Parameters:
configurations- The configurations to exclude- Returns:
- This application
-
banner
@NonNull public ApplicationContextBuilder banner(boolean isEnabled)
Description copied from interface:ApplicationContextBuilderWhether the banner is enabled or not.- Specified by:
bannerin interfaceApplicationContextBuilder- Parameters:
isEnabled- Whether the banner is enabled or not- Returns:
- This application
-
allowEmptyProviders
@NonNull public ApplicationContextBuilder allowEmptyProviders(boolean shouldAllow)
Description copied from interface:ApplicationContextBuilderWhether to error on an empty bean provider. Defaults tofalse.- Specified by:
allowEmptyProvidersin interfaceApplicationContextBuilder- Parameters:
shouldAllow- True if emptyProviderinstances are allowed- Returns:
- This application
-
-