SpringApplicationBuilder (Spring Boot 2.6.10 API)

java.lang.Object
- org.springframework.boot.builder.SpringApplicationBuilder

```
public class SpringApplicationBuilder
extends Object
```
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.
Since:

1.0.0

Author:

Dave Syer, Andy Wilkinson

See Also:

SpringApplication

Constructor Summary

Constructors
Constructor and Description
`SpringApplicationBuilder(Class<?>... sources)`
`SpringApplicationBuilder(ResourceLoader resourceLoader, Class<?>... sources)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SpringApplicationBuilder`	`addBootstrapRegistryInitializer(BootstrapRegistryInitializer bootstrapRegistryInitializer)` Adds `BootstrapRegistryInitializer` instances that can be used to initialize the `BootstrapRegistry`.
`SpringApplicationBuilder`	`addCommandLineProperties(boolean addCommandLineProperties)` Flag to indicate that command line arguments should be added to the environment.
`SpringApplicationBuilder`	`allowCircularReferences(boolean allowCircularReferences)` Whether to allow circular references between beans and automatically try to resolve them.
`SpringApplication`	`application()` Accessor for the current application.
`SpringApplicationBuilder`	`applicationStartup(ApplicationStartup applicationStartup)` Configure the `ApplicationStartup` to be used with the `ApplicationContext` for collecting startup metrics.
`SpringApplicationBuilder`	`banner(Banner banner)` Sets the `Banner` instance which will be used to print the banner when no static banner file is provided.
`SpringApplicationBuilder`	`bannerMode(Banner.Mode bannerMode)`
`SpringApplicationBuilder`	`beanNameGenerator(BeanNameGenerator beanNameGenerator)` Bean name generator for automatically generated bean names in the application context.
`SpringApplication`	`build()` Returns a fully configured `SpringApplication` that is ready to run.
`SpringApplication`	`build(String... args)` Returns a fully configured `SpringApplication` that is ready to run.
`SpringApplicationBuilder`	`child(Class<?>... sources)` Create a child application with the provided sources.
`ConfigurableApplicationContext`	`context()` Accessor for the current application context.
`SpringApplicationBuilder`	`contextFactory(ApplicationContextFactory factory)` Explicitly set the factory used to create the application context.
`protected SpringApplication`	`createSpringApplication(Class<?>... sources)` Deprecated. since 2.6.0 for removal in 3.0.0 in favor of `createSpringApplication(ResourceLoader, Class...)`
`protected SpringApplication`	`createSpringApplication(ResourceLoader resourceLoader, Class<?>... sources)` Creates a new `SpringApplication` instance from the given sources using the given `ResourceLoader`.
`SpringApplicationBuilder`	`environment(ConfigurableEnvironment environment)` Environment for the application context.
`SpringApplicationBuilder`	`environmentPrefix(String environmentPrefix)` Prefix that should be applied when obtaining configuration properties from the system environment.
`SpringApplicationBuilder`	`headless(boolean headless)` Sets if the application is headless and should not instantiate AWT.
`SpringApplicationBuilder`	`initializers(ApplicationContextInitializer<?>... initializers)` Add some initializers to the application (applied to the `ApplicationContext` before any bean definitions are loaded).
`SpringApplicationBuilder`	`lazyInitialization(boolean lazyInitialization)` Flag to control whether the application should be initialized lazily.
`SpringApplicationBuilder`	`listeners(ApplicationListener<?>... listeners)` Add some listeners to the application (listening for SpringApplication events as well as regular Spring events once the context is running).
`SpringApplicationBuilder`	`logStartupInfo(boolean logStartupInfo)` Flag to indicate the startup information should be logged.
`SpringApplicationBuilder`	`main(Class<?> mainApplicationClass)` Fixes the main application class that is used to anchor the startup messages.
`SpringApplicationBuilder`	`parent(Class<?>... sources)` Add a parent application with the provided sources.
`SpringApplicationBuilder`	`parent(ConfigurableApplicationContext parent)` Add an already running parent context to an existing application.
`SpringApplicationBuilder`	`profiles(String... profiles)` Add to the active Spring profiles for this app (and its parent and children).
`SpringApplicationBuilder`	`properties(Map<String,Object> defaults)` Default properties for the environment.
`SpringApplicationBuilder`	`properties(Properties defaultProperties)` Default properties for the environment.Multiple calls to this method are cumulative and will not clear any previously set properties.
`SpringApplicationBuilder`	`properties(String... defaultProperties)` Default properties for the environment in the form `key=value` or `key:value`.
`SpringApplicationBuilder`	`registerShutdownHook(boolean registerShutdownHook)` Sets if the created `ApplicationContext` should have a shutdown hook registered.
`SpringApplicationBuilder`	`resourceLoader(ResourceLoader resourceLoader)` `ResourceLoader` for the application context.
`ConfigurableApplicationContext`	`run(String... args)` Create an application context (and its parent if specified) with the command line args provided.
`SpringApplicationBuilder`	`setAddConversionService(boolean addConversionService)` Flag to indicate if the `ApplicationConversionService` should be added to the application context's `Environment`.
`SpringApplicationBuilder`	`sibling(Class<?>... sources)` Create a sibling application (one with the same parent).
`SpringApplicationBuilder`	`sibling(Class<?>[] sources, String... args)` Create a sibling application (one with the same parent).
`SpringApplicationBuilder`	`sources(Class<?>... sources)` Add more sources (configuration classes and components) to this application.
`SpringApplicationBuilder`	`web(WebApplicationType webApplicationType)` Flag to explicitly request a specific type of web application.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SpringApplicationBuilder
```
public SpringApplicationBuilder(Class<?>... sources)
```
  - SpringApplicationBuilder
