Fix typos in Javadoc, documentation and code

marcwrobel · marcwrobel · commit 49cc00257f08 · 2022-08-29T21:22:31.000+02:00
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
@@ -148,7 +148,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.
-	 * <p>Overridden from the super class to prevent the proxy configuration
+	 * <p>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
@@ -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
@@ -80,7 +80,7 @@ private String getQualifiedName(Element element) {
 	}
 
 	/**
-	 * 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) {
@@ -99,7 +99,7 @@ public Element getSuperClass(Element element) {
 	public List<Element> getDirectInterfaces(Element element) {
 		List<? extends TypeMirror> superTypes = this.types.directSupertypes(element.asType());
 		List<Element> 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
@@ -708,8 +708,8 @@ public int getSize() {
    *
    * @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 &lt;&lt; 2) | returnSize} (argumentsSize is therefore equal to {@code
-   *     i &gt;&gt; 2}, and returnSize to {@code i &amp; 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 int getArgumentsAndReturnSizes() {
    * @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 &lt;&lt; 2) | returnSize} (argumentsSize is therefore equal to {@code
-   *     i &gt;&gt; 2}, and returnSize to {@code i &amp; 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
@@ -86,7 +86,7 @@ public boolean match(MetadataReader metadataReader, MetadataReaderFactory metada
 					}
 					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
@@ -125,8 +125,8 @@ private static byte[] digest(String algorithm, byte[] bytes) {
 
 	private static byte[] digest(String algorithm, InputStream inputStream) throws IOException {
 		MessageDigest messageDigest = getDigest(algorithm);
-		if (inputStream instanceof UpdateMessageDigestInputStream digestIntputStream){
-			digestIntputStream.updateMessageDigest(messageDigest);
+		if (inputStream instanceof UpdateMessageDigestInputStream digestInputStream){
+			digestInputStream.updateMessageDigest(messageDigest);
 			return messageDigest.digest();
 		}
 		else {
diff --git 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 @@
 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
@@ -29,7 +29,7 @@
 import org.springframework.util.Assert;
 
 /**
- * Convenient super class for JDBC-based data access objects.
+ * Convenient superclass for JDBC-based data access objects.
  *
  * <p>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
@@ -26,7 +26,7 @@
 import org.springframework.lang.Nullable;
 
 /**
- * Convenient super class for application classes that need JMS access.
+ * Convenient superclass for application classes that need JMS access.
  *
  * <p>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
@@ -262,7 +262,7 @@ public final boolean isRunning() {
 	 * may still independently alternate between being on and off depending on the
 	 * concrete subclass implementation.
 	 * <p>Application components may implement
-	 * {@code org.springframework.context.ApplicationListener&lt;BrokerAvailabilityEvent&gt;}
+	 * {@code org.springframework.context.ApplicationListener<BrokerAvailabilityEvent>}
 	 * 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
@@ -26,7 +26,7 @@
 import org.springframework.util.Assert;
 
 /**
- * Convenient super class for Hibernate-based data access objects.
+ * Convenient superclass for Hibernate-based data access objects.
  *
  * <p>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/annotation/Transactional.java b/spring-tx/src/main/java/org/springframework/transaction/annotation/Transactional.java
@@ -57,7 +57,7 @@
  * rules to be specified as types or patterns, respectively.
  *
  * <p>When a rollback rule is defined with an exception type, that type will be
- * used to match against the type of a thrown exception and its super types,
+ * used to match against the type of a thrown exception and its supertypes,
  * providing type safety and avoiding any unintentional matches that may occur
  * when using a pattern. For example, a value of
  * {@code jakarta.servlet.ServletException.class} will only match thrown exceptions
diff --git a/spring-tx/src/main/java/org/springframework/transaction/interceptor/RollbackRuleAttribute.java b/spring-tx/src/main/java/org/springframework/transaction/interceptor/RollbackRuleAttribute.java
@@ -32,7 +32,7 @@
  * respectively.
  *
  * <p>When a rollback rule is defined with an exception type, that type will be
- * used to match against the type of a thrown exception and its super types,
+ * used to match against the type of a thrown exception and its supertypes,
  * providing type safety and avoiding any unintentional matches that may occur
  * when using a pattern. For example, a value of
  * {@code jakarta.servlet.ServletException.class} will only match thrown exceptions
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
@@ -29,7 +29,7 @@
  * {@link TransactionAttributeEditor} in this package.
  *
  * <p>Strings are in property syntax, with the form:<br>
- * {@code FQCN.methodName=&lt;transaction attribute string&gt;}
+ * {@code FQCN.methodName=<transaction attribute string>}
  *
  * <p>For example:<br>
  * {@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
@@ -24,7 +24,7 @@
 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.
  *
  * <p>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
@@ -28,7 +28,7 @@
  * this class which {@link RequestAttributes} scope to read attributes from.
  *
  * <p>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
@@ -128,7 +128,7 @@ public static HandlerTypePredicate forBasePackageClass(Class<?>... packageClasse
 
 	/**
 	 * 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 @@ private void addBasePackage(String basePackage) {
 
 		/**
 		 * 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
@@ -26,6 +26,6 @@
  */
 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/handler/AbstractHandlerMethodMapping.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/handler/AbstractHandlerMethodMapping.java
