[Core] Deprecate Formatter interface

android/src/main/java/cucumber/runtime/formatter/AndroidInstrumentationReporter.java

@@ -5,12 +5,12 @@
 import cucumber.api.Result;
 import cucumber.api.TestCase;
 import cucumber.api.event.EventHandler;
+import cucumber.api.event.EventListener;
 import cucumber.api.event.EventPublisher;
 import cucumber.api.event.TestCaseFinished;
 import cucumber.api.event.TestCaseStarted;
 import cucumber.api.event.TestSourceRead;
 import cucumber.api.event.TestStepFinished;
-import cucumber.api.formatter.Formatter;
 import cucumber.runtime.UndefinedStepsTracker;
 import cucumber.runtime.Utils;
 
@@ -41,7 +41,7 @@
  *     hook threw an exception other than an {@link AssertionError}</li>
  * </ul>
  */
-public final class AndroidInstrumentationReporter implements Formatter {
+public final class AndroidInstrumentationReporter implements EventListener {
 
     /**
      * Tests status keys.

android/src/main/java/cucumber/runtime/formatter/AndroidLogcatReporter.java

@@ -3,17 +3,17 @@
 import android.util.Log;
 import cucumber.api.PickleStepTestStep;
 import cucumber.api.event.EventHandler;
+import cucumber.api.event.EventListener;
 import cucumber.api.event.EventPublisher;
 import cucumber.api.event.TestCaseStarted;
 import cucumber.api.event.TestRunFinished;
 import cucumber.api.event.TestStepStarted;
-import cucumber.api.formatter.Formatter;
 import cucumber.runtime.UndefinedStepsTracker;
 
 /**
  * Logs information about the currently executed statements to androids logcat.
  */
-public final class AndroidLogcatReporter implements Formatter {
+public final class AndroidLogcatReporter implements EventListener {
 
     /**
      * The log tag to be used when logging to logcat.

core/src/main/java/cucumber/api/Plugin.java

@@ -14,7 +14,6 @@
  * <ul>
  * <li>{@link cucumber.api.StepDefinitionReporter}</li>
  * <li>{@link cucumber.api.SummaryPrinter}</li>
- * <li>{@link cucumber.api.formatter.Formatter}</li>
  * </ul>
  * <p>
  * Plugins are added to the runtime from the command line or @{@link CucumberOptions} and may be provided with a

core/src/main/java/cucumber/api/event/EventListener.java

@@ -1,12 +1,14 @@
 package cucumber.api.event;
 
+import cucumber.api.Plugin;
+
 /**
  * This is the interface you should implement if your plugin listens to cucumber execution events
  */
-public interface EventListener {
+public interface EventListener extends Plugin {
 
     /**
-     * Set the event publisher. The formatter can register event listeners with the publisher.
+     * Set the event publisher. The plugin can register event listeners with the publisher.
      *
      * @param publisher the event publisher
      */

core/src/main/java/cucumber/api/formatter/ColorAware.java

@@ -1,15 +1,17 @@
 package cucumber.api.formatter;
 
+import cucumber.api.Plugin;
+
 /**
- * Interface for Formatters that use ANSI escape codes to print coloured output.
+ * Interface for Plugins that use ANSI escape codes to print coloured output.
  */
-public interface ColorAware extends Formatter {
+public interface ColorAware extends Plugin {
     /**
-     * When set to monochrome the formatter should not use colored output.
+     * When set to monochrome the plugin should not use colored output.
      * <p>
      * For the benefit of systems that do not support ANSI escape codes.
      *
-     * @param monochrome true iff monochrome output should be used
+     * @param monochrome true if monochrome output should be used
      */
     void setMonochrome(boolean monochrome);
 }

core/src/main/java/cucumber/api/formatter/Formatter.java

@@ -4,11 +4,9 @@
 import cucumber.api.event.EventListener;
 
 /**
- * This is the interface you should implement if you want your own custom
- * formatter.
- *
- * @see EventListener
- * @see Plugin
+ * @deprecated as of version 4.0.0; use {@link EventListener } and {@link Plugin } instead.
+ * Optionally, use {@link ColorAware } and/or {@link StrictAware } instead of {@link Plugin }.
  */
+@Deprecated
 public interface Formatter extends EventListener, Plugin {
 }

core/src/main/java/cucumber/api/formatter/StrictAware.java

@@ -1,13 +1,15 @@
 package cucumber.api.formatter;
 
+import cucumber.api.Plugin;
+
 /**
- * Interface for Formatters that need to know if the Runtime is strict.
+ * Interface for Plugins that need to know if the Runtime is strict.
  */
-public interface StrictAware extends Formatter {
+public interface StrictAware extends Plugin {
     /**
-     * When set to strict the formatter should indicate failure for undefined and pending steps
+     * When set to strict the plugin should indicate failure for undefined and pending steps
      *
-     * @param strict true iff the runtime is in strict mode
+     * @param strict true if the runtime is in strict mode
      */
     void setStrict(boolean strict);
 }

core/src/main/java/cucumber/runtime/RuntimeOptions.java

@@ -13,7 +13,6 @@
 import java.io.InputStreamReader;
 import java.io.Reader;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -343,7 +342,7 @@ public void addPluginName(String name, boolean isAddPlugin) {
                 stepDefinitionReporterNames.addName(name, isAddPlugin);
             } else if (PluginFactory.isSummaryPrinterName(name)) {
                 summaryPrinterNames.addName(name, isAddPlugin);
-            } else if (PluginFactory.isFormatterName(name)) {
+            } else if (PluginFactory.isPluginName(name)) {
                 formatterNames.addName(name, isAddPlugin);
             } else {
                 throw new CucumberException("Unrecognized plugin: " + name);

core/src/main/java/cucumber/runtime/RuntimeOptionsFactory.java

@@ -86,9 +86,7 @@ private void addPlugins(CucumberOptions options, List<String> args) {
         for (String plugin : plugins) {
             args.add("--plugin");
             args.add(plugin);
-            if (PluginFactory.isFormatterName(plugin)) {
-                pluginSpecified = true;
-            }
+            pluginSpecified = true;
         }
     }
 

core/src/main/java/cucumber/runtime/formatter/HTMLFormatter.java

@@ -1,19 +1,19 @@
 package cucumber.runtime.formatter;
 
 import cucumber.api.HookTestStep;
+import cucumber.api.PickleStepTestStep;
 import cucumber.api.Result;
 import cucumber.api.TestCase;
-import cucumber.api.PickleStepTestStep;
 import cucumber.api.event.EmbedEvent;
 import cucumber.api.event.EventHandler;
+import cucumber.api.event.EventListener;
 import cucumber.api.event.EventPublisher;
 import cucumber.api.event.TestCaseStarted;
 import cucumber.api.event.TestRunFinished;
 import cucumber.api.event.TestSourceRead;
 import cucumber.api.event.TestStepFinished;
 import cucumber.api.event.TestStepStarted;
 import cucumber.api.event.WriteEvent;
-import cucumber.api.formatter.Formatter;
 import cucumber.api.formatter.NiceAppendable;
 import cucumber.runtime.CucumberException;
 import cucumber.runtime.io.URLOutputStream;
@@ -50,7 +50,7 @@
 import java.util.List;
 import java.util.Map;
 
-final class HTMLFormatter implements Formatter {
+final class HTMLFormatter implements EventListener {
     private static final Gson gson = new GsonBuilder().setPrettyPrinting().create();
     private static final String JS_FORMATTER_VAR = "formatter";
     private static final String JS_REPORT_FILENAME = "report.js";

core/src/main/java/cucumber/runtime/formatter/JSONFormatter.java

@@ -2,20 +2,20 @@
 
 import cucumber.api.HookTestStep;
 import cucumber.api.HookType;
+import cucumber.api.PickleStepTestStep;
 import cucumber.api.Result;
-import cucumber.api.TestStep;
 import cucumber.api.TestCase;
-import cucumber.api.PickleStepTestStep;
+import cucumber.api.TestStep;
 import cucumber.api.event.EmbedEvent;
 import cucumber.api.event.EventHandler;
+import cucumber.api.event.EventListener;
 import cucumber.api.event.EventPublisher;
 import cucumber.api.event.TestCaseStarted;
 import cucumber.api.event.TestRunFinished;
 import cucumber.api.event.TestSourceRead;
 import cucumber.api.event.TestStepFinished;
 import cucumber.api.event.TestStepStarted;
 import cucumber.api.event.WriteEvent;
-import cucumber.api.formatter.Formatter;
 import cucumber.api.formatter.NiceAppendable;
 import gherkin.ast.Background;
 import gherkin.ast.DocString;
@@ -37,7 +37,7 @@
 import java.util.List;
 import java.util.Map;
 
-final class JSONFormatter implements Formatter {
+final class JSONFormatter implements EventListener {
     private String currentFeatureFile;
     private List<Map<String, Object>> featureMaps = new ArrayList<Map<String, Object>>();
     private List<Map<String, Object>> currentElementsList;

core/src/main/java/cucumber/runtime/formatter/JUnitFormatter.java

@@ -1,15 +1,15 @@
 package cucumber.runtime.formatter;
 
-import cucumber.api.Result;
 import cucumber.api.PickleStepTestStep;
+import cucumber.api.Result;
 import cucumber.api.event.EventHandler;
+import cucumber.api.event.EventListener;
 import cucumber.api.event.EventPublisher;
 import cucumber.api.event.TestCaseFinished;
 import cucumber.api.event.TestCaseStarted;
 import cucumber.api.event.TestRunFinished;
 import cucumber.api.event.TestSourceRead;
 import cucumber.api.event.TestStepFinished;
-import cucumber.api.formatter.Formatter;
 import cucumber.api.formatter.StrictAware;
 import cucumber.runtime.CucumberException;
 import cucumber.runtime.Utils;
@@ -39,7 +39,7 @@
 import java.util.List;
 import java.util.Locale;
 
-final class JUnitFormatter implements Formatter, StrictAware {
+final class JUnitFormatter implements EventListener, StrictAware {
     private final Writer out;
     private final Document doc;
     private final Element rootElement;

core/src/main/java/cucumber/runtime/formatter/NullFormatter.java

@@ -1,9 +1,9 @@
 package cucumber.runtime.formatter;
 
+import cucumber.api.event.EventListener;
 import cucumber.api.event.EventPublisher;
-import cucumber.api.formatter.Formatter;
 
-final class NullFormatter implements Formatter {
+final class NullFormatter implements EventListener {
     public NullFormatter() {
     }
 

core/src/main/java/cucumber/runtime/formatter/PluginFactory.java

@@ -3,7 +3,7 @@
 import cucumber.api.Plugin;
 import cucumber.api.StepDefinitionReporter;
 import cucumber.api.SummaryPrinter;
-import cucumber.api.formatter.Formatter;
+import cucumber.api.event.EventListener;
 import cucumber.runtime.CucumberException;
 import cucumber.runtime.io.URLOutputStream;
 import cucumber.runtime.io.UTF8OutputStreamWriter;
@@ -195,9 +195,9 @@ private Appendable defaultOutOrFailIfAlreadyUsed(String formatterString) {
         }
     }
 
-    public static boolean isFormatterName(String name) {
+    public static boolean isPluginName(String name) {
         Class pluginClass = getPluginClass(name);
-        return Formatter.class.isAssignableFrom(pluginClass);
+        return EventListener.class.isAssignableFrom(pluginClass);
     }
 
     public static boolean isStepDefinitionReporterName(String name) {

core/src/main/java/cucumber/runtime/formatter/Plugins.java

@@ -4,12 +4,10 @@
 import cucumber.api.StepDefinitionReporter;
 import cucumber.api.event.EventListener;
 import cucumber.api.formatter.ColorAware;
-import cucumber.api.formatter.Formatter;
 import cucumber.api.formatter.StrictAware;
 import cucumber.runner.EventBus;
 import cucumber.runtime.RuntimeOptions;
 import cucumber.runtime.Utils;
-import cucumber.runtime.formatter.PluginFactory;
 
 import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.Method;
@@ -89,8 +87,8 @@ private void setStrictOnStrictAwarePlugins(Object plugin) {
 
     private void setEventBusOnEventListenerPlugins(Object plugin) {
         if (plugin instanceof EventListener && bus != null) {
-            Formatter formatter = (Formatter) plugin;
-            formatter.setEventPublisher(bus);
+            EventListener eventListener = (EventListener) plugin;
+            eventListener.setEventPublisher(bus);
         }
     }
 

core/src/main/java/cucumber/runtime/formatter/PrettyFormatter.java

@@ -1,11 +1,12 @@
 package cucumber.runtime.formatter;
 
 import cucumber.api.Argument;
+import cucumber.api.PickleStepTestStep;
 import cucumber.api.Result;
-import cucumber.api.TestStep;
 import cucumber.api.TestCase;
-import cucumber.api.PickleStepTestStep;
+import cucumber.api.TestStep;
 import cucumber.api.event.EventHandler;
+import cucumber.api.event.EventListener;
 import cucumber.api.event.EventPublisher;
 import cucumber.api.event.TestCaseStarted;
 import cucumber.api.event.TestRunFinished;
@@ -14,7 +15,6 @@
 import cucumber.api.event.TestStepStarted;
 import cucumber.api.event.WriteEvent;
 import cucumber.api.formatter.ColorAware;
-import cucumber.api.formatter.Formatter;
 import cucumber.api.formatter.NiceAppendable;
 import cucumber.util.FixJava;
 import cucumber.util.Mapper;
@@ -29,7 +29,7 @@
 
 import java.util.List;
 
-final class PrettyFormatter implements Formatter, ColorAware {
+final class PrettyFormatter implements EventListener, ColorAware {
     private static final String SCENARIO_INDENT = "  ";
     private static final String STEP_INDENT = "    ";
     private static final String EXAMPLES_INDENT = "    ";

core/src/main/java/cucumber/runtime/formatter/ProgressFormatter.java

@@ -1,21 +1,21 @@
 package cucumber.runtime.formatter;
 
-import cucumber.api.Result;
 import cucumber.api.PickleStepTestStep;
+import cucumber.api.Result;
 import cucumber.api.event.EventHandler;
+import cucumber.api.event.EventListener;
 import cucumber.api.event.EventPublisher;
 import cucumber.api.event.TestRunFinished;
 import cucumber.api.event.TestStepFinished;
 import cucumber.api.event.WriteEvent;
 import cucumber.api.formatter.AnsiEscapes;
 import cucumber.api.formatter.ColorAware;
-import cucumber.api.formatter.Formatter;
 import cucumber.api.formatter.NiceAppendable;
 
 import java.util.HashMap;
 import java.util.Map;
 
-final class ProgressFormatter implements Formatter, ColorAware {
+final class ProgressFormatter implements EventListener, ColorAware {
     private static final Map<Result.Type, Character> CHARS = new HashMap<Result.Type, Character>() {{
         put(Result.Type.PASSED, '.');
         put(Result.Type.UNDEFINED, 'U');

core/src/main/java/cucumber/runtime/formatter/RerunFormatter.java

@@ -2,10 +2,10 @@
 
 import cucumber.api.TestCase;
 import cucumber.api.event.EventHandler;
+import cucumber.api.event.EventListener;
 import cucumber.api.event.EventPublisher;
 import cucumber.api.event.TestCaseFinished;
 import cucumber.api.event.TestRunFinished;
-import cucumber.api.formatter.Formatter;
 import cucumber.api.formatter.NiceAppendable;
 import cucumber.api.formatter.StrictAware;
 
@@ -19,7 +19,7 @@
  * Formatter for reporting all failed test cases and print their locations
  * Failed means: results that make the exit code non-zero.
  */
-final class RerunFormatter implements Formatter, StrictAware {
+final class RerunFormatter implements EventListener, StrictAware {
     private final NiceAppendable out;
     private Map<String, ArrayList<Integer>> featureAndFailedLinesMapping = new HashMap<String, ArrayList<Integer>>();
     private boolean isStrict = false;