NullStoryReporter.java

  1. package org.jbehave.core.reporters;

  2. import java.util.List;
  3. import java.util.Map;

  4. import org.jbehave.core.model.ExamplesTable;
  5. import org.jbehave.core.model.GivenStories;
  6. import org.jbehave.core.model.Lifecycle;
  7. import org.jbehave.core.model.Narrative;
  8. import org.jbehave.core.model.OutcomesTable;
  9. import org.jbehave.core.model.Scenario;
  10. import org.jbehave.core.model.Step;
  11. import org.jbehave.core.model.Story;
  12. import org.jbehave.core.model.StoryDuration;
  13. import org.jbehave.core.steps.StepCollector.Stage;
  14. import org.jbehave.core.steps.StepCreator.PendingStep;
  15. import org.jbehave.core.steps.Timing;

  16. /**
  17.  * <p>
  18.  * <a href="http://en.wikipedia.org/wiki/Null_Object_pattern">Null-object</a> implementation of
  19.  * {@link StoryReporter}. Users can subclass it and can override only the method that they
  20.  * are interested in.
  21.  * </p>
  22.  */
  23. public class NullStoryReporter implements StoryReporter {

  24.     @Override
  25.     public void beforeStoriesSteps(Stage stage) {
  26.         // Do nothing by default
  27.     }

  28.     @Override
  29.     public void afterStoriesSteps(Stage stage) {
  30.         // Do nothing by default
  31.     }

  32.     @Override
  33.     public void beforeStep(Step step) {
  34.         // Do nothing by default
  35.     }

  36.     @Override
  37.     public void successful(String step) {
  38.         // Do nothing by default
  39.     }

  40.     @Override
  41.     public void ignorable(String step) {
  42.         // Do nothing by default
  43.     }

  44.     @Override
  45.     public void comment(String step) {
  46.         // Do nothing by default
  47.     }

  48.     @Override
  49.     public void pending(PendingStep step) {
  50.         // Do nothing by default
  51.     }

  52.     @Override
  53.     @Deprecated
  54.     public void pending(String step) {
  55.         // Do nothing by default
  56.     }

  57.     @Override
  58.     public void notPerformed(String step) {
  59.         // Do nothing by default
  60.     }

  61.     @Override
  62.     public void failed(String step, Throwable cause) {
  63.         // Do nothing by default
  64.     }

  65.     @Override
  66.     public void failedOutcomes(String step, OutcomesTable table) {
  67.         // Do nothing by default
  68.     }

  69.     @Override
  70.     public void storyExcluded(Story story, String filter) {
  71.         // Do nothing by default
  72.     }

  73.     @Override
  74.     public void beforeStory(Story story, boolean givenStory) {
  75.         // Do nothing by default
  76.     }

  77.     @Override
  78.     public void storyCancelled(Story story, StoryDuration storyDuration) {
  79.         // Do nothing by default
  80.     }

  81.     @Override
  82.     public void afterStory(boolean givenStory) {
  83.         // Do nothing by default
  84.     }

  85.     @Override
  86.     public void beforeScenarios() {
  87.         // Do nothing by default
  88.     }

  89.     @Override
  90.     public void afterScenarios() {
  91.         // Do nothing by default
  92.     }

  93.     @Override
  94.     public void narrative(final Narrative narrative) {
  95.         // Do nothing by default
  96.     }

  97.     @Override
  98.     public void lifecycle(Lifecycle lifecycle) {
  99.         // Do nothing by default
  100.     }

  101.     @Override
  102.     public void beforeStorySteps(Stage stage, Lifecycle.ExecutionType type) {
  103.         // Do nothing by default
  104.     }

  105.     @Override
  106.     public void afterStorySteps(Stage stage, Lifecycle.ExecutionType type) {
  107.         // Do nothing by default
  108.     }

  109.     @Override
  110.     public void beforeScenarioSteps(Stage stage, Lifecycle.ExecutionType type) {
  111.         // Do nothing by default
  112.     }

  113.     @Override
  114.     public void afterScenarioSteps(Stage stage, Lifecycle.ExecutionType type) {
  115.         // Do nothing by default
  116.     }

  117.     @Override
  118.     public void beforeComposedSteps() {
  119.         // Do nothing by default
  120.     }

  121.     @Override
  122.     public void afterComposedSteps() {
  123.         // Do nothing by default
  124.     }

  125.     @Override
  126.     public void beforeGivenStories() {
  127.         // Do nothing by default
  128.     }

  129.     @Override
  130.     public void givenStories(GivenStories givenStories) {
  131.         // Do nothing by default
  132.     }

  133.     @Override
  134.     public void givenStories(List<String> storyPaths) {
  135.         // Do nothing by default
  136.     }

  137.     @Override
  138.     public void afterGivenStories() {
  139.         // Do nothing by default
  140.     }

  141.     @Override
  142.     public void beforeScenario(Scenario scenario) {
  143.         // Do nothing by default
  144.     }

  145.     @Override
  146.     public void scenarioExcluded(Scenario scenario, String filter) {
  147.         // Do nothing by default
  148.     }

  149.     @Override
  150.     public void afterScenario(Timing timing) {
  151.         // Do nothing by default
  152.     }

  153.     @Override
  154.     public void beforeExamples(List<String> steps, ExamplesTable table) {
  155.         // Do nothing by default
  156.     }

  157.     @Override
  158.     public void example(Map<String, String> tableRow, int exampleIndex) {
  159.         // Do nothing by default
  160.     }

  161.     @Override
  162.     public void afterExamples() {
  163.         // Do nothing by default
  164.     }

  165.     @Override
  166.     public void dryRun() {
  167.         // Do nothing by default
  168.     }

  169.     @Override
  170.     public void pendingMethods(List<String> methods) {
  171.         // Do nothing by default
  172.     }

  173.     @Override
  174.     public void restarted(String step, Throwable cause) {
  175.         // Do nothing by default
  176.     }

  177.     @Override
  178.     public void restartedStory(Story story, Throwable cause) {
  179.         // Do nothing by default
  180.     }
  181. }