root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Improve Javadoc for ConfigurableApplicationContext

This commit is contained in:
Sam Brannen 2025-09-18 18:02:59 +02:00
parent cb485b666f
commit 01c8f04d98
1 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
spring-context/src/main/java/org/springframework/context/ConfigurableApplicationContext.java
View File

@ -17,7 +17,6 @@
package org.springframework.context;
import java.io.Closeable;
import java.util.concurrent.Executor;
import org.jspecify.annotations.Nullable;
@ -25,7 +24,6 @@ import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ProtocolResolver;
import org.springframework.core.metrics.ApplicationStartup;
@ -47,8 +45,8 @@ import org.springframework.core.metrics.ApplicationStartup;
public interface ConfigurableApplicationContext extends ApplicationContext, Lifecycle, Closeable {
/**
* Any number of these characters are considered delimiters between
* multiple context config paths in a single String value.
* Any number of these characters are considered delimiters between multiple
* context config paths in a single {@code String} value: {@value}.
* @see org.springframework.context.support.AbstractXmlApplicationContext#setConfigLocation
* @see org.springframework.web.context.ContextLoader#CONFIG_LOCATION_PARAM
* @see org.springframework.web.servlet.FrameworkServlet#setContextConfigLocation
@ -56,8 +54,9 @@ public interface ConfigurableApplicationContext extends ApplicationContext, Life
String CONFIG_LOCATION_DELIMITERS = ",; \t\n";
/**
* The name of the {@link Executor bootstrap executor} bean in the context.
* If none is supplied, no background bootstrapping will be active.
* The name of the {@linkplain java.util.concurrent.Executor bootstrap executor}
* bean in the context: {@value}.
* <p>If none is supplied, no background bootstrapping will be active.
* @since 6.2
* @see java.util.concurrent.Executor
* @see org.springframework.core.task.TaskExecutor
@ -66,48 +65,50 @@ public interface ConfigurableApplicationContext extends ApplicationContext, Life
String BOOTSTRAP_EXECUTOR_BEAN_NAME = "bootstrapExecutor";
/**
* Name of the ConversionService bean in the factory.
* If none is supplied, default conversion rules apply.
* Name of the {@code ConversionService} bean in the factory: {@value}.
* <p>If none is supplied, default conversion rules apply.
* @since 3.0
* @see org.springframework.core.convert.ConversionService
*/
String CONVERSION_SERVICE_BEAN_NAME = "conversionService";
/**
* Name of the LoadTimeWeaver bean in the factory. If such a bean is supplied,
* the context will use a temporary ClassLoader for type matching, in order
* to allow the LoadTimeWeaver to process all actual bean classes.
* Name of the {@code LoadTimeWeaver} bean in the factory: {@value}.
* <p>If such a bean is supplied, the context will use a temporary {@link ClassLoader}
* for type matching, in order to allow the {@code LoadTimeWeaver} to process
* all actual bean classes.
* @since 2.5
* @see org.springframework.instrument.classloading.LoadTimeWeaver
*/
String LOAD_TIME_WEAVER_BEAN_NAME = "loadTimeWeaver";
/**
* Name of the {@link Environment} bean in the factory.
* Name of the {@link org.springframework.core.env.Environment Environment}
* bean in the factory: {@value}.
* @since 3.1
*/
String ENVIRONMENT_BEAN_NAME = "environment";
/**
* Name of the System properties bean in the factory.
* Name of the JVM System properties bean in the factory: {@value}.
* @see java.lang.System#getProperties()
*/
String SYSTEM_PROPERTIES_BEAN_NAME = "systemProperties";
/**
* Name of the System environment bean in the factory.
* Name of the Operating System environment bean in the factory: {@value}.
* @see java.lang.System#getenv()
*/
String SYSTEM_ENVIRONMENT_BEAN_NAME = "systemEnvironment";
/**
* Name of the {@link ApplicationStartup} bean in the factory.
* Name of the {@link ApplicationStartup} bean in the factory: {@value}.
* @since 5.3
*/
String APPLICATION_STARTUP_BEAN_NAME = "applicationStartup";
/**
* {@link Thread#getName() Name} of the {@linkplain #registerShutdownHook()
* {@linkplain Thread#getName() Name} of the {@linkplain #registerShutdownHook()
* shutdown hook} thread: {@value}.
* @since 5.2
* @see #registerShutdownHook()
@ -116,7 +117,7 @@ public interface ConfigurableApplicationContext extends ApplicationContext, Life
/**
* Set the unique id of this application context.
* Set the unique ID of this application context.
* @since 3.0
*/
void setId(String id);