Add source file processor and doclet executor

Author: oshando

swan-pipeline/src/main/java/de/fraunhofer/iem/swan/io/doc/JavadocProcessor.java

@@ -0,0 +1,64 @@
+package de.fraunhofer.iem.swan.io.doc;
+
+import de.fraunhofer.iem.swan.data.Method;
+import de.fraunhofer.iem.swan.features.FeatureSet;
+import de.fraunhofer.iem.swan.io.dataset.SrmListUtils;
+import org.apache.commons.io.FileUtils;
+import java.io.File;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+
+public class JavadocProcessor {
+
+    private File sourceDirectory;
+    private String outputDirectory;
+
+    public JavadocProcessor(String sourceDirectory, String outputDirectory) {
+
+        this.sourceDirectory = new File(sourceDirectory);
+
+        outputDirectory += File.separator + "xml-files";
+        File output = new File(outputDirectory);
+        output.mkdirs();
+
+        this.outputDirectory = output.getAbsolutePath();
+    }
+
+    /**
+     * Runs doclets to calculate documentation coverage and export doc comments to XML files.
+     * Exported doc comments are used to update set of methods.
+     *
+     * @param methods     set of methods
+     * @param featureSets feature set specified by user
+     */
+    public void run(Set<Method> methods, List<String> featureSets) {
+
+        if (featureSets.contains(FeatureSet.Type.DOC_AUTO.getValue()) ||
+                featureSets.contains(FeatureSet.Type.DOC_MANUAL.getValue())) {
+
+            if (sourceDirectory.isDirectory()) {
+                for (File file : FileUtils.listFiles(sourceDirectory, new String[]{"jar"}, true)) {
+                    SrmListUtils.addDocComments(methods, processJar(file));
+                }
+            } else {
+                SrmListUtils.addDocComments(methods, processJar(sourceDirectory));
+            }
+        }
+    }
+
+    public ArrayList<Javadoc> processJar(File file) {
+
+        DocletExecutor coverageDoclet = new DocletExecutor();
+        coverageDoclet.setDoclet(DocletExecutor.COVERAGE_DOCLET);
+        coverageDoclet.runDoclet(file.getAbsolutePath(), SourceJarEvaluator.getRootPackages(file));
+
+        DocletExecutor exporterDoclet = new DocletExecutor();
+        exporterDoclet.setDoclet(DocletExecutor.SSL_DOCLET);
+        exporterDoclet.setOutputDir(outputDirectory);
+        exporterDoclet.runDoclet(file.getAbsolutePath(), SourceJarEvaluator.getRootPackages(file));
+
+        XmlDocletParser javadocParser = new XmlDocletParser(outputDirectory);
+        return javadocParser.parse();
+    }
+}

swan-pipeline/src/main/java/de/fraunhofer/iem/swan/io/doc/XmlDocletParser.java

@@ -53,7 +53,6 @@ public ArrayList<Javadoc> parse() {
 
             for (File file : FileUtils.listFiles(filePath, new String[]{"xml"}, true))
                 parseFile(file.getAbsolutePath());
-
         } else {
             parseFile(filePath.getAbsolutePath());
         }
@@ -71,15 +70,14 @@ public void parseFile(String xmlFile) {
 
                 HashMap<String, MethodBlockType> methods = new HashMap<>();
 
+                for (MethodBlockType methodBlock : xmlDoc.getPackageBlock().getClassBlock().getMethods().getMethodBlock()) {
 
-                    for (MethodBlockType methodBlock : xmlDoc.getPackageBlock().getClassBlock().getMethods().getMethodBlock()) {
-
-                        String methodSignature = getSignature(xmlDoc.getPackageBlock().getQualifiedName(), methodBlock);
+                    String methodSignature = getSignature(xmlDoc.getPackageBlock().getQualifiedName(), methodBlock);
 
-                        methodBlock.setSignature(methodSignature);
-                        methods.put(methodSignature, methodBlock);
-                    }
-                    javadocs.add(new Javadoc(xmlDoc.getPackageBlock(), methods, xmlFile));
+                    methodBlock.setSignature(methodSignature);
+                    methods.put(methodSignature, methodBlock);
+                }
+                javadocs.add(new Javadoc(xmlDoc.getPackageBlock(), methods, xmlFile));
             }
 
         } catch (FileNotFoundException | JAXBException e) {