Skip to content

Commit 57b4b74

Browse files
committed
Polish Javadoc for JMX factory beans
1 parent 3b724c7 commit 57b4b74

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

spring-context/src/main/java/org/springframework/jmx/support/ConnectorServerFactoryBean.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -39,13 +39,13 @@
3939

4040
/**
4141
* {@link FactoryBean} that creates a JSR-160 {@link JMXConnectorServer},
42-
* optionally registers it with the {@link MBeanServer} and then starts it.
42+
* optionally registers it with the {@link MBeanServer}, and then starts it.
4343
*
4444
* <p>The {@code JMXConnectorServer} can be started in a separate thread by setting the
4545
* {@code threaded} property to {@code true}. You can configure this thread to be a
4646
* daemon thread by setting the {@code daemon} property to {@code true}.
4747
*
48-
* <p>The {@code JMXConnectorServer} is correctly shutdown when an instance of this
48+
* <p>The {@code JMXConnectorServer} is correctly shut down when an instance of this
4949
* class is destroyed on shutdown of the containing {@code ApplicationContext}.
5050
*
5151
* @author Rob Harrop

spring-context/src/main/java/org/springframework/jmx/support/MBeanServerConnectionFactoryBean.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2018 the original author or authors.
2+
* Copyright 2002-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -101,7 +101,8 @@ public void setEnvironmentMap(@Nullable Map<String, ?> environment) {
101101
}
102102

103103
/**
104-
* Set whether to connect to the server on startup. Default is "true".
104+
* Set whether to connect to the server on startup.
105+
* <p>Default is {@code true}.
105106
* <p>Can be turned off to allow for late start of the JMX server.
106107
* In this case, the JMX connector will be fetched on first access.
107108
*/

spring-context/src/main/java/org/springframework/jmx/support/MBeanServerFactoryBean.java

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2017 the original author or authors.
2+
* Copyright 2002-2019 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -29,10 +29,11 @@
2929
import org.springframework.lang.Nullable;
3030

3131
/**
32-
* {@link FactoryBean} that obtains an {@link javax.management.MBeanServer} reference
32+
* {@link FactoryBean} that obtains a {@link javax.management.MBeanServer} reference
3333
* through the standard JMX 1.2 {@link javax.management.MBeanServerFactory}
34-
* API (which is available on JDK 1.5 or as part of a JMX 1.2 provider).
35-
* Exposes the {@code MBeanServer} for bean references.
34+
* API.
35+
*
36+
* <p>Exposes the {@code MBeanServer} for bean references.
3637
*
3738
* <p>By default, {@code MBeanServerFactoryBean} will always create
3839
* a new {@code MBeanServer} even if one is already running. To have
@@ -111,6 +112,7 @@ public void setDefaultDomain(String defaultDomain) {
111112
* Set whether to register the {@code MBeanServer} with the
112113
* {@code MBeanServerFactory}, making it available through
113114
* {@code MBeanServerFactory.findMBeanServer()}.
115+
* <p>Default is {@code true}.
114116
* @see javax.management.MBeanServerFactory#createMBeanServer
115117
* @see javax.management.MBeanServerFactory#findMBeanServer
116118
*/

0 commit comments

Comments
 (0)