[core] Refactor how CPD Renderers are determined

Author: adangel

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

@@ -42,7 +42,7 @@ public class CPDConfiguration extends AbstractConfiguration {
     public static final String DEFAULT_LANGUAGE = "java";
     public static final String DEFAULT_RENDERER = "text";
 
-    private static final Map<String, Class<? extends CPDRenderer>> RENDERERS = new HashMap<>();
+    private static final Map<String, Class<?>> RENDERERS = new HashMap<>();
 
     static {
         RENDERERS.put(DEFAULT_RENDERER, SimpleRenderer.class);
@@ -175,86 +175,65 @@ public void postContruct() {
             setRendererName(DEFAULT_RENDERER);
         }
         if (getRenderer() == null && getCPDRenderer() == null) {
-            try {
-                try {
-                    setRenderer(getCPDReportRendererFromString(getRendererName(), getEncoding()));
-                } catch (ClassCastException e) {
-                    // The renderer class configured is not using the new CPDReportRenderer interface...
-                    setCPDRenderer(getCPDRendererFromString(getRendererName(), getEncoding()));
-                }
-            } catch (ClassCastException e) {
-                // The renderer class configured is not using the new CPDRenderer interface...
-                setRenderer(getRendererFromString(getRendererName(), getEncoding()));
+            Object renderer = createRendererByName(getRendererName(), getEncoding());
+            String className = getRendererName();
+
+            if (renderer instanceof CPDReportRenderer) {
+                setRenderer((CPDReportRenderer) renderer);
+            } else if (renderer instanceof CPDRenderer) {
+                setCPDRenderer((CPDRenderer) renderer);
+            } else if (renderer instanceof Renderer) {
+                setRenderer((Renderer) renderer);
+            } else {
+                System.err.println("Class '" + className + "' is not a supported renderer, defaulting to SimpleRenderer.");
+                setRenderer(new SimpleRenderer());
             }
         }
     }
 
-    /**
-     * @deprecated Internal API
-     */
-    @Deprecated
-    @InternalApi
-    public static Renderer getRendererFromString(String name, String encoding) {
-        String clazzname = name;
-        if (clazzname == null || "".equals(clazzname)) {
-            clazzname = DEFAULT_RENDERER;
+    private static Object createRendererByName(String name, String encoding) {
+        if (name == null || "".equals(name)) {
+            name = DEFAULT_RENDERER;
         }
-        @SuppressWarnings("unchecked") // Safe, all standard implementations implement both interfaces
-        Class<? extends Renderer> clazz = (Class<? extends Renderer>) RENDERERS.get(clazzname.toLowerCase(Locale.ROOT));
-        if (clazz == null) {
+        Class<?> rendererClass = RENDERERS.get(name.toLowerCase(Locale.ROOT));
+        if (rendererClass == null) {
             try {
-                clazz = Class.forName(clazzname).asSubclass(Renderer.class);
+                rendererClass = Class.forName(name);
             } catch (ClassNotFoundException e) {
                 System.err.println("Can't find class '" + name + "', defaulting to SimpleRenderer.");
-                clazz = SimpleRenderer.class;
+                rendererClass = SimpleRenderer.class;
             }
         }
+
+        Object renderer = null;
         try {
-            Renderer renderer = clazz.getDeclaredConstructor().newInstance();
+            renderer = rendererClass.getDeclaredConstructor().newInstance();
             setRendererEncoding(renderer, encoding);
-            return renderer;
         } catch (Exception e) {
             System.err.println("Couldn't instantiate renderer, defaulting to SimpleRenderer: " + e);
-            return new SimpleRenderer();
+            renderer = new SimpleRenderer();
         }
+        return renderer;
     }
 
     /**
      * @deprecated Internal API
      */
     @Deprecated
     @InternalApi
-    public static CPDRenderer getCPDRendererFromString(String name, String encoding) {
-        String clazzname = name;
-        if (clazzname == null || "".equals(clazzname)) {
-            clazzname = DEFAULT_RENDERER;
-        }
-        Class<? extends CPDRenderer> clazz = RENDERERS.get(clazzname.toLowerCase(Locale.ROOT));
-        if (clazz == null) {
-            try {
-                clazz = Class.forName(clazzname).asSubclass(CPDRenderer.class);
-            } catch (ClassNotFoundException e) {
-                System.err.println("Can't find class '" + name + "', defaulting to SimpleRenderer.");
-                clazz = SimpleRenderer.class;
-            }
-        }
-        try {
-            CPDRenderer renderer = clazz.getDeclaredConstructor().newInstance();
-            setRendererEncoding(renderer, encoding);
-            return renderer;
-        } catch (Exception e) {
-            System.err.println("Couldn't instantiate renderer, defaulting to SimpleRenderer: " + e);
-            return new SimpleRenderer();
-        }
+    public static Renderer getRendererFromString(String name, String encoding) {
+        // will throw a ClassCastException if the renderer is of wrong type
+        return (Renderer) createRendererByName(name, encoding);
     }
 
-    static CPDReportRenderer getCPDReportRendererFromString(String name, String encoding) {
-        final CPDRenderer renderer = getCPDRendererFromString(name, encoding);
-        if (renderer instanceof CPDReportRenderer) {
-            return (CPDReportRenderer) renderer;
-        } else {
-            return new CPDRendererAdapter(renderer);
-        }
+    /**
+     * @deprecated Internal API
+     */
+    @Deprecated
+    @InternalApi
+    public static CPDRenderer getCPDRendererFromString(String name, String encoding) {
+        // will throw a ClassCastException if the renderer is of wrong type
+        return (CPDRenderer) createRendererByName(name, encoding);
     }
 
     private static void setRendererEncoding(Object renderer, String encoding)
@@ -417,6 +396,7 @@ public boolean accept(File dir, String name) {
     public void setRenderer(Renderer renderer) {
         this.renderer = renderer;
         this.cpdRenderer = null;
+        this.cpdReportRenderer = null;
     }
 
     /**
@@ -426,8 +406,9 @@ public void setRenderer(Renderer renderer) {
     @Deprecated
     @InternalApi
     public void setCPDRenderer(CPDRenderer renderer) {
-        this.cpdRenderer = renderer;
         this.renderer = null;
+        this.cpdRenderer = renderer;
+        this.cpdReportRenderer = new CPDRendererAdapter(renderer);
     }
 
     void setRenderer(CPDReportRenderer renderer) {

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

@@ -20,7 +20,6 @@
 import java.io.File;
 import java.io.IOException;
 import java.io.PrintWriter;
-import java.io.Writer;
 import java.nio.file.Files;
 import java.util.ArrayList;
 import java.util.Collections;
@@ -66,35 +65,16 @@
 import javax.swing.table.TableModel;
 
 import net.sourceforge.pmd.PMDVersion;
+import net.sourceforge.pmd.cpd.renderer.CPDRendererAdapter;
 import net.sourceforge.pmd.cpd.renderer.CPDReportRenderer;
 
 public class GUI implements CPDListener {
 
-    // private interface Renderer {
-    // String render(Iterator<Match> items);
-    // }
-
-    private static final Object[][] RENDERER_SETS = new Object[][] { { "Text", new CPDReportRenderer() {
-        @Override
-        public void render(CPDReport report, Writer writer) throws IOException {
-            new SimpleRenderer().render(report.getMatches(), writer);
-        }
-    }, }, { "XML", new CPDReportRenderer() {
-        @Override
-        public void render(CPDReport report, Writer writer) throws IOException {
-            new XMLRenderer().render(report, writer);
-        }
-    }, }, { "CSV (comma)", new CPDReportRenderer() {
-        @Override
-        public void render(CPDReport report, Writer writer) throws IOException {
-            new CSVRenderer(',').render(report.getMatches(), writer);
-        }
-    }, }, { "CSV (tab)", new CPDReportRenderer() {
-        @Override
-        public void render(CPDReport report, Writer writer) throws IOException {
-            new CSVRenderer('\t').render(report.getMatches(), writer);
-        }
-    }, }, };
+    private static final Object[][] RENDERER_SETS = new Object[][] {
+            { "Text", new CPDRendererAdapter(new SimpleRenderer()), },
+            { "XML", new XMLRenderer(), },
+            { "CSV (comma)", new CPDRendererAdapter(new CSVRenderer(',')), },
+            { "CSV (tab)", new CPDRendererAdapter(new CSVRenderer('\t')), }, };
 
     private abstract static class LanguageConfig {
         public abstract Language languageFor(Properties p);