spring-boot/org.springframework.boot.builder/SpringApplicationBuilder

SpringApplicationBuilder

Builder for SpringApplication and ApplicationContext instances with convenient fluent API and context hierarchy support. Simple example of a context hierarchy:

new SpringApplicationBuilder(ParentConfig.class).child(ChildConfig.class).run(args);

Another common use case is setting active profiles and default properties to set up the environment for an application:

new SpringApplicationBuilder(Application.class).profiles("server")
		.properties("transport=local").run(args);

If your needs are simpler, consider using the static convenience methods in SpringApplication instead.

Author

Dave Syer

Andy Wilkinson

Since

1.0.0

Constructors

SpringApplicationBuilder

constructor(sources: Array<Class<out Any>>)

constructor(resourceLoader: ResourceLoader, sources: Array<Class<out Any>>)

Functions

addBootstrapRegistryInitializer

open fun addBootstrapRegistryInitializer(bootstrapRegistryInitializer: BootstrapRegistryInitializer): SpringApplicationBuilder

Adds BootstrapRegistryInitializer instances that can be used to initialize the BootstrapRegistry.

addCommandLineProperties

open fun addCommandLineProperties(addCommandLineProperties: Boolean): SpringApplicationBuilder

Flag to indicate that command line arguments should be added to the environment.

allowCircularReferences

open fun allowCircularReferences(allowCircularReferences: Boolean): SpringApplicationBuilder

Whether to allow circular references between beans and automatically try to resolve them.

application

open fun application(): SpringApplication

Accessor for the current application.

applicationStartup

open fun applicationStartup(applicationStartup: ApplicationStartup): SpringApplicationBuilder

Configure the ApplicationStartup to be used with the ApplicationContext for collecting startup metrics.

banner

open fun banner(banner: Banner): SpringApplicationBuilder

Sets the Banner instance which will be used to print the banner when no static banner file is provided.

bannerMode

open fun bannerMode(bannerMode: Banner.Mode): SpringApplicationBuilder

beanNameGenerator

open fun beanNameGenerator(beanNameGenerator: BeanNameGenerator): SpringApplicationBuilder

Bean name generator for automatically generated bean names in the application context.

build

open fun build(): SpringApplication

open fun build(args: Array<String>): SpringApplication

Returns a fully configured SpringApplication that is ready to run.

child

open fun child(sources: Array<Class<out Any>>): SpringApplicationBuilder

Create a child application with the provided sources.

context

open fun context(): ConfigurableApplicationContext

Accessor for the current application context.

contextFactory

open fun contextFactory(factory: ApplicationContextFactory): SpringApplicationBuilder

Explicitly set the factory used to create the application context.

environment

open fun environment(environment: ConfigurableEnvironment): SpringApplicationBuilder

Environment for the application context.

environmentPrefix

open fun environmentPrefix(environmentPrefix: String): SpringApplicationBuilder

Prefix that should be applied when obtaining configuration properties from the system environment.

headless

open fun headless(headless: Boolean): SpringApplicationBuilder

Sets if the application is headless and should not instantiate AWT.

initializers

open fun initializers(initializers: Array<ApplicationContextInitializer<out Any>>): SpringApplicationBuilder

Add some initializers to the application (applied to the ApplicationContext before any bean definitions are loaded).

lazyInitialization

open fun lazyInitialization(lazyInitialization: Boolean): SpringApplicationBuilder

Flag to control whether the application should be initialized lazily.

listeners

open fun listeners(listeners: Array<ApplicationListener<out Any>>): SpringApplicationBuilder

Add some listeners to the application (listening for SpringApplication events as well as regular Spring events once the context is running).

logStartupInfo

open fun logStartupInfo(logStartupInfo: Boolean): SpringApplicationBuilder

Flag to indicate the startup information should be logged.

main

open fun main(mainApplicationClass: Class<out Any>): SpringApplicationBuilder

Fixes the main application class that is used to anchor the startup messages.

parent

open fun parent(sources: Array<Class<out Any>>): SpringApplicationBuilder

Add a parent application with the provided sources.

open fun parent(parent: ConfigurableApplicationContext): SpringApplicationBuilder

Add an already running parent context to an existing application.

profiles

open fun profiles(profiles: Array<String>): SpringApplicationBuilder

Add to the active Spring profiles for this app (and its parent and children).

properties

open fun properties(defaultProperties: Array<String>): SpringApplicationBuilder

Default properties for the environment in the form key=value or key:value.

open fun properties(defaults: Map<String, Any>): SpringApplicationBuilder

Default properties for the environment.

open fun properties(defaultProperties: Properties): SpringApplicationBuilder

Default properties for the environment.Multiple calls to this method are cumulative and will not clear any previously set properties.

registerShutdownHook

open fun registerShutdownHook(registerShutdownHook: Boolean): SpringApplicationBuilder

Sets if the created ApplicationContext should have a shutdown hook registered.

resourceLoader

open fun resourceLoader(resourceLoader: ResourceLoader): SpringApplicationBuilder

ResourceLoader for the application context.

run

open fun run(args: Array<String>): ConfigurableApplicationContext

Create an application context (and its parent if specified) with the command line args provided.

setAddConversionService

open fun setAddConversionService(addConversionService: Boolean): SpringApplicationBuilder

Flag to indicate if the ApplicationConversionService should be added to the application context's Environment.

sibling

open fun sibling(sources: Array<Class<out Any>>): SpringApplicationBuilder

open fun sibling(sources: Array<Class<out Any>>, args: Array<String>): SpringApplicationBuilder

Create a sibling application (one with the same parent).

sources

open fun sources(sources: Array<Class<out Any>>): SpringApplicationBuilder

Add more sources (configuration classes and components) to this application.

web

open fun web(webApplicationType: WebApplicationType): SpringApplicationBuilder

Flag to explicitly request a specific type of web application.

SpringApplicationBuilder

Author

Since

See also

Constructors

Functions