Browse Source

Fix typos in Javadoc, reference docs, and code

Closes gh-28822
pull/30296/head
Marc Wrobel 3 years ago committed by Sam Brannen
parent
commit
92a231cf91
  1. 2
      spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java
  2. 2
      spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractDependencyInjectionAspect.aj
  3. 4
      spring-context-indexer/src/main/java/org/springframework/context/index/processor/TypeHelper.java
  4. 8
      spring-core/src/main/java/org/springframework/asm/Type.java
  5. 2
      spring-core/src/main/java/org/springframework/core/type/filter/AbstractTypeHierarchyTraversingFilter.java
  6. 2
      spring-core/src/main/java/org/springframework/util/DigestUtils.java
  7. 2
      spring-expression/src/main/java/org/springframework/expression/ExpressionException.java
  8. 2
      spring-jdbc/src/main/java/org/springframework/jdbc/core/support/JdbcDaoSupport.java
  9. 2
      spring-jms/src/main/java/org/springframework/jms/core/support/JmsGatewaySupport.java
  10. 2
      spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java
  11. 2
      spring-orm/src/main/java/org/springframework/orm/hibernate5/support/HibernateDaoSupport.java
  12. 2
      spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAttributeSourceEditor.java
  13. 2
      spring-web/src/main/java/org/springframework/web/client/support/RestGatewaySupport.java
  14. 2
      spring-web/src/main/java/org/springframework/web/context/request/AbstractRequestAttributesScope.java
  15. 4
      spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java
  16. 2
      spring-web/src/test/java/org/springframework/web/server/handler/ResponseStatusExceptionHandlerTests.java
  17. 2
      spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/AbstractHtmlElementBodyTag.java
  18. 2
      src/docs/asciidoc/testing.adoc

2
spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAutoProxyCreator.java

@ -147,7 +147,7 @@ public abstract class AbstractAutoProxyCreator extends ProxyProcessorSupport @@ -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.
* <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

2
spring-aspects/src/main/java/org/springframework/beans/factory/aspectj/AbstractDependencyInjectionAspect.aj

@ -35,7 +35,7 @@ public abstract aspect AbstractDependencyInjectionAspect { @@ -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();

4
spring-context-indexer/src/main/java/org/springframework/context/index/processor/TypeHelper.java

@ -81,7 +81,7 @@ class TypeHelper { @@ -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 { @@ -100,7 +100,7 @@ class TypeHelper {
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) {

8
spring-core/src/main/java/org/springframework/asm/Type.java

@ -708,8 +708,8 @@ public final class Type { @@ -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 &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 final class Type { @@ -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 &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;

2
spring-core/src/main/java/org/springframework/core/type/filter/AbstractTypeHierarchyTraversingFilter.java

@ -86,7 +86,7 @@ public abstract class AbstractTypeHierarchyTraversingFilter implements TypeFilte @@ -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() + "]");
}
}

2
spring-core/src/main/java/org/springframework/util/DigestUtils.java

@ -1,5 +1,5 @@ @@ -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.

2
spring-expression/src/main/java/org/springframework/expression/ExpressionException.java

@ -19,7 +19,7 @@ package org.springframework.expression; @@ -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

2
spring-jdbc/src/main/java/org/springframework/jdbc/core/support/JdbcDaoSupport.java

@ -29,7 +29,7 @@ import org.springframework.lang.Nullable; @@ -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.
*
* <p>Requires a {@link javax.sql.DataSource} to be set, providing a
* {@link org.springframework.jdbc.core.JdbcTemplate} based on it to

2
spring-jms/src/main/java/org/springframework/jms/core/support/JmsGatewaySupport.java

@ -27,7 +27,7 @@ import org.springframework.jms.core.JmsTemplate; @@ -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.
*
* <p>Requires a ConnectionFactory or a JmsTemplate instance to be set.
* It will create its own JmsTemplate if a ConnectionFactory is passed in.

2
spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java

@ -262,7 +262,7 @@ public abstract class AbstractBrokerMessageHandler @@ -262,7 +262,7 @@ public abstract class AbstractBrokerMessageHandler
* 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() {

2
spring-orm/src/main/java/org/springframework/orm/hibernate5/support/HibernateDaoSupport.java

@ -26,7 +26,7 @@ import org.springframework.orm.hibernate5.HibernateTemplate; @@ -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.
*
* <p>Requires a {@link SessionFactory} to be set, providing a
* {@link org.springframework.orm.hibernate5.HibernateTemplate} based on it to

2
spring-tx/src/main/java/org/springframework/transaction/interceptor/TransactionAttributeSourceEditor.java

@ -29,7 +29,7 @@ import org.springframework.util.StringUtils; @@ -29,7 +29,7 @@ import org.springframework.util.StringUtils;
* {@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}

2
spring-web/src/main/java/org/springframework/web/client/support/RestGatewaySupport.java

@ -24,7 +24,7 @@ import org.springframework.util.Assert; @@ -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.
*
* <p>Requires a {@link ClientHttpRequestFactory} or a {@link RestTemplate} instance to be set.
*

2
spring-web/src/main/java/org/springframework/web/context/request/AbstractRequestAttributesScope.java

@ -28,7 +28,7 @@ import org.springframework.lang.Nullable; @@ -28,7 +28,7 @@ import org.springframework.lang.Nullable;
* 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

4
spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java

@ -128,7 +128,7 @@ public final class HandlerTypePredicate implements Predicate<Class<?>> { @@ -128,7 +128,7 @@ public final class HandlerTypePredicate implements Predicate<Class<?>> {
/**
* 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<Class<?>> { @@ -187,7 +187,7 @@ public final class HandlerTypePredicate implements Predicate<Class<?>> {
/**
* 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));

2
spring-web/src/test/java/org/springframework/web/server/handler/ResponseStatusExceptionHandlerTests.java

@ -26,6 +26,6 @@ import org.springframework.web.testfixture.server.handler.AbstractResponseStatus @@ -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
}

2
spring-webmvc/src/main/java/org/springframework/web/servlet/tags/form/AbstractHtmlElementBodyTag.java

@ -27,7 +27,7 @@ import org.springframework.util.Assert; @@ -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)}.
*

2
src/docs/asciidoc/testing.adoc

@ -1871,7 +1871,7 @@ Spring test configuration annotations are processed within enclosing class hiera @@ -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.

Loading…
Cancel
Save