Polish contribution

See gh-25429

Author: sbrannen

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2019 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -151,6 +151,7 @@ private static <C, R> R processClassInheritedAnnotations(C context, Class<?> sou
 					return result;
 				}
 				if (isFiltered(source, context, classFilter)) {
+					// Skip the current level in the class hierarchy.
 					source = source.getSuperclass();
 					aggregateIndex++;
 					continue;

spring-core/src/test/java/org/springframework/core/annotation/AnnotationsScannerTests.java

@@ -25,13 +25,13 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Objects;
 import java.util.stream.Stream;
 
 import org.junit.jupiter.api.Test;
 
 import org.springframework.core.annotation.MergedAnnotations.SearchStrategy;
 import org.springframework.lang.Nullable;
-import org.springframework.util.ClassUtils;
 import org.springframework.util.ReflectionUtils;
 
 import static org.assertj.core.api.Assertions.assertThat;
@@ -40,6 +40,7 @@
  * Tests for {@link AnnotationsScanner}.
  *
  * @author Phillip Webb
+ * @author Sam Brannen
  */
 class AnnotationsScannerTests {
 
@@ -115,7 +116,7 @@ void inheritedAnnotationsStrategyOnClassWhenHasInterfaceDoesNotIncludeInterfaces
 	void inheritedAnnotationsStrategyOnClassHierarchyScansInCorrectOrder() {
 		Class<?> source = WithHierarchy.class;
 		assertThat(scan(source, SearchStrategy.INHERITED_ANNOTATIONS)).containsExactly(
-				"0:TestAnnotation1", "1:TestInheritedAnnotation2");
+				"0:TestAnnotation1", "1:TestInheritedAnnotation2", "2:TestInheritedAnnotation3");
 	}
 
 	@Test
@@ -124,7 +125,52 @@ void inheritedAnnotationsStrategyOnClassWhenHasAnnotationOnBothClassesIncudesOnl
 		assertThat(Arrays.stream(source.getAnnotations()).map(
 				Annotation::annotationType).map(Class::getName)).containsExactly(
 						TestInheritedAnnotation2.class.getName());
-		assertThat(scan(source, SearchStrategy.INHERITED_ANNOTATIONS)).containsOnly("0:TestInheritedAnnotation2");
+		assertThat(scan(source, SearchStrategy.INHERITED_ANNOTATIONS)).containsExactly("0:TestInheritedAnnotation2");
+	}
+
+	@Test
+	void inheritedAnnotationsStrategyOnClassWithAllClassesFilteredOut() {
+		List<String> annotationsFound = new ArrayList<>();
+		String scanResult = AnnotationsScanner.scan(this, WithSingleSuperclass.class,
+				SearchStrategy.INHERITED_ANNOTATIONS,
+				(context, aggregateIndex, source, annotations) -> {
+					trackIndexedAnnotations(aggregateIndex, annotations, annotationsFound);
+					return null; // continue searching
+				},
+				(context, clazz) -> true // filter out all classes
+			);
+		assertThat(annotationsFound).isEmpty();
+		assertThat(scanResult).isNull();
+	}
+
+	@Test
+	void inheritedAnnotationsStrategyOnClassWithSourceClassFilteredOut() {
+		List<String> annotationsFound = new ArrayList<>();
+		String scanResult = AnnotationsScanner.scan(this, WithSingleSuperclass.class,
+				SearchStrategy.INHERITED_ANNOTATIONS,
+				(context, aggregateIndex, source, annotations) -> {
+					trackIndexedAnnotations(aggregateIndex, annotations, annotationsFound);
+					return null; // continue searching
+				},
+				(context, clazz) -> clazz == WithSingleSuperclass.class
+			);
+		assertThat(annotationsFound).containsExactly(/* "0:TestAnnotation1", */ "1:TestInheritedAnnotation2");
+		assertThat(scanResult).isNull();
+	}
+
+	@Test
+	void inheritedAnnotationsStrategyInClassHierarchyWithSuperSuperclassFilteredOut() {
+		List<String> annotationsFound = new ArrayList<>();
+		String scanResult = AnnotationsScanner.scan(this, WithHierarchy.class,
+				SearchStrategy.INHERITED_ANNOTATIONS,
+				(context, aggregateIndex, source, annotations) -> {
+					trackIndexedAnnotations(aggregateIndex, annotations, annotationsFound);
+					return null; // continue searching
+				},
+				(context, clazz) -> clazz == HierarchySuperSuperclass.class
+			);
+		assertThat(annotationsFound).containsExactly("0:TestAnnotation1", "1:TestInheritedAnnotation2");
+		assertThat(scanResult).isNull();
 	}
 
 	@Test
@@ -163,7 +209,7 @@ void superclassStrategyOnClassHierarchyScansInCorrectOrder() {
 		Class<?> source = WithHierarchy.class;
 		assertThat(scan(source, SearchStrategy.SUPERCLASS)).containsExactly(
 				"0:TestAnnotation1", "1:TestAnnotation2", "1:TestInheritedAnnotation2",
-				"2:TestAnnotation3");
+				"2:TestAnnotation3", "2:TestInheritedAnnotation3");
 	}
 
 	@Test
@@ -205,7 +251,7 @@ void typeHierarchyStrategyOnClassHierarchyScansInCorrectOrder() {
 		assertThat(scan(source, SearchStrategy.TYPE_HIERARCHY)).containsExactly(
 				"0:TestAnnotation1", "1:TestAnnotation5", "1:TestInheritedAnnotation5",
 				"2:TestAnnotation6", "3:TestAnnotation2", "3:TestInheritedAnnotation2",
-				"4:TestAnnotation3", "5:TestAnnotation4");
+				"4:TestAnnotation3", "4:TestInheritedAnnotation3", "5:TestAnnotation4");
 	}
 
 	@Test
@@ -474,7 +520,7 @@ void scanWhenProcessorReturnsFromDoWithAnnotationsExitsEarly() {
 					return "";
 				});
 		assertThat(result).isEmpty();
-		assertThat(indexes).containsOnly(0);
+		assertThat(indexes).containsExactly(0);
 	}
 
 	@Test
@@ -499,42 +545,30 @@ public String finish(String result) {
 		assertThat(result).isEqualTo("OK");
 	}
 
-	@Test
-	void scanWithFilteredAll() {
-		List<Integer> indexes = new ArrayList<>();
-		String result = AnnotationsScanner.scan(this, WithSingleSuperclass.class,
-				SearchStrategy.INHERITED_ANNOTATIONS,
-				(context, aggregateIndex, source, annotations) -> {
-					indexes.add(aggregateIndex);
-					return "";
-				},
-				(context,cls)->{
-					return true;
-				}
-				);
-		assertThat(result).isNull();
-	}
-
 
 	private Method methodFrom(Class<?> type) {
 		return ReflectionUtils.findMethod(type, "method");
 	}
 
 	private Stream<String> scan(AnnotatedElement element, SearchStrategy searchStrategy) {
-		List<String> result = new ArrayList<>();
+		List<String> results = new ArrayList<>();
 		AnnotationsScanner.scan(this, element, searchStrategy,
 				(criteria, aggregateIndex, source, annotations) -> {
-					for (Annotation annotation : annotations) {
-						if (annotation != null) {
-							String name = ClassUtils.getShortName(
-									annotation.annotationType());
-							name = name.substring(name.lastIndexOf(".") + 1);
-							result.add(aggregateIndex + ":" + name);
-						}
-					}
-					return null;
+					trackIndexedAnnotations(aggregateIndex, annotations, results);
+					return null; // continue searching
 				});
-		return result.stream();
+		return results.stream();
+	}
+
+	private void trackIndexedAnnotations(int aggregateIndex, Annotation[] annotations, List<String> results) {
+		Arrays.stream(annotations)
+			.filter(Objects::nonNull)
+			.map(annotation -> indexedName(aggregateIndex, annotation))
+			.forEach(results::add);
+	}
+
+	private String indexedName(int aggregateIndex, Annotation annotation) {
+		return aggregateIndex + ":" + annotation.annotationType().getSimpleName();
 	}
 
 
@@ -686,6 +720,7 @@ public void method() {
 	}
 
 	@TestAnnotation3
+	@TestInheritedAnnotation3
 	static class HierarchySuperSuperclass implements HierarchySuperSuperclassInterface {
 
 		@Override