```
public SpringApplicationBuilder(ResourceLoader resourceLoader,
                                Class<?>... sources)
```
- Method Detail
  - createSpringApplication
```
@Deprecated
protected SpringApplication createSpringApplication(Class<?>... sources)
```
    Deprecated. since 2.6.0 for removal in 3.0.0 in favor of createSpringApplication(ResourceLoader, Class...)
    
    Creates a new SpringApplication instance from the given sources. Subclasses may override in order to provide a custom subclass of SpringApplication.
    
    Parameters:
    
    sources - the sources
    
    Returns:
    
    the SpringApplication instance
    
    Since:
    
    1.1.0
  - createSpringApplication
```
protected SpringApplication createSpringApplication(ResourceLoader resourceLoader,
                                                    Class<?>... sources)
```
    Creates a new SpringApplication instance from the given sources using the given ResourceLoader. Subclasses may override in order to provide a custom subclass of SpringApplication.
    
    Parameters:
    
    resourceLoader - the resource loader (can be null)
    
    sources - the sources
    
    Returns:
    
    the SpringApplication instance
    
    Since:
    
    2.6.0
  - context
```
public ConfigurableApplicationContext context()
```
    Accessor for the current application context.
    
    Returns:
    
    the current application context (or null if not yet running)
  - application
```
public SpringApplication application()
```
    Accessor for the current application.
    
    Returns:
    
    the current application (never null)
  - run
```
public ConfigurableApplicationContext run(String... args)
```
    Create an application context (and its parent if specified) with the command line args provided. The parent is run first with the same arguments if has not yet been started.
    
    Parameters:
    
    args - the command line arguments
    
    Returns:
    
    an application context created from the current state
  - build
```
public SpringApplication build()
```
    Returns a fully configured SpringApplication that is ready to run.
    
    Returns:
    
    the fully configured SpringApplication.
  - build
```
public SpringApplication build(String... args)
```
    Returns a fully configured SpringApplication that is ready to run. Any parent that has been configured will be run with the given args.
    
    Parameters:
    
    args - the parent's args
    
    Returns:
    
    the fully configured SpringApplication.
  - child
```
public SpringApplicationBuilder child(Class<?>... sources)
```
    Create a child application with the provided sources. Default args and environment are copied down into the child, but everything else is a clean sheet.
    
    Parameters:
    
    sources - the sources for the application (Spring configuration)
    
    Returns:
    
    the child application builder
  - parent
```
public SpringApplicationBuilder parent(Class<?>... sources)
```
    Add a parent application with the provided sources. Default args and environment are copied up into the parent, but everything else is a clean sheet.
    
    Parameters:
    
    sources - the sources for the application (Spring configuration)
    
    Returns:
    
    the parent builder
  - parent
```
public SpringApplicationBuilder parent(ConfigurableApplicationContext parent)
```
    Add an already running parent context to an existing application.
    
    Parameters:
    
    parent - the parent context
    
    Returns:
    
    the current builder (not the parent)
  - sibling
```
public SpringApplicationBuilder sibling(Class<?>... sources)
```
    Create a sibling application (one with the same parent). A side effect of calling this method is that the current application (and its parent) are started without any arguments if they are not already running. To supply arguments when starting the current application and its parent use sibling(Class[], String...) instead.
    
    Parameters:
    
    sources - the sources for the application (Spring configuration)
    
    Returns:
    
    the new sibling builder
  - sibling
```
public SpringApplicationBuilder sibling(Class<?>[] sources,
                                        String... args)
```
    Create a sibling application (one with the same parent). A side effect of calling this method is that the current application (and its parent) are started if they are not already running.
    
    Parameters:
    
    sources - the sources for the application (Spring configuration)
    
    args - the command line arguments to use when starting the current app and its parent
    
    Returns:
    
    the new sibling builder
  - contextFactory
```
public SpringApplicationBuilder contextFactory(ApplicationContextFactory factory)
```
    Explicitly set the factory used to create the application context.
    
    Parameters:
    
    factory - the factory to use
    
    Returns:
    
    the current builder
    
    Since:
    
    2.4.0
  - sources
```
public SpringApplicationBuilder sources(Class<?>... sources)
```
    Add more sources (configuration classes and components) to this application.
    
    Parameters:
    
    sources - the sources to add
    
    Returns:
    
    the current builder
  - web
```
public SpringApplicationBuilder web(WebApplicationType webApplicationType)
```
    Flag to explicitly request a specific type of web application. Auto-detected based on the classpath if not set.
    
    Parameters:
    
    webApplicationType - the type of web application
    
    Returns:
    
    the current builder
    
    Since:
    
    2.0.0
  - logStartupInfo
```
public SpringApplicationBuilder logStartupInfo(boolean logStartupInfo)
```
    Flag to indicate the startup information should be logged.
    
    Parameters:
    
    logStartupInfo - the flag to set. Default true.
    
    Returns:
    
    the current builder
  - banner
```
public SpringApplicationBuilder banner(Banner banner)
```
    Sets the Banner instance which will be used to print the banner when no static banner file is provided.
    
    Parameters:
    
    banner - the banner to use
    
    Returns:
    
    the current builder
  - bannerMode
```
public SpringApplicationBuilder bannerMode(Banner.Mode bannerMode)
```
  - headless
```
public SpringApplicationBuilder headless(boolean headless)
```
    Sets if the application is headless and should not instantiate AWT. Defaults to true to prevent java icons appearing.
    
    Parameters:
    
    headless - if the application is headless
    
    Returns:
    
    the current builder
  - registerShutdownHook
```
public SpringApplicationBuilder registerShutdownHook(boolean registerShutdownHook)
```
    Sets if the created ApplicationContext should have a shutdown hook registered.
    
    Parameters:
    
    registerShutdownHook - if the shutdown hook should be registered
    
    Returns:
    
    the current builder
  - main
```
public SpringApplicationBuilder main(Class<?> mainApplicationClass)
```
    Fixes the main application class that is used to anchor the startup messages.
    
    Parameters:
    
    mainApplicationClass - the class to use.
    
    Returns:
    
    the current builder
  - addCommandLineProperties
```
public SpringApplicationBuilder addCommandLineProperties(boolean addCommandLineProperties)
```
    Flag to indicate that command line arguments should be added to the environment.
    
    Parameters:
    
    addCommandLineProperties - the flag to set. Default true.
    
    Returns:
    
    the current builder
  - setAddConversionService
```
public SpringApplicationBuilder setAddConversionService(boolean addConversionService)
```
    Flag to indicate if the ApplicationConversionService should be added to the application context's Environment.
    
    Parameters:
    
    addConversionService - if the conversion service should be added.
    
    Returns:
    
    the current builder
    
    Since:
    
    2.1.0
  - addBootstrapRegistryInitializer
```
public SpringApplicationBuilder addBootstrapRegistryInitializer(BootstrapRegistryInitializer bootstrapRegistryInitializer)
```
    Adds BootstrapRegistryInitializer instances that can be used to initialize the BootstrapRegistry.
    
    Parameters:
    
    bootstrapRegistryInitializer - the bootstrap registry initializer to add
    
    Returns:
    
    the current builder
    
    Since:
    
    2.4.5
  - lazyInitialization
```
public SpringApplicationBuilder lazyInitialization(boolean lazyInitialization)
```
    Flag to control whether the application should be initialized lazily.
    
    Parameters:
    
    lazyInitialization - the flag to set. Defaults to false.
    
    Returns:
    
    the current builder
    
    Since:
    
    2.2
  - properties
```
public SpringApplicationBuilder properties(String... defaultProperties)
```
    Default properties for the environment in the form key=value or key:value. Multiple calls to this method are cumulative and will not clear any previously set properties.
    
    Parameters:
    
    defaultProperties - the properties to set.
    
    Returns:
    
    the current builder
    
    See Also:
    
    properties(Properties), properties(Map)
  - properties
```
public SpringApplicationBuilder properties(Properties defaultProperties)
```
    Default properties for the environment.Multiple calls to this method are cumulative and will not clear any previously set properties.
    
    Parameters:
    
    defaultProperties - the properties to set.
    
    Returns:
    
    the current builder
    
    See Also:
    
    properties(String...), properties(Map)
  - properties
```
public SpringApplicationBuilder properties(Map<String,Object> defaults)
```
    Default properties for the environment. Multiple calls to this method are cumulative and will not clear any previously set properties.
    
    Parameters:
    
    defaults - the default properties
    
    Returns:
    
    the current builder
    
    See Also:
    
    properties(String...), properties(Properties)
  - profiles
```
public SpringApplicationBuilder profiles(String... profiles)
```
    Add to the active Spring profiles for this app (and its parent and children).
    
    Parameters:
    
    profiles - the profiles to add.
    
    Returns:
    
    the current builder
  - beanNameGenerator
```
public SpringApplicationBuilder beanNameGenerator(BeanNameGenerator beanNameGenerator)
```
    Bean name generator for automatically generated bean names in the application context.
    
    Parameters:
    
    beanNameGenerator - the generator to set.
    
    Returns:
    
    the current builder
  - environment
```
public SpringApplicationBuilder environment(ConfigurableEnvironment environment)
```
    Environment for the application context.
    
    Parameters:
    
    environment - the environment to set.
    
    Returns:
    
    the current builder
  - environmentPrefix
```
public SpringApplicationBuilder environmentPrefix(String environmentPrefix)
```
    Prefix that should be applied when obtaining configuration properties from the system environment.
    
    Parameters:
    
    environmentPrefix - the environment property prefix to set
    
    Returns:
    
    the current builder
    
    Since:
    
    2.5.0
  - resourceLoader
```
public SpringApplicationBuilder resourceLoader(ResourceLoader resourceLoader)
```
    ResourceLoader for the application context. If a custom class loader is needed, this is where it would be added.
    
    Parameters:
    
    resourceLoader - the resource loader to set.
    
    Returns:
    
    the current builder
  - initializers
```
public SpringApplicationBuilder initializers(ApplicationContextInitializer<?>... initializers)
```
    Add some initializers to the application (applied to the ApplicationContext before any bean definitions are loaded).
    
    Parameters:
    
    initializers - some initializers to add
    
    Returns:
    
    the current builder
  - listeners
```
public SpringApplicationBuilder listeners(ApplicationListener<?>... listeners)
```
    Add some listeners to the application (listening for SpringApplication events as well as regular Spring events once the context is running). Any listeners that are also ApplicationContextInitializer will be added to the initializers automatically.
    
    Parameters:
    
    listeners - some listeners to add
    
    Returns:
    
    the current builder
  - applicationStartup
```
public SpringApplicationBuilder applicationStartup(ApplicationStartup applicationStartup)
```
    Configure the ApplicationStartup to be used with the ApplicationContext for collecting startup metrics.
    
    Parameters:
    
    applicationStartup - the application startup to use
    
    Returns:
    
    the current builder
    
    Since:
    
    2.4.0
  - allowCircularReferences
```
public SpringApplicationBuilder allowCircularReferences(boolean allowCircularReferences)
```
    Whether to allow circular references between beans and automatically try to resolve them.
    
    Parameters:
    
    allowCircularReferences - whether circular references are allowed
    
    Returns:
    
    the current builder
    
    Since:
    
    2.6.0
    
    See Also:
    
    AbstractAutowireCapableBeanFactory.setAllowCircularReferences(boolean)

Class SpringApplicationBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SpringApplicationBuilder

SpringApplicationBuilder

Method Detail

createSpringApplication

createSpringApplication

context

application

run

build

build

child

parent

parent

sibling

sibling

contextFactory

sources

web

logStartupInfo

banner

bannerMode

headless

registerShutdownHook

main

addCommandLineProperties

setAddConversionService

addBootstrapRegistryInitializer

lazyInitialization

properties

properties

properties

profiles

beanNameGenerator

environment

environmentPrefix

resourceLoader

initializers

listeners

applicationStartup

allowCircularReferences