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

Document semantics for externally managed init/destroy methods 

This commit introduces Javadoc to explain the difference between
init/destroy method names when such methods are private, namely that a
private method is registered via its qualified method name; whereas, a
non-private method is registered via its simple name.

See gh-28083
This commit is contained in:
Sam Brannen 2022-03-01 16:18:46 +01:00
parent dcdea986f6
commit d67034f99b
1 changed files with 39 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
spring-beans/src/main/java/org/springframework/beans/factory/support/RootBeanDefinition.java
View File

@ -437,7 +437,7 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
} }
/** /**
* Check whether the given method or field is an externally managed configuration member. * Determine if the given method or field is an externally managed configuration member.
*/ */
public boolean isExternallyManagedConfigMember(Member configMember) { public boolean isExternallyManagedConfigMember(Member configMember) {
synchronized (this.postProcessingLock) { synchronized (this.postProcessingLock) {
@ -447,7 +447,7 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
} }
/** /**
* Return all externally managed configuration methods and fields (as an immutable Set). * Get all externally managed configuration methods and fields (as an immutable Set).
* @since 5.3.11 * @since 5.3.11
*/ */
public Set<Member> getExternallyManagedConfigMembers() { public Set<Member> getExternallyManagedConfigMembers() {
@ -459,7 +459,15 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
} }
/** /**
* Register an externally managed configuration initialization method. * Register an externally managed configuration initialization method &mdash;
* for example, a method annotated with JSR-250's
* {@link javax.annotation.PostConstruct} annotation.
* <p>The supplied {@code initMethod} may be the
* {@linkplain Method#getName() simple method name} for non-private methods or the
* {@linkplain org.springframework.util.ClassUtils#getQualifiedMethodName(Method)
* qualified method name} for {@code private} methods. A qualified name is
* necessary for {@code private} methods in order to disambiguate between
* multiple private methods with the same name within a class hierarchy.
*/ */
public void registerExternallyManagedInitMethod(String initMethod) { public void registerExternallyManagedInitMethod(String initMethod) {
synchronized (this.postProcessingLock) { synchronized (this.postProcessingLock) {
@ -471,7 +479,10 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
} }
/** /**
* Check whether the given method name indicates an externally managed initialization method. * Determine if the given method name indicates an externally managed
* initialization method.
* <p>See {@link #registerExternallyManagedInitMethod} for details
* regarding the format for the supplied {@code initMethod}.
*/ */
public boolean isExternallyManagedInitMethod(String initMethod) { public boolean isExternallyManagedInitMethod(String initMethod) {
synchronized (this.postProcessingLock) { synchronized (this.postProcessingLock) {
@ -484,10 +495,10 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
* Determine if the given method name indicates an externally managed * Determine if the given method name indicates an externally managed
* initialization method, regardless of method visibility. * initialization method, regardless of method visibility.
* <p>In contrast to {@link #isExternallyManagedInitMethod(String)}, this * <p>In contrast to {@link #isExternallyManagedInitMethod(String)}, this
* method also returns {@code true} if there is a {@code private} external * method also returns {@code true} if there is a {@code private} externally
* init method that has been * managed initialization method that has been
* {@linkplain #registerExternallyManagedInitMethod(String) registered} * {@linkplain #registerExternallyManagedInitMethod(String) registered}
* using a fully qualified method name instead of a simple method name. * using a qualified method name instead of a simple method name.
* @since 5.3.17 * @since 5.3.17
*/ */
boolean hasAnyExternallyManagedInitMethod(String initMethod) { boolean hasAnyExternallyManagedInitMethod(String initMethod) {
@ -512,6 +523,8 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
/** /**
* Return all externally managed initialization methods (as an immutable Set). * Return all externally managed initialization methods (as an immutable Set).
* <p>See {@link #registerExternallyManagedInitMethod} for details
* regarding the format for the initialization methods in the returned set.
* @since 5.3.11 * @since 5.3.11
*/ */
public Set<String> getExternallyManagedInitMethods() { public Set<String> getExternallyManagedInitMethods() {
@ -523,7 +536,15 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
} }
/** /**
* Register an externally managed configuration destruction method. * Register an externally managed configuration destruction method &mdash;
* for example, a method annotated with JSR-250's
* {@link javax.annotation.PreDestroy} annotation.
* <p>The supplied {@code destroyMethod} may be the
* {@linkplain Method#getName() simple method name} for non-private methods or the
* {@linkplain org.springframework.util.ClassUtils#getQualifiedMethodName(Method)
* qualified method name} for {@code private} methods. A qualified name is
* necessary for {@code private} methods in order to disambiguate between
* multiple private methods with the same name within a class hierarchy.
*/ */
public void registerExternallyManagedDestroyMethod(String destroyMethod) { public void registerExternallyManagedDestroyMethod(String destroyMethod) {
synchronized (this.postProcessingLock) { synchronized (this.postProcessingLock) {
@ -535,7 +556,10 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
} }
/** /**
* Check whether the given method name indicates an externally managed destruction method. * Determine if the given method name indicates an externally managed
* destruction method.
* <p>See {@link #registerExternallyManagedDestroyMethod} for details
* regarding the format for the supplied {@code destroyMethod}.
*/ */
public boolean isExternallyManagedDestroyMethod(String destroyMethod) { public boolean isExternallyManagedDestroyMethod(String destroyMethod) {
synchronized (this.postProcessingLock) { synchronized (this.postProcessingLock) {
@ -548,10 +572,10 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
* Determine if the given method name indicates an externally managed * Determine if the given method name indicates an externally managed
* destruction method, regardless of method visibility. * destruction method, regardless of method visibility.
* <p>In contrast to {@link #isExternallyManagedDestroyMethod(String)}, this * <p>In contrast to {@link #isExternallyManagedDestroyMethod(String)}, this
* method also returns {@code true} if there is a {@code private} external * method also returns {@code true} if there is a {@code private} externally
* destroy method that has been * managed destruction method that has been
* {@linkplain #registerExternallyManagedDestroyMethod(String) registered} * {@linkplain #registerExternallyManagedDestroyMethod(String) registered}
* using a fully qualified method name instead of a simple method name. * using a qualified method name instead of a simple method name.
* @since 5.3.17 * @since 5.3.17
*/ */
boolean hasAnyExternallyManagedDestroyMethod(String destroyMethod) { boolean hasAnyExternallyManagedDestroyMethod(String destroyMethod) {
@ -575,7 +599,9 @@ public class RootBeanDefinition extends AbstractBeanDefinition {
} }
/** /**
* Return all externally managed destruction methods (as an immutable Set). * Get all externally managed destruction methods (as an immutable Set).
* <p>See {@link #registerExternallyManagedDestroyMethod} for details
* regarding the format for the destruction methods in the returned set.
* @since 5.3.11 * @since 5.3.11
*/ */
public Set<String> getExternallyManagedDestroyMethods() { public Set<String> getExternallyManagedDestroyMethods() {