[core] Refactor CPDReport to use a List

Author: adangel

pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPD.java

@@ -238,7 +238,7 @@ public static StatusCode runCpd(String... args) {
     }
 
     public CPDReport toReport() {
-        return new CPDReport(this.getMatches(), numberOfTokensPerFile);
+        return new CPDReport(matchAlgorithm.getMatches(), numberOfTokensPerFile);
     }
 
     public enum StatusCode {

pmd-core/src/main/java/net/sourceforge/pmd/cpd/CPDReport.java

@@ -5,20 +5,23 @@
 package net.sourceforge.pmd.cpd;
 
 import java.util.Collections;
-import java.util.Iterator;
+import java.util.List;
 import java.util.Map;
 import java.util.TreeMap;
 
+/**
+ * @since 6.48.0
+ */
 public class CPDReport {
-    private final Iterator<Match> matches;
+    private final List<Match> matches;
     private final Map<String, Integer> numberOfTokensPerFile;
 
-    CPDReport(final Iterator<Match> matches, final Map<String, Integer> numberOfTokensPerFile) {
-        this.matches = matches;
+    CPDReport(final List<Match> matches, final Map<String, Integer> numberOfTokensPerFile) {
+        this.matches = Collections.unmodifiableList(matches);
         this.numberOfTokensPerFile = Collections.unmodifiableMap(new TreeMap<>(numberOfTokensPerFile));
     }
 
-    public Iterator<Match> getMatches() {
+    public List<Match> getMatches() {
         return matches;
     }
 

pmd-core/src/main/java/net/sourceforge/pmd/cpd/GUI.java

@@ -276,7 +276,7 @@ public void actionPerformed(ActionEvent evt) {
             }
 
             if (!f.canWrite()) {
-                final CPDReport report = new CPDReport(matches.iterator(), numberOfTokensPerFile);
+                final CPDReport report = new CPDReport(matches, numberOfTokensPerFile);
                 try (PrintWriter pw = new PrintWriter(Files.newOutputStream(f.toPath()))) {
                     renderer.render(report, pw);
                     pw.flush();

pmd-core/src/main/java/net/sourceforge/pmd/cpd/MatchAlgorithm.java

@@ -47,6 +47,10 @@ public Iterator<Match> matches() {
         return matches.iterator();
     }
 
+    List<Match> getMatches() {
+        return matches;
+    }
+
     public TokenEntry tokenAt(int offset, TokenEntry m) {
         return code.get(offset + m.getIndex());
     }

pmd-core/src/main/java/net/sourceforge/pmd/cpd/XMLRenderer.java

@@ -27,6 +27,7 @@
 
 import net.sourceforge.pmd.cpd.renderer.CPDRenderer;
 import net.sourceforge.pmd.cpd.renderer.CPDReportRenderer;
+import net.sourceforge.pmd.util.CollectionUtil;
 import net.sourceforge.pmd.util.StringUtil;
 
 /**
@@ -106,15 +107,15 @@ public String render(Iterator<Match> matches) {
 
     @Override
     public void render(Iterator<Match> matches, Writer writer) throws IOException {
-        render(new CPDReport(matches, Collections.<String, Integer>emptyMap()), writer);
+        render(new CPDReport(CollectionUtil.toList(matches), Collections.<String, Integer>emptyMap()), writer);
     }
 
     @Override
     public void render(final CPDReport report, final Writer writer) throws IOException {
         final Document doc = createDocument();
         final Element root = doc.createElement("pmd-cpd");
         final Map<String, Integer> numberOfTokensPerFile = report.getNumberOfTokensPerFile();
-        final Iterator<Match> matches = report.getMatches();
+        final List<Match> matches = report.getMatches();
         doc.appendChild(root);
 
         final List<Map.Entry<String, Integer>> entries = new ArrayList<>(numberOfTokensPerFile.entrySet());
@@ -125,9 +126,7 @@ public void render(final CPDReport report, final Writer writer) throws IOExcepti
             root.appendChild(fileElement);
         }
 
-        Match match;
-        while (matches.hasNext()) {
-            match = matches.next();
+        for (Match match : matches) {
             root.appendChild(addCodeSnippet(doc,
                     addFilesToDuplicationElement(doc, createDuplicationElement(doc, match), match), match));
         }

pmd-core/src/main/java/net/sourceforge/pmd/cpd/renderer/CPDRendererAdapter.java

@@ -27,6 +27,6 @@ public CPDRendererAdapter(final CPDRenderer renderer) {
 
     @Override
     public void render(final CPDReport report, final Writer writer) throws IOException {
-        renderer.render(report.getMatches(), writer);
+        renderer.render(report.getMatches().iterator(), writer);
     }
 }

pmd-core/src/test/java/net/sourceforge/pmd/cpd/XMLRendererTest.java

@@ -203,7 +203,7 @@ public void testFilesWithNumberOfTokens() throws IOException, ParserConfiguratio
         matches.add(match);
         final Map<String, Integer> numberOfTokensPerFile = new HashMap<>();
         numberOfTokensPerFile.put(filename, 888);
-        final CPDReport report = new CPDReport(matches.iterator(), numberOfTokensPerFile);
+        final CPDReport report = new CPDReport(matches, numberOfTokensPerFile);
         final StringWriter writer = new StringWriter();
         renderer.render(report, writer);
         final String xmlOutput = writer.toString();