capture and save the technical debt comments

Author: shehan

src/main/java/ResultsWriter.java

@@ -51,7 +51,8 @@ private void createClassFile() throws IOException {
                 "androidTestAndroidTestCase",
                 "androidTestInstrumentationTestCase",
                 "orgJunitAssert",
-                "androidTestActivityInstrumentationTestCase2"
+                "androidTestActivityInstrumentationTestCase2",
+                "HasTechnicalDebtComment",
         };
         fileLines.add(columnNames);
 
@@ -126,7 +127,7 @@ private void outputClassDetails(ClassEntity classEntity) throws IOException {
         List<String[]> fileLines = new ArrayList<String[]>();
         String[] dataLine;
 
-        dataLine = new String[21];
+        dataLine = new String[22];
         dataLine[0] = classEntity.getAppName();
         dataLine[1] = classEntity.getTagName();
         dataLine[2] = classEntity.getFilePath();
@@ -148,6 +149,7 @@ private void outputClassDetails(ClassEntity classEntity) throws IOException {
         dataLine[18] = String.valueOf(classEntity.getHas_androidtestInstrumentationTestCase());
         dataLine[19] = String.valueOf(classEntity.getHas_orgjunitAssert());
         dataLine[20] = String.valueOf(classEntity.getHas_androidtestActivityInstrumentationTestCase2());
+        dataLine[21] = String.valueOf(classEntity.getHasTechnicalDebtComments());
 
         fileLines.add(dataLine);
 

src/main/java/TestFileDetector.java

@@ -21,6 +21,7 @@ public class TestFileDetector {
     private List<MethodEntity> methods;
     private ClassEntity classEntity;
     private ArrayList<String> imports;
+    private ArrayList<String> debt;
 
     /**
      * Constructor
@@ -41,6 +42,7 @@ public static TestFileDetector createTestFileDetector() {
     private void initialize(){
         methods = new ArrayList<>();
         imports = new ArrayList<>();
+        debt = new ArrayList<>();
     }
 
     public ClassEntity runAnalysis(Path filePath) throws FileNotFoundException {
@@ -58,6 +60,7 @@ public ClassEntity runAnalysis(Path filePath) throws FileNotFoundException {
 
             classEntity.setMethods(methods);
             classEntity.setImports(imports);
+            classEntity.setTechnicalDebtComments(debt);
         }
 
         return classEntity;
@@ -74,25 +77,29 @@ public void visit(ClassOrInterfaceDeclaration n, Void arg) {
 
             for (Comment comment:n.getAllContainedComments()) {
                 if (containsKeyword(comment.getContent())){
-                    System.out.println(comment.getContent());
+                    debt.add(comment.getContent());
+                    //System.out.println(comment.getContent());
                 }
             }
 
             if(n.getComment().isPresent()){
                 if (containsKeyword(n.getComment().get().getContent())){
-                    System.out.println(n.getComment().get().getContent());
+                    debt.add(n.getComment().get().getContent());
+                    //System.out.println(n.getComment().get().getContent());
                 }
             }
 
             if(n.getJavadocComment().isPresent()){
                 if (containsKeyword(n.getJavadocComment().get().getContent())){
-                    System.out.println(n.getJavadocComment().get().getContent());
+                    debt.add(n.getJavadocComment().get().getContent());
+                    //System.out.println(n.getJavadocComment().get().getContent());
                 }
             }
 
             for (Comment comment:n.getOrphanComments()) {
                 if (containsKeyword(comment.getContent())){
-                    System.out.println(comment.getContent());
+                    debt.add(comment.getContent());
+                    //System.out.println(comment.getContent());
                 }
             }
 

src/main/java/entity/ClassEntity.java

@@ -12,6 +12,7 @@ public class ClassEntity {
    // private Map<String, Boolean> imports;
     private ArrayList<String> imports;
     private String className;
+    private ArrayList<String> technicalDebtComments;
 
     public ClassEntity(Path path) {
         this.path = path;
@@ -133,4 +134,17 @@ public String getTagName() {
         String filePath = path.toAbsolutePath().toString();
         return filePath.split("\\\\")[4];
     }
+
+    public ArrayList<String> getTechnicalDebtComments() {
+        return technicalDebtComments;
+    }
+
+    public void setTechnicalDebtComments(ArrayList<String> technicalDebtComments) {
+        this.technicalDebtComments = technicalDebtComments;
+    }
+
+    public Boolean getHasTechnicalDebtComments() {
+        return (technicalDebtComments.size() >=1);
+
+    }
 }