Skip to content

Commit bc15f83

Browse files
marcwrobelsbrannen
authored andcommitted
Fix and improve Javadoc in spring-core
See gh-28802
1 parent 46db372 commit bc15f83

File tree

50 files changed

+91
-91
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+91
-91
lines changed

spring-core/src/main/java/org/springframework/core/AttributeAccessor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public interface AttributeAccessor {
5959
* in this {@code AttributeAccessor}, the existing value will be returned
6060
* without applying the supplied compute function.
6161
* <p>The default implementation of this method is not thread safe but can
62-
* overridden by concrete implementations of this interface.
62+
* be overridden by concrete implementations of this interface.
6363
* @param <T> the type of the attribute value
6464
* @param name the unique attribute key
6565
* @param computeFunction a function that computes a new value for the attribute

spring-core/src/main/java/org/springframework/core/BridgeMethodResolver.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2019 the original author or authors.
2+
* Copyright 2002-2022 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -93,9 +93,9 @@ public static Method findBridgedMethod(Method bridgeMethod) {
9393

9494
/**
9595
* Returns {@code true} if the supplied '{@code candidateMethod}' can be
96-
* consider a validate candidate for the {@link Method} that is {@link Method#isBridge() bridged}
96+
* considered a valid candidate for the {@link Method} that is {@link Method#isBridge() bridged}
9797
* by the supplied {@link Method bridge Method}. This method performs inexpensive
98-
* checks and can be used quickly filter for a set of possible matches.
98+
* checks and can be used quickly to filter for a set of possible matches.
9999
*/
100100
private static boolean isBridgedCandidateFor(Method candidateMethod, Method bridgeMethod) {
101101
return (!candidateMethod.isBridge() && !candidateMethod.equals(bridgeMethod) &&
@@ -130,7 +130,7 @@ else if (previousMethod != null) {
130130
}
131131

132132
/**
133-
* Determines whether or not the bridge {@link Method} is the bridge for the
133+
* Determines whether the bridge {@link Method} is the bridge for the
134134
* supplied candidate {@link Method}.
135135
*/
136136
static boolean isBridgeMethodFor(Method bridgeMethod, Method candidateMethod, Class<?> declaringClass) {

spring-core/src/main/java/org/springframework/core/GenericTypeResolver.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ public static Class<?> resolveType(Type genericType, Map<TypeVariable, Type> map
237237
/**
238238
* Build a mapping of {@link TypeVariable#getName TypeVariable names} to
239239
* {@link Class concrete classes} for the specified {@link Class}.
240-
* Searches all super types, enclosing types and interfaces.
240+
* Searches all supertypes, enclosing types and interfaces.
241241
* @see #resolveType(Type, Map)
242242
*/
243243
@SuppressWarnings("rawtypes")

spring-core/src/main/java/org/springframework/core/PrioritizedParameterNameDiscoverer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
/**
2727
* {@link ParameterNameDiscoverer} implementation that tries several discoverer
2828
* delegates in succession. Those added first in the {@code addDiscoverer} method
29-
* have highest priority. If one returns {@code null}, the next will be tried.
29+
* have the highest priority. If one returns {@code null}, the next will be tried.
3030
*
3131
* <p>The default behavior is to return {@code null} if no discoverer matches.
3232
*

spring-core/src/main/java/org/springframework/core/ReactiveTypeDescriptor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public boolean supportsEmpty() {
9494

9595
/**
9696
* Return an empty-value instance for the underlying reactive or async type.
97-
* Use of this type implies {@link #supportsEmpty()} is true.
97+
* Use of this type implies {@link #supportsEmpty()} is {@code true}.
9898
*/
9999
public Object getEmptyValue() {
100100
Assert.state(this.emptyValueSupplier != null, "Empty values not supported");

spring-core/src/main/java/org/springframework/core/ResolvableType.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,7 +1012,7 @@ public static ResolvableType forClass(@Nullable Class<?> clazz) {
10121012
/**
10131013
* Return a {@link ResolvableType} for the specified {@link Class},
10141014
* doing assignability checks against the raw class only (analogous to
1015-
* {@link Class#isAssignableFrom}, which this serves as a wrapper for.
1015+
* {@link Class#isAssignableFrom}), which this serves as a wrapper for.
10161016
* <p>For example: {@code ResolvableType.forRawClass(List.class)}.
10171017
* @param clazz the class to introspect ({@code null} is semantically
10181018
* equivalent to {@code Object.class} for typical use cases here)
@@ -1343,7 +1343,7 @@ static ResolvableType forMethodParameter(
13431343
}
13441344

13451345
/**
1346-
* Return a {@link ResolvableType} as a array of the specified {@code componentType}.
1346+
* Return a {@link ResolvableType} as an array of the specified {@code componentType}.
13471347
* @param componentType the component type
13481348
* @return a {@link ResolvableType} as an array of the specified component type
13491349
*/

spring-core/src/main/java/org/springframework/core/ResolvableTypeProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
* signature as Java does not convey the signature at runtime.
2626
*
2727
* <p>Users of this interface should be careful in complex hierarchy scenarios, especially
28-
* when the generic type signature of the class changes in sub-classes. It is always
28+
* when the generic type signature of the class changes in subclasses. It is always
2929
* possible to return {@code null} to fallback on a default behavior.
3030
*
3131
* @author Stephane Nicoll

spring-core/src/main/java/org/springframework/core/SmartClassLoader.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* Spring's CGLIB proxy factory for making a caching decision.
2727
*
2828
* <p>If a ClassLoader does <i>not</i> implement this interface,
29-
* then all of the classes obtained from it should be considered
29+
* then all the classes obtained from it should be considered
3030
* as not reloadable (i.e. cacheable).
3131
*
3232
* @author Juergen Hoeller

spring-core/src/main/java/org/springframework/core/annotation/AnnotationUtils.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -754,7 +754,7 @@ public static boolean isInJavaLangAnnotationPackage(@Nullable String annotationT
754754
/**
755755
* Check the declared attributes of the given annotation, in particular covering
756756
* Google App Engine's late arrival of {@code TypeNotPresentExceptionProxy} for
757-
* {@code Class} values (instead of early {@code Class.getAnnotations() failure}.
757+
* {@code Class} values (instead of early {@code Class.getAnnotations() failure}).
758758
* <p>This method not failing indicates that {@link #getAnnotationAttributes(Annotation)}
759759
* won't failure either (when attempted later on).
760760
* @param annotation the annotation to validate

spring-core/src/main/java/org/springframework/core/annotation/AttributeMethods.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ boolean isValid(Annotation annotation) {
124124
* any {@link TypeNotPresentException TypeNotPresentExceptions}. In particular,
125125
* this method is designed to cover Google App Engine's late arrival of such
126126
* exceptions for {@code Class} values (instead of the more typical early
127-
* {@code Class.getAnnotations() failure}.
127+
* {@code Class.getAnnotations() failure}).
128128
* @param annotation the annotation to validate
129129
* @throws IllegalStateException if a declared {@code Class} attribute could not be read
130130
* @see #isValid(Annotation)

0 commit comments

Comments
 (0)