Skip to content

Commit 01c8f04

Browse files
committed
Improve Javadoc for ConfigurableApplicationContext
1 parent cb485b6 commit 01c8f04

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

spring-context/src/main/java/org/springframework/context/ConfigurableApplicationContext.java

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,13 @@
1717
package org.springframework.context;
1818

1919
import java.io.Closeable;
20-
import java.util.concurrent.Executor;
2120

2221
import org.jspecify.annotations.Nullable;
2322

2423
import org.springframework.beans.BeansException;
2524
import org.springframework.beans.factory.config.BeanFactoryPostProcessor;
2625
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
2726
import org.springframework.core.env.ConfigurableEnvironment;
28-
import org.springframework.core.env.Environment;
2927
import org.springframework.core.io.ProtocolResolver;
3028
import org.springframework.core.metrics.ApplicationStartup;
3129

@@ -47,17 +45,18 @@
4745
public interface ConfigurableApplicationContext extends ApplicationContext, Lifecycle, Closeable {
4846

4947
/**
50-
* Any number of these characters are considered delimiters between
51-
* multiple context config paths in a single String value.
48+
* Any number of these characters are considered delimiters between multiple
49+
* context config paths in a single {@code String} value: {@value}.
5250
* @see org.springframework.context.support.AbstractXmlApplicationContext#setConfigLocation
5351
* @see org.springframework.web.context.ContextLoader#CONFIG_LOCATION_PARAM
5452
* @see org.springframework.web.servlet.FrameworkServlet#setContextConfigLocation
5553
*/
5654
String CONFIG_LOCATION_DELIMITERS = ",; \t\n";
5755

5856
/**
59-
* The name of the {@link Executor bootstrap executor} bean in the context.
60-
* If none is supplied, no background bootstrapping will be active.
57+
* The name of the {@linkplain java.util.concurrent.Executor bootstrap executor}
58+
* bean in the context: {@value}.
59+
* <p>If none is supplied, no background bootstrapping will be active.
6160
* @since 6.2
6261
* @see java.util.concurrent.Executor
6362
* @see org.springframework.core.task.TaskExecutor
@@ -66,48 +65,50 @@ public interface ConfigurableApplicationContext extends ApplicationContext, Life
6665
String BOOTSTRAP_EXECUTOR_BEAN_NAME = "bootstrapExecutor";
6766

6867
/**
69-
* Name of the ConversionService bean in the factory.
70-
* If none is supplied, default conversion rules apply.
68+
* Name of the {@code ConversionService} bean in the factory: {@value}.
69+
* <p>If none is supplied, default conversion rules apply.
7170
* @since 3.0
7271
* @see org.springframework.core.convert.ConversionService
7372
*/
7473
String CONVERSION_SERVICE_BEAN_NAME = "conversionService";
7574

7675
/**
77-
* Name of the LoadTimeWeaver bean in the factory. If such a bean is supplied,
78-
* the context will use a temporary ClassLoader for type matching, in order
79-
* to allow the LoadTimeWeaver to process all actual bean classes.
76+
* Name of the {@code LoadTimeWeaver} bean in the factory: {@value}.
77+
* <p>If such a bean is supplied, the context will use a temporary {@link ClassLoader}
78+
* for type matching, in order to allow the {@code LoadTimeWeaver} to process
79+
* all actual bean classes.
8080
* @since 2.5
8181
* @see org.springframework.instrument.classloading.LoadTimeWeaver
8282
*/
8383
String LOAD_TIME_WEAVER_BEAN_NAME = "loadTimeWeaver";
8484

8585
/**
86-
* Name of the {@link Environment} bean in the factory.
86+
* Name of the {@link org.springframework.core.env.Environment Environment}
87+
* bean in the factory: {@value}.
8788
* @since 3.1
8889
*/
8990
String ENVIRONMENT_BEAN_NAME = "environment";
9091

9192
/**
92-
* Name of the System properties bean in the factory.
93+
* Name of the JVM System properties bean in the factory: {@value}.
9394
* @see java.lang.System#getProperties()
9495
*/
9596
String SYSTEM_PROPERTIES_BEAN_NAME = "systemProperties";
9697

9798
/**
98-
* Name of the System environment bean in the factory.
99+
* Name of the Operating System environment bean in the factory: {@value}.
99100
* @see java.lang.System#getenv()
100101
*/
101102
String SYSTEM_ENVIRONMENT_BEAN_NAME = "systemEnvironment";
102103

103104
/**
104-
* Name of the {@link ApplicationStartup} bean in the factory.
105+
* Name of the {@link ApplicationStartup} bean in the factory: {@value}.
105106
* @since 5.3
106107
*/
107108
String APPLICATION_STARTUP_BEAN_NAME = "applicationStartup";
108109

109110
/**
110-
* {@link Thread#getName() Name} of the {@linkplain #registerShutdownHook()
111+
* {@linkplain Thread#getName() Name} of the {@linkplain #registerShutdownHook()
111112
* shutdown hook} thread: {@value}.
112113
* @since 5.2
113114
* @see #registerShutdownHook()
@@ -116,7 +117,7 @@ public interface ConfigurableApplicationContext extends ApplicationContext, Life
116117

117118

118119
/**
119-
* Set the unique id of this application context.
120+
* Set the unique ID of this application context.
120121
* @since 3.0
121122
*/
122123
void setId(String id);

0 commit comments

Comments
 (0)