Order type annotations last (#594)

Author: timtebeek

src/main/java/org/openrewrite/staticanalysis/ReorderAnnotations.java

@@ -22,6 +22,8 @@
 import org.openrewrite.internal.ListUtils;
 import org.openrewrite.java.JavaIsoVisitor;
 import org.openrewrite.java.tree.J;
+import org.openrewrite.java.tree.JavaType;
+import org.openrewrite.java.tree.TypeUtils;
 
 import java.util.ArrayList;
 import java.util.Comparator;
@@ -41,7 +43,32 @@ public String getDescription() {
         return "Consistently order annotations by comparing their simple name.";
     }
 
-    private static final Comparator<J.Annotation> comparator = Comparator.comparing(J.Annotation::getSimpleName);
+    private static final Comparator<J.Annotation> comparator = Comparator
+            .comparing((J.Annotation a) -> {
+                // If the annotation is a type use annotation, it should be ordered last
+                if (a.getType() instanceof JavaType.Class) {
+                    for (JavaType.FullyQualified fq : ((JavaType.Class) a.getType()).getAnnotations()) {
+                        if (TypeUtils.isOfClassType(fq, "java.lang.annotation.Target")) {
+                            for (JavaType.Annotation.ElementValue elementValue : ((JavaType.Annotation) fq).getValues()) {
+                                Object value = elementValue.getValue();
+                                if (value instanceof List) {
+                                    for (Object item : (List<?>) value) {
+                                        if (item instanceof JavaType.Variable &&
+                                                "TYPE_USE".equals(((JavaType.Variable) item).getName())) {
+                                            return 1;
+                                        }
+                                    }
+                                } else if (value instanceof JavaType.Variable &&
+                                        "TYPE_USE".equals(((JavaType.Variable) value).getName())) {
+                                    return 1;
+                                }
+                            }
+                        }
+                    }
+                }
+                return 0;
+            })
+            .thenComparing(J.Annotation::getSimpleName);
 
     @Override
     public JavaIsoVisitor<ExecutionContext> getVisitor() {

src/test/java/org/openrewrite/staticanalysis/ReorderAnnotationsTest.java

@@ -153,6 +153,33 @@ void explicitImplementationClassInApi() {
         );
     }
 
+    @Test
+    void typeAnnotationsLast() {
+        rewriteRun(
+          //language=java
+          java(
+            """
+              import org.jspecify.annotations.Nullable;
+              class A {
+                  @Nullable
+                  @SuppressWarnings("all")
+                  Object typeAnnotationsShould() {
+                  }
+              }
+              """,
+            """
+              import org.jspecify.annotations.Nullable;
+              class A {
+                  @SuppressWarnings("all")
+                  @Nullable
+                  Object typeAnnotationsShould() {
+                  }
+              }
+              """
+          )
+        );
+    }
+
     @Nested
     class NoChange {
         @Test
@@ -192,5 +219,23 @@ void explicitImplementationClassInApi() {
               )
             );
         }
+
+        @Test
+        void typeAnnotationAlreadyLast() {
+            rewriteRun(
+              //language=java
+              java(
+                """
+                  import org.jspecify.annotations.Nullable;
+                  class A {
+                      @SuppressWarnings("all")
+                      @Nullable
+                      Object typeAnnotationsShould() {
+                      }
+                  }
+                  """
+              )
+            );
+        }
     }
 }