@@ -479,8 +479,8 @@ protected HandlerMethod handleNoMatch(Set<T> mappings, String lookupPath, HttpSe
 	@Override
 	protected boolean hasCorsConfigurationSource(Object handler) {
 		return super.hasCorsConfigurationSource(handler) ||
-				(handler instanceof HandlerMethod handerMethod &&
-						this.mappingRegistry.getCorsConfiguration(handerMethod) != null);
+				(handler instanceof HandlerMethod handlerMethod &&
+						this.mappingRegistry.getCorsConfiguration(handlerMethod) != null);
 	}
 
 	@Override
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
@@ -27,7 +27,7 @@
 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/data-access.adoc b/src/docs/asciidoc/data-access.adoc
@@ -1052,7 +1052,7 @@ be configured via the `rollbackFor`/`noRollbackFor` and
 defined based on exception types or patterns, respectively.
 
 When a rollback rule is defined with an exception type, that type will be used to match
-against the type of a thrown exception and its super types, providing type safety and
+against the type of a thrown exception and its supertypes, providing type safety and
 avoiding any unintentional matches that may occur when using a pattern. For example, a
 value of `jakarta.servlet.ServletException.class` will only match thrown exceptions of
 type `jakarta.servlet.ServletException` and its subclasses.
diff --git a/src/docs/asciidoc/testing.adoc b/src/docs/asciidoc/testing.adoc
@@ -1870,7 +1870,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.
 

Original file line number	Diff line number	Diff line change
`@@ -86,7 +86,7 @@ public boolean match(MetadataReader metadataReader, MetadataReaderFactory metada`
`86`	`86`	`}`
`87`	`87`	`catch (IOException ex) {`
`88`	`88`	`if (logger.isDebugEnabled()) {`
`89`		`- logger.debug("Could not read super class [" + metadata.getSuperClassName() +`
	`89`	`+ logger.debug("Could not read superclass [" + metadata.getSuperClassName() +`
`90`	`90`	`"] of type-filtered class [" + metadata.getClassName() + "]");`
`91`	`91`	`}`
`92`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`import org.springframework.lang.Nullable;`
`20`	`20`
`21`	`21`	`/**`
`22`		`- * Super class for exceptions that can occur whilst processing expressions.`
	`22`	`+ * Superclass for exceptions that can occur whilst processing expressions.`
`23`	`23`	`*`
`24`	`24`	`* @author Andy Clement`
`25`	`25`	`* @author Phillip Webb`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`import org.springframework.util.Assert;`
`30`	`30`
`31`	`31`	`/**`
`32`		`- * Convenient super class for JDBC-based data access objects.`
	`32`	`+ * Convenient superclass for JDBC-based data access objects.`
`33`	`33`	`*`
`34`	`34`	`* <p>Requires a {@link javax.sql.DataSource} to be set, providing a`
`35`	`35`	`* {@link org.springframework.jdbc.core.JdbcTemplate} based on it to`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`	`import org.springframework.lang.Nullable;`
`27`	`27`
`28`	`28`	`/**`
`29`		`- * Convenient super class for application classes that need JMS access.`
	`29`	`+ * Convenient superclass for application classes that need JMS access.`
`30`	`30`	`*`
`31`	`31`	`* <p>Requires a ConnectionFactory or a JmsTemplate instance to be set.`
`32`	`32`	`* It will create its own JmsTemplate if a ConnectionFactory is passed in.`