From 92a231cf916d307aa0ab166f892cdfbf9a0d089f Mon Sep 17 00:00:00 2001 From: Marc Wrobel Date: Thu, 14 Jul 2022 12:27:32 +0200 Subject: [PATCH] Fix typos in Javadoc, reference docs, and code Closes gh-28822 --- .../aop/framework/autoproxy/AbstractAutoProxyCreator.java | 2 +- .../factory/aspectj/AbstractDependencyInjectionAspect.aj | 2 +- .../context/index/processor/TypeHelper.java | 4 ++-- .../src/main/java/org/springframework/asm/Type.java | 8 ++++---- .../filter/AbstractTypeHierarchyTraversingFilter.java | 2 +- .../main/java/org/springframework/util/DigestUtils.java | 2 +- .../springframework/expression/ExpressionException.java | 2 +- .../springframework/jdbc/core/support/JdbcDaoSupport.java | 2 +- .../jms/core/support/JmsGatewaySupport.java | 2 +- .../simp/broker/AbstractBrokerMessageHandler.java | 2 +- .../orm/hibernate5/support/HibernateDaoSupport.java | 2 +- .../interceptor/TransactionAttributeSourceEditor.java | 2 +- .../web/client/support/RestGatewaySupport.java | 2 +- .../context/request/AbstractRequestAttributesScope.java | 2 +- .../springframework/web/method/HandlerTypePredicate.java | 4 ++-- .../handler/ResponseStatusExceptionHandlerTests.java | 2 +- .../web/servlet/tags/form/AbstractHtmlElementBodyTag.java | 2 +- src/docs/asciidoc/testing.adoc | 2 +- 18 files changed, 23 insertions(+), 23 deletions(-) diff --git a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java index e81b6e43e07..d43f7c4e4ed 100644 --- a/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java +++ b/spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java @@ -147,7 +147,7 @@ public abstract class AbstractAutoProxyCreator extends ProxyProcessorSupport /** * Set whether the proxy should be frozen, preventing advice * from being added to it once it is created. - *

Overridden from the super class to prevent the proxy configuration + *

Overridden from the superclass to prevent the proxy configuration * from being frozen before the proxy is created. */ @Override diff --git a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractDependencyInjectionAspect.aj b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractDependencyInjectionAspect.aj index 94f9f8c6ded..19ba5e5b053 100644 --- a/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractDependencyInjectionAspect.aj +++ b/spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractDependencyInjectionAspect.aj @@ -35,7 +35,7 @@ public abstract aspect AbstractDependencyInjectionAspect { mostSpecificSubTypeConstruction() && !preConstructionConfiguration(); /** - * Select least specific super type that is marked for DI + * Select least specific supertype that is marked for DI * (so that injection occurs only once with pre-construction injection). */ public abstract pointcut leastSpecificSuperTypeConstruction(); diff --git a/spring-context-indexer/src/main/java/org/springframework/context/index/processor/TypeHelper.java b/spring-context-indexer/src/main/java/org/springframework/context/index/processor/TypeHelper.java index 470c0398a23..706225aae52 100644 --- a/spring-context-indexer/src/main/java/org/springframework/context/index/processor/TypeHelper.java +++ b/spring-context-indexer/src/main/java/org/springframework/context/index/processor/TypeHelper.java @@ -81,7 +81,7 @@ class TypeHelper { } /** - * Return the super class of the specified {@link Element} or null if this + * Return the superclass of the specified {@link Element} or null if this * {@code element} represents {@link Object}. */ public Element getSuperClass(Element element) { @@ -100,7 +100,7 @@ class TypeHelper { public List getDirectInterfaces(Element element) { List superTypes = this.types.directSupertypes(element.asType()); List directInterfaces = new ArrayList<>(); - if (superTypes.size() > 1) { // index 0 is the super class + if (superTypes.size() > 1) { // index 0 is the superclass for (int i = 1; i < superTypes.size(); i++) { Element e = this.types.asElement(superTypes.get(i)); if (e != null) { diff --git a/spring-core/src/main/java/org/springframework/asm/Type.java b/spring-core/src/main/java/org/springframework/asm/Type.java index f346c6a44b6..24d0e679b87 100644 --- a/spring-core/src/main/java/org/springframework/asm/Type.java +++ b/spring-core/src/main/java/org/springframework/asm/Type.java @@ -708,8 +708,8 @@ public final class Type { * * @return the size of the arguments of the method (plus one for the implicit this argument), * argumentsSize, and the size of its return value, returnSize, packed into a single int i = - * {@code (argumentsSize << 2) | returnSize} (argumentsSize is therefore equal to {@code - * i >> 2}, and returnSize to {@code i & 0x03}). + * {@code (argumentsSize << 2) | returnSize} (argumentsSize is therefore equal to {@code + * i >> 2}, and returnSize to {@code i & 0x03}). */ public int getArgumentsAndReturnSizes() { return getArgumentsAndReturnSizes(getDescriptor()); @@ -721,8 +721,8 @@ public final class Type { * @param methodDescriptor a method descriptor. * @return the size of the arguments of the method (plus one for the implicit this argument), * argumentsSize, and the size of its return value, returnSize, packed into a single int i = - * {@code (argumentsSize << 2) | returnSize} (argumentsSize is therefore equal to {@code - * i >> 2}, and returnSize to {@code i & 0x03}). + * {@code (argumentsSize << 2) | returnSize} (argumentsSize is therefore equal to {@code + * i >> 2}, and returnSize to {@code i & 0x03}). */ public static int getArgumentsAndReturnSizes(final String methodDescriptor) { int argumentsSize = 1; diff --git a/spring-core/src/main/java/org/springframework/core/type/filter/AbstractTypeHierarchyTraversingFilter.java b/spring-core/src/main/java/org/springframework/core/type/filter/AbstractTypeHierarchyTraversingFilter.java index 0baa3943916..ad8df683662 100644 --- a/spring-core/src/main/java/org/springframework/core/type/filter/AbstractTypeHierarchyTraversingFilter.java +++ b/spring-core/src/main/java/org/springframework/core/type/filter/AbstractTypeHierarchyTraversingFilter.java @@ -86,7 +86,7 @@ public abstract class AbstractTypeHierarchyTraversingFilter implements TypeFilte } catch (IOException ex) { if (logger.isDebugEnabled()) { - logger.debug("Could not read super class [" + metadata.getSuperClassName() + + logger.debug("Could not read superclass [" + metadata.getSuperClassName() + "] of type-filtered class [" + metadata.getClassName() + "]"); } } diff --git a/spring-core/src/main/java/org/springframework/util/DigestUtils.java b/spring-core/src/main/java/org/springframework/util/DigestUtils.java index b76a2b47995..8d2dc0f0067 100644 --- a/spring-core/src/main/java/org/springframework/util/DigestUtils.java +++ b/spring-core/src/main/java/org/springframework/util/DigestUtils.java @@ -1,5 +1,5 @@ /* - * Copyright 2002-2020 the original author or authors. + * Copyright 2002-2022 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. diff --git a/spring-expression/src/main/java/org/springframework/expression/ExpressionException.java b/spring-expression/src/main/java/org/springframework/expression/ExpressionException.java index 0d4cb1859bd..1b8d222a84a 100644 --- a/spring-expression/src/main/java/org/springframework/expression/ExpressionException.java +++ b/spring-expression/src/main/java/org/springframework/expression/ExpressionException.java @@ -19,7 +19,7 @@ package org.springframework.expression; import org.springframework.lang.Nullable; /** - * Super class for exceptions that can occur whilst processing expressions. + * Superclass for exceptions that can occur whilst processing expressions. * * @author Andy Clement * @author Phillip Webb diff --git a/spring-jdbc/src/main/java/org/springframework/jdbc/core/support/JdbcDaoSupport.java b/spring-jdbc/src/main/java/org/springframework/jdbc/core/support/JdbcDaoSupport.java index 0184d934df4..522b96d733c 100644 --- a/spring-jdbc/src/main/java/org/springframework/jdbc/core/support/JdbcDaoSupport.java +++ b/spring-jdbc/src/main/java/org/springframework/jdbc/core/support/JdbcDaoSupport.java @@ -29,7 +29,7 @@ import org.springframework.lang.Nullable; import org.springframework.util.Assert; /** - * Convenient super class for JDBC-based data access objects. + * Convenient superclass for JDBC-based data access objects. * *

Requires a {@link javax.sql.DataSource} to be set, providing a * {@link org.springframework.jdbc.core.JdbcTemplate} based on it to diff --git a/spring-jms/src/main/java/org/springframework/jms/core/support/JmsGatewaySupport.java b/spring-jms/src/main/java/org/springframework/jms/core/support/JmsGatewaySupport.java index 0ce0650a00c..0e5e1f6c2c2 100644 --- a/spring-jms/src/main/java/org/springframework/jms/core/support/JmsGatewaySupport.java +++ b/spring-jms/src/main/java/org/springframework/jms/core/support/JmsGatewaySupport.java @@ -27,7 +27,7 @@ import org.springframework.jms.core.JmsTemplate; import org.springframework.lang.Nullable; /** - * Convenient super class for application classes that need JMS access. + * Convenient superclass for application classes that need JMS access. * *

Requires a ConnectionFactory or a JmsTemplate instance to be set. * It will create its own JmsTemplate if a ConnectionFactory is passed in. diff --git a/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java b/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java index b504047a770..58f83e9ef42 100644 --- a/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java +++ b/spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java @@ -262,7 +262,7 @@ public abstract class AbstractBrokerMessageHandler * may still independently alternate between being on and off depending on the * concrete subclass implementation. *

Application components may implement - * {@code org.springframework.context.ApplicationListener<BrokerAvailabilityEvent>} + * {@code org.springframework.context.ApplicationListener} * to receive notifications when broker becomes available and unavailable. */ public boolean isBrokerAvailable() { diff --git a/spring-orm/src/main/java/org/springframework/orm/hibernate5/support/HibernateDaoSupport.java b/spring-orm/src/main/java/org/springframework/orm/hibernate5/support/HibernateDaoSupport.java index 7bdb958dc51..a65d5255561 100644 --- a/spring-orm/src/main/java/org/springframework/orm/hibernate5/support/HibernateDaoSupport.java +++ b/spring-orm/src/main/java/org/springframework/orm/hibernate5/support/HibernateDaoSupport.java @@ -26,7 +26,7 @@ import org.springframework.orm.hibernate5.HibernateTemplate; import org.springframework.util.Assert; /** - * Convenient super class for Hibernate-based data access objects. + * Convenient superclass for Hibernate-based data access objects. * *

Requires a {@link SessionFactory} to be set, providing a * {@link org.springframework.orm.hibernate5.HibernateTemplate} based on it to diff --git a/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAttributeSourceEditor.java b/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAttributeSourceEditor.java index a1c9cbac836..eef4a8cc9ff 100644 --- a/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAttributeSourceEditor.java +++ b/spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAttributeSourceEditor.java @@ -29,7 +29,7 @@ import org.springframework.util.StringUtils; * {@link TransactionAttributeEditor} in this package. * *

Strings are in property syntax, with the form:
- * {@code FQCN.methodName=<transaction attribute string>} + * {@code FQCN.methodName=} * *

For example:
* {@code com.mycompany.mycode.MyClass.myMethod=PROPAGATION_MANDATORY,ISOLATION_DEFAULT} diff --git a/spring-web/src/main/java/org/springframework/web/client/support/RestGatewaySupport.java b/spring-web/src/main/java/org/springframework/web/client/support/RestGatewaySupport.java index 80854c2a1bd..a31c4d911a8 100644 --- a/spring-web/src/main/java/org/springframework/web/client/support/RestGatewaySupport.java +++ b/spring-web/src/main/java/org/springframework/web/client/support/RestGatewaySupport.java @@ -24,7 +24,7 @@ import org.springframework.util.Assert; import org.springframework.web.client.RestTemplate; /** - * Convenient super class for application classes that need REST access. + * Convenient superclass for application classes that need REST access. * *

Requires a {@link ClientHttpRequestFactory} or a {@link RestTemplate} instance to be set. * diff --git a/spring-web/src/main/java/org/springframework/web/context/request/AbstractRequestAttributesScope.java b/spring-web/src/main/java/org/springframework/web/context/request/AbstractRequestAttributesScope.java index 26813bd1035..eb104e23543 100644 --- a/spring-web/src/main/java/org/springframework/web/context/request/AbstractRequestAttributesScope.java +++ b/spring-web/src/main/java/org/springframework/web/context/request/AbstractRequestAttributesScope.java @@ -28,7 +28,7 @@ import org.springframework.lang.Nullable; * this class which {@link RequestAttributes} scope to read attributes from. * *

Subclasses may wish to override the {@link #get} and {@link #remove} - * methods to add synchronization around the call back into this super class. + * methods to add synchronization around the call back into this superclass. * * @author Rod Johnson * @author Juergen Hoeller diff --git a/spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java b/spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java index 74b09041f42..d9170419519 100644 --- a/spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java +++ b/spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java @@ -128,7 +128,7 @@ public final class HandlerTypePredicate implements Predicate> { /** * Match handlers that are assignable to a given type. - * @param types one or more handler super types + * @param types one or more handler supertypes */ public static HandlerTypePredicate forAssignableType(Class... types) { return new Builder().assignableType(types).build(); @@ -187,7 +187,7 @@ public final class HandlerTypePredicate implements Predicate> { /** * Match handlers that are assignable to a given type. - * @param types one or more handler super types + * @param types one or more handler supertypes */ public Builder assignableType(Class... types) { this.assignableTypes.addAll(Arrays.asList(types)); diff --git a/spring-web/src/test/java/org/springframework/web/server/handler/ResponseStatusExceptionHandlerTests.java b/spring-web/src/test/java/org/springframework/web/server/handler/ResponseStatusExceptionHandlerTests.java index 5943d8896c3..61288d9f6cd 100644 --- a/spring-web/src/test/java/org/springframework/web/server/handler/ResponseStatusExceptionHandlerTests.java +++ b/spring-web/src/test/java/org/springframework/web/server/handler/ResponseStatusExceptionHandlerTests.java @@ -26,6 +26,6 @@ import org.springframework.web.testfixture.server.handler.AbstractResponseStatus */ public class ResponseStatusExceptionHandlerTests extends AbstractResponseStatusExceptionHandlerTests { - // all tests in super class + // all tests in superclass } diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/AbstractHtmlElementBodyTag.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/AbstractHtmlElementBodyTag.java index 0212d7a1de9..0101735bb1e 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/AbstractHtmlElementBodyTag.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/AbstractHtmlElementBodyTag.java @@ -27,7 +27,7 @@ import org.springframework.util.Assert; import org.springframework.util.StringUtils; /** - * Convenient super class for many html tags that render content using the databinding + * Convenient superclass for many html tags that render content using the databinding * features of the {@link AbstractHtmlElementTag AbstractHtmlElementTag}. The only thing * sub-tags need to do is override {@link #renderDefaultContent(TagWriter)}. * diff --git a/src/docs/asciidoc/testing.adoc b/src/docs/asciidoc/testing.adoc index c38c3b9d48e..58d7eb8598f 100644 --- a/src/docs/asciidoc/testing.adoc +++ b/src/docs/asciidoc/testing.adoc @@ -1871,7 +1871,7 @@ Spring test configuration annotations are processed within enclosing class hiera for inner test classes. If `@NestedTestConfiguration` is not present or meta-present on a test class, in its -super type hierarchy, or in its enclosing class hierarchy, the default _enclosing +supertype hierarchy, or in its enclosing class hierarchy, the default _enclosing configuration inheritance mode_ will be used. See the tip below for details on how to change the default mode.