Skip to content

Commit c6be3b3

Browse files
marcwrobelsbrannen
authored andcommitted
Fix and improve Javadoc in spring-aop
Closes gh-28803
1 parent c112bb0 commit c6be3b3

File tree

19 files changed

+31
-31
lines changed

19 files changed

+31
-31
lines changed

spring-aop/src/main/java/org/aopalliance/intercept/Joinpoint.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public interface Joinpoint {
6363
/**
6464
* Return the static part of this joinpoint.
6565
* <p>The static part is an accessible object on which a chain of
66-
* interceptors are installed.
66+
* interceptors is installed.
6767
*/
6868
@Nonnull
6969
AccessibleObject getStaticPart();

spring-aop/src/main/java/org/springframework/aop/IntroductionAwareMethodMatcher.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public interface IntroductionAwareMethodMatcher extends MethodMatcher {
3636
* @param targetClass the target class
3737
* @param hasIntroductions {@code true} if the object on whose behalf we are
3838
* asking is the subject on one or more introductions; {@code false} otherwise
39-
* @return whether or not this method matches statically
39+
* @return whether this method matches statically
4040
*/
4141
boolean matches(Method method, Class<?> targetClass, boolean hasIntroductions);
4242

spring-aop/src/main/java/org/springframework/aop/MethodMatcher.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public interface MethodMatcher {
6060
* will be made.
6161
* @param method the candidate method
6262
* @param targetClass the target class
63-
* @return whether or not this method matches statically
63+
* @return whether this method matches statically
6464
*/
6565
boolean matches(Method method, Class<?> targetClass);
6666

@@ -70,7 +70,7 @@ public interface MethodMatcher {
7070
* runtime even if the 2-arg matches method returns {@code true}?
7171
* <p>Can be invoked when an AOP proxy is created, and need not be invoked
7272
* again before each method invocation,
73-
* @return whether or not a runtime match via the 3-arg
73+
* @return whether a runtime match via the 3-arg
7474
* {@link #matches(java.lang.reflect.Method, Class, Object[])} method
7575
* is required if static matching passed
7676
*/

spring-aop/src/main/java/org/springframework/aop/SpringProxy.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
/**
2020
* Marker interface implemented by all AOP proxies. Used to detect
21-
* whether or not objects are Spring-generated proxies.
21+
* whether objects are Spring-generated proxies.
2222
*
2323
* @author Rob Harrop
2424
* @since 2.0.1

spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJAdvisorFactory.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,15 +39,15 @@
3939
public interface AspectJAdvisorFactory {
4040

4141
/**
42-
* Determine whether or not the given class is an aspect, as reported
42+
* Determine whether the given class is an aspect, as reported
4343
* by AspectJ's {@link org.aspectj.lang.reflect.AjTypeSystem}.
4444
* <p>Will simply return {@code false} if the supposed aspect is
4545
* invalid (such as an extension of a concrete aspect class).
4646
* Will return true for some aspects that Spring AOP cannot process,
4747
* such as those with unsupported instantiation models.
4848
* Use the {@link #validate} method to handle these cases if necessary.
4949
* @param clazz the supposed annotation-style AspectJ class
50-
* @return whether or not this class is recognized by AspectJ as an aspect class
50+
* @return whether this class is recognized by AspectJ as an aspect class
5151
*/
5252
boolean isAspect(Class<?> clazz);
5353

spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectMetadata.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public class AspectMetadata implements Serializable {
6767

6868
/**
6969
* Spring AOP pointcut corresponding to the per clause of the
70-
* aspect. Will be the Pointcut.TRUE canonical instance in the
70+
* aspect. Will be the {@code Pointcut.TRUE} canonical instance in the
7171
* case of a singleton, otherwise an AspectJExpressionPointcut.
7272
*/
7373
private final Pointcut perClausePointcut;

spring-aop/src/main/java/org/springframework/aop/aspectj/autoproxy/AspectJAwareAdvisorAutoProxyCreator.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ public class AspectJAwareAdvisorAutoProxyCreator extends AbstractAdvisorAutoProx
6060
* <li>Otherwise the advice declared first gets highest precedence (i.e., runs
6161
* first).</li>
6262
* </ul>
63-
* <p><b>Important:</b> Advisors are sorted in precedence order, from highest
64-
* precedence to lowest. "On the way in" to a join point, the highest precedence
63+
* <p><b>Important:</b> Advisors are sorted in precedence order, from the highest
64+
* precedence to the lowest. "On the way in" to a join point, the highest precedence
6565
* advisor should run first. "On the way out" of a join point, the highest
6666
* precedence advisor should run last.
6767
*/

spring-aop/src/main/java/org/springframework/aop/framework/AdvisedSupport.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,15 +314,15 @@ public boolean replaceAdvisor(Advisor a, Advisor b) throws AopConfigException {
314314
}
315315

316316
/**
317-
* Add all of the given advisors to this proxy configuration.
317+
* Add all the given advisors to this proxy configuration.
318318
* @param advisors the advisors to register
319319
*/
320320
public void addAdvisors(Advisor... advisors) {
321321
addAdvisors(Arrays.asList(advisors));
322322
}
323323

324324
/**
325-
* Add all of the given advisors to this proxy configuration.
325+
* Add all the given advisors to this proxy configuration.
326326
* @param advisors the advisors to register
327327
*/
328328
public void addAdvisors(Collection<Advisor> advisors) {

spring-aop/src/main/java/org/springframework/aop/framework/JdkDynamicAopProxy.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ final class JdkDynamicAopProxy implements AopProxy, InvocationHandler, Serializa
7272
* NOTE: We could avoid the code duplication between this class and the CGLIB
7373
* proxies by refactoring "invoke" into a template method. However, this approach
7474
* adds at least 10% performance overhead versus a copy-paste solution, so we sacrifice
75-
* elegance for performance. (We have a good test suite to ensure that the different
76-
* proxies behave the same :-)
75+
* elegance for performance (we have a good test suite to ensure that the different
76+
* proxies behave the same :-)).
7777
* This way, we can also more easily take advantage of minor optimizations in each class.
7878
*/
7979

@@ -198,7 +198,7 @@ else if (!this.advised.opaque && method.getDeclaringClass().isInterface() &&
198198
// Get the interception chain for this method.
199199
List<Object> chain = this.advised.getInterceptorsAndDynamicInterceptionAdvice(method, targetClass);
200200

201-
// Check whether we have any advice. If we don't, we can fallback on direct
201+
// Check whether we have any advice. If we don't, we can fall back on direct
202202
// reflective invocation of the target, and avoid creating a MethodInvocation.
203203
if (chain.isEmpty()) {
204204
// We can skip creating a MethodInvocation: just invoke the target directly

spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactoryBean.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@
6060
* to use the "targetName"/"target"/"targetSource" properties instead.
6161
*
6262
* <p>Global interceptors and advisors can be added at the factory level. The specified
63-
* ones are expanded in an interceptor list where an "xxx*" entry is included in the
63+
* ones are expanded in an interceptor list where a "xxx*" entry is included in the
6464
* list, matching the given prefix with the bean names (e.g. "global*" would match
6565
* both "globalBean1" and "globalBean2", "*" all defined interceptors). The matching
6666
* interceptors get applied according to their returned order value, if they implement
@@ -406,7 +406,7 @@ private boolean isNamedBeanAnAdvisorOrAdvice(String beanName) {
406406
if (namedBeanClass != null) {
407407
return (Advisor.class.isAssignableFrom(namedBeanClass) || Advice.class.isAssignableFrom(namedBeanClass));
408408
}
409-
// Treat it as an target bean if we can't tell.
409+
// Treat it as a target bean if we can't tell.
410410
if (logger.isDebugEnabled()) {
411411
logger.debug("Could not determine type of bean with name '" + beanName +
412412
"' - assuming it is neither an Advisor nor an Advice");

0 commit comments

Comments
 (0)