Move body of the for loops over methods and fields into a common method.

Signed-off-by: Michael Glavassevich <[email protected]>

Author: mrglavas

src/main/java/io/openliberty/tools/intellij/lsp4jakarta/lsp4ij/persistence/PersistenceMapKeyDiagnosticsCollector.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2020, 2023 IBM Corporation, Ankush Sharma and others.
+ * Copyright (c) 2020, 2024 IBM Corporation, Ankush Sharma and others.
  *
  * This program and the accompanying materials are made available under the
  * terms of the Eclipse Public License v. 2.0 which is available at
@@ -18,13 +18,17 @@
 import io.openliberty.tools.intellij.lsp4jakarta.lsp4ij.Messages;
 import org.eclipse.lsp4j.Diagnostic;
 import org.eclipse.lsp4j.DiagnosticSeverity;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
 public class PersistenceMapKeyDiagnosticsCollector extends AbstractDiagnosticsCollector {
 
+    private static final Logger log = LoggerFactory.getLogger(PersistenceMapKeyDiagnosticsCollector.class);
+
     public PersistenceMapKeyDiagnosticsCollector() {
         super();
     }
@@ -37,83 +41,58 @@ protected String getDiagnosticSource() {
     @Override
     public void collectDiagnostics(PsiJavaFile unit, List<Diagnostic> diagnostics) {
         if (unit != null) {
-            PsiClass[] alltypes;
-            PsiAnnotation[] allAnnotations;
-
-            alltypes = unit.getClasses();
+            PsiClass[] alltypes = unit.getClasses();
             PsiMethod[] methods;
             PsiField[] fields;
 
             for (PsiClass type : alltypes) {
                 methods = type.getMethods();
                 for (PsiMethod method : methods) {
-                    List<PsiAnnotation> mapKeyJoinCols = new ArrayList<PsiAnnotation>();
-                    boolean hasMapKeyAnnotation = false;
-                    boolean hasMapKeyClassAnnotation = false;
-                    allAnnotations = method.getAnnotations();
-                    for (PsiAnnotation annotation : allAnnotations) {
-                        String matchedAnnotation = getMatchedJavaElementName(type, annotation.getQualifiedName(),
-                                PersistenceConstants.SET_OF_PERSISTENCE_ANNOTATIONS);
-                        if (matchedAnnotation != null) {
-                            if (PersistenceConstants.MAPKEY.equals(matchedAnnotation))
-                                hasMapKeyAnnotation = true;
-                            else if (PersistenceConstants.MAPKEYCLASS.equals(matchedAnnotation))
-                                hasMapKeyClassAnnotation = true;
-                            else if (PersistenceConstants.MAPKEYJOINCOLUMN.equals(matchedAnnotation)) {
-                                mapKeyJoinCols.add(annotation);
-                            }
-                        }
-                    }
-                    if (hasMapKeyAnnotation && hasMapKeyClassAnnotation) {
-                        // A single field cannot have the same
-                        diagnostics.add(createDiagnostic(method, unit,
-                                Messages.getMessage("MapKeyAnnotationsNotOnSameField"),
-                                PersistenceConstants.DIAGNOSTIC_CODE_INVALID_ANNOTATION, null,
-                                DiagnosticSeverity.Error));
-                    }
-                    // If we have multiple MapKeyJoinColumn annotations on a single method we must
-                    // ensure each has a name and referencedColumnName
-                    if (mapKeyJoinCols.size() > 1) {
-                        validateMapKeyJoinColumnAnnotations(mapKeyJoinCols, method, unit, diagnostics);
-                    }
+                    collectDiagnostics(unit, diagnostics, type, method);
                 }
-
                 // Go through each field to ensure they do not have both MapKey and MapKeyColumn
                 // Annotations
                 fields = type.getFields();
                 for (PsiField field : fields) {
-                    List<PsiAnnotation> mapKeyJoinCols = new ArrayList<PsiAnnotation>();
-                    boolean hasMapKeyAnnotation = false;
-                    boolean hasMapKeyClassAnnotation = false;
-                    allAnnotations = field.getAnnotations();
-                    for (PsiAnnotation annotation : allAnnotations) {
-                        String matchedAnnotation = getMatchedJavaElementName(type, annotation.getQualifiedName(),
-                                PersistenceConstants.SET_OF_PERSISTENCE_ANNOTATIONS);
-                        if (matchedAnnotation != null) {
-                            if (PersistenceConstants.MAPKEY.equals(matchedAnnotation))
-                                hasMapKeyAnnotation = true;
-                            else if (PersistenceConstants.MAPKEYCLASS.equals(matchedAnnotation))
-                                hasMapKeyClassAnnotation = true;
-                            else if (PersistenceConstants.MAPKEYJOINCOLUMN.equals(matchedAnnotation)) {
-                                mapKeyJoinCols.add(annotation);
-                            }
-                        }
-                    }
-                    if (hasMapKeyAnnotation && hasMapKeyClassAnnotation) {
-                        // A single field cannot have the same
-                        diagnostics.add(createDiagnostic(field, unit,
-                                Messages.getMessage("MapKeyAnnotationsNotOnSameField"),
-                                PersistenceConstants.DIAGNOSTIC_CODE_INVALID_ANNOTATION, null,
-                                DiagnosticSeverity.Error));
-                    }
-                    if (mapKeyJoinCols.size() > 1) {
-                        validateMapKeyJoinColumnAnnotations(mapKeyJoinCols, field, unit, diagnostics);
-                    }
+                    collectDiagnostics(unit, diagnostics, type, field);
                 }
             }
         }
     }
 
+    private void collectDiagnostics(PsiJavaFile unit, List<Diagnostic> diagnostics,
+                                    PsiClass type, PsiJvmModifiersOwner fieldOrProperty) {
+        List<PsiAnnotation> mapKeyJoinCols = new ArrayList<PsiAnnotation>();
+        boolean hasMapKeyAnnotation = false;
+        boolean hasMapKeyClassAnnotation = false;
+        PsiAnnotation[] allAnnotations = fieldOrProperty.getAnnotations();
+        for (PsiAnnotation annotation : allAnnotations) {
+            String matchedAnnotation = getMatchedJavaElementName(type, annotation.getQualifiedName(),
+                    PersistenceConstants.SET_OF_PERSISTENCE_ANNOTATIONS);
+            if (matchedAnnotation != null) {
+                if (PersistenceConstants.MAPKEY.equals(matchedAnnotation))
+                    hasMapKeyAnnotation = true;
+                else if (PersistenceConstants.MAPKEYCLASS.equals(matchedAnnotation))
+                    hasMapKeyClassAnnotation = true;
+                else if (PersistenceConstants.MAPKEYJOINCOLUMN.equals(matchedAnnotation)) {
+                    mapKeyJoinCols.add(annotation);
+                }
+            }
+        }
+        if (hasMapKeyAnnotation && hasMapKeyClassAnnotation) {
+            // A single field or property cannot have the same
+            diagnostics.add(createDiagnostic(fieldOrProperty, unit,
+                    Messages.getMessage("MapKeyAnnotationsNotOnSameField"),
+                    PersistenceConstants.DIAGNOSTIC_CODE_INVALID_ANNOTATION, null,
+                    DiagnosticSeverity.Error));
+        }
+        // If we have multiple MapKeyJoinColumn annotations on a single method or property we must
+        // ensure each has a name and referencedColumnName
+        if (mapKeyJoinCols.size() > 1) {
+            validateMapKeyJoinColumnAnnotations(mapKeyJoinCols, fieldOrProperty, unit, diagnostics);
+        }
+    }
+
     private void validateMapKeyJoinColumnAnnotations(List<PsiAnnotation> annotations, PsiElement element,
                                                      PsiJavaFile unit, List<Diagnostic> diagnostics) {
         String message = (element instanceof PsiMethod) ?
@@ -131,4 +110,5 @@ private void validateMapKeyJoinColumnAnnotations(List<PsiAnnotation> annotations
                         PersistenceConstants.DIAGNOSTIC_CODE_MISSING_ATTRIBUTES, null, DiagnosticSeverity.Error));
             }
         });
-    }}
+    }
+}