Move XML doc comment parser to util class

Author: oshando

swan-pipeline/src/main/java/de/fraunhofer/iem/swan/io/dataset/SrmListUtils.java

@@ -2,12 +2,15 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import de.fraunhofer.iem.swan.data.Method;
+import de.fraunhofer.iem.swan.io.doc.Javadoc;
+import de.fraunhofer.iem.swan.io.doc.ssldoclet.MethodBlockType;
 import edu.stanford.nlp.util.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
 import java.io.File;
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Set;
@@ -24,6 +27,7 @@ public class SrmListUtils {
 
     /**
      * Imports SRMs from JSON file.
+     *
      * @param file JSON File that stores security-relevant methods
      * @return object containing all security-relevant methods
      */
@@ -38,8 +42,9 @@ public static SrmList importFile(String file) throws IOException {
 
     /**
      * Exports SRM list to JSON file.
+     *
      * @param srmList list of SRMa
-     * @param file path of JSON file
+     * @param file    path of JSON file
      */
     public static void exportFile(SrmList srmList, String file) throws IOException {
 
@@ -58,4 +63,41 @@ public static void removeUndocumentedMethods(SrmList list) {
                 list.getMethods().remove(method);
         }
     }
+
+    /**
+     * Adds doc comments to method set.
+     * @param methods methods to be updated
+     * @param javadocs list of Javadoc objects
+     * @return updated method set
+     */
+    public static Set<Method> addDocComments(Set<Method> methods, ArrayList<Javadoc> javadocs) {
+
+        for (Javadoc doc : javadocs) {
+
+            for (MethodBlockType methodBlock : doc.getMethodBlocks().values()) {
+
+                Method method = methods.stream().filter(m -> methodBlock.getSignature()
+                        .equals(m.getJavaSignature())).findAny().orElse(null);
+
+                if (method != null) {
+
+                    de.fraunhofer.iem.swan.data.Javadoc javadoc = new de.fraunhofer.iem.swan.data.Javadoc();
+
+                    if (doc.getPackageBlock().getClassBlock().getClassCommentBlock() != null) {
+                        String classComment = doc.getPackageBlock().getClassBlock().getClassCommentBlock().getClassComment().getValue();
+
+                        javadoc.setClassComment(classComment);
+                    }
+
+                    if (methodBlock.getMethodCommentBlock() != null) {
+                        String methodComment = methodBlock.getMethodCommentBlock().getMethodComment().getValue();
+
+                        javadoc.setMethodComment(methodComment);
+                    }
+                    method.setJavadoc(javadoc);
+                }
+            }
+        }
+        return methods;
+    }
 }