From 57b4b74e7dbbecb4905f3751e567c8f305be5cd6 Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Thu, 31 Oct 2019 13:55:13 +0100 Subject: [PATCH] Polish Javadoc for JMX factory beans --- .../jmx/support/ConnectorServerFactoryBean.java | 6 +++--- .../jmx/support/MBeanServerConnectionFactoryBean.java | 5 +++-- .../jmx/support/MBeanServerFactoryBean.java | 10 ++++++---- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/spring-context/src/main/java/org/springframework/jmx/support/ConnectorServerFactoryBean.java b/spring-context/src/main/java/org/springframework/jmx/support/ConnectorServerFactoryBean.java index da18cf52b4..c02f5fbca1 100644 --- a/spring-context/src/main/java/org/springframework/jmx/support/ConnectorServerFactoryBean.java +++ b/spring-context/src/main/java/org/springframework/jmx/support/ConnectorServerFactoryBean.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -39,13 +39,13 @@ import org.springframework.util.CollectionUtils; /** * {@link FactoryBean} that creates a JSR-160 {@link JMXConnectorServer}, - * optionally registers it with the {@link MBeanServer} and then starts it. + * optionally registers it with the {@link MBeanServer}, and then starts it. * *

The {@code JMXConnectorServer} can be started in a separate thread by setting the * {@code threaded} property to {@code true}. You can configure this thread to be a * daemon thread by setting the {@code daemon} property to {@code true}. * - *

The {@code JMXConnectorServer} is correctly shutdown when an instance of this + *

The {@code JMXConnectorServer} is correctly shut down when an instance of this * class is destroyed on shutdown of the containing {@code ApplicationContext}. * * @author Rob Harrop diff --git a/spring-context/src/main/java/org/springframework/jmx/support/MBeanServerConnectionFactoryBean.java b/spring-context/src/main/java/org/springframework/jmx/support/MBeanServerConnectionFactoryBean.java index 4cbdd433be..64258d7119 100644 --- a/spring-context/src/main/java/org/springframework/jmx/support/MBeanServerConnectionFactoryBean.java +++ b/spring-context/src/main/java/org/springframework/jmx/support/MBeanServerConnectionFactoryBean.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2018 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -101,7 +101,8 @@ public class MBeanServerConnectionFactoryBean } /** - * Set whether to connect to the server on startup. Default is "true". + * Set whether to connect to the server on startup. + *

Default is {@code true}. *

Can be turned off to allow for late start of the JMX server. * In this case, the JMX connector will be fetched on first access. */ diff --git a/spring-context/src/main/java/org/springframework/jmx/support/MBeanServerFactoryBean.java b/spring-context/src/main/java/org/springframework/jmx/support/MBeanServerFactoryBean.java index 8dc0fc580b..d47626d358 100644 --- a/spring-context/src/main/java/org/springframework/jmx/support/MBeanServerFactoryBean.java +++ b/spring-context/src/main/java/org/springframework/jmx/support/MBeanServerFactoryBean.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2017 the original author or authors. + * Copyright 2002-2019 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -29,10 +29,11 @@ import org.springframework.jmx.MBeanServerNotFoundException; import org.springframework.lang.Nullable; /** - * {@link FactoryBean} that obtains an {@link javax.management.MBeanServer} reference + * {@link FactoryBean} that obtains a {@link javax.management.MBeanServer} reference * through the standard JMX 1.2 {@link javax.management.MBeanServerFactory} - * API (which is available on JDK 1.5 or as part of a JMX 1.2 provider). - * Exposes the {@code MBeanServer} for bean references. + * API. + * + *

Exposes the {@code MBeanServer} for bean references. * *

By default, {@code MBeanServerFactoryBean} will always create * a new {@code MBeanServer} even if one is already running. To have @@ -111,6 +112,7 @@ public class MBeanServerFactoryBean implements FactoryBean, Initial * Set whether to register the {@code MBeanServer} with the * {@code MBeanServerFactory}, making it available through * {@code MBeanServerFactory.findMBeanServer()}. + *

Default is {@code true}. * @see javax.management.MBeanServerFactory#createMBeanServer * @see javax.management.MBeanServerFactory#findMBeanServer */ -- GitLab