TxtOutput.java

  1. package org.jbehave.core.reporters;

  2. import static org.jbehave.core.reporters.PrintStreamOutput.Format.TXT;

  3. import java.io.PrintStream;
  4. import java.util.Properties;

  5. import org.jbehave.core.configuration.Keywords;
  6. import org.jbehave.core.i18n.LocalizedKeywords;

  7. /**
  8.  * <p>
  9.  * Story reporter that outputs to a PrintStream, as TXT. It extends
  10.  * {@link PrintStreamOutput}, providing TXT-based default output
  11.  * patterns, which can be overridden via the {@link
  12.  * TxtOutput (PrintStream,Properties)} constructor.
  13.  * </p>
  14.  *
  15.  * @author Mauro Talevi
  16.  */
  17. public class TxtOutput extends PrintStreamOutput {

  18.     public TxtOutput(PrintStream output) {
  19.         this(output, new Properties());
  20.     }

  21.     public TxtOutput(PrintStream output, Properties outputPatterns) {
  22.         this(output, outputPatterns, new LocalizedKeywords());
  23.     }

  24.     public TxtOutput(PrintStream output, Keywords keywords) {
  25.         this(output, new Properties(), keywords);
  26.     }

  27.     public TxtOutput(PrintStream output, Properties outputPatterns, Keywords keywords) {
  28.         this(output, outputPatterns, keywords, false);
  29.     }

  30.     public TxtOutput(PrintStream output, Properties outputPatterns,
  31.             Keywords keywords, boolean reportFailureTrace) {
  32.         this(output, outputPatterns, keywords, reportFailureTrace, false);
  33.     }

  34.     public TxtOutput(PrintStream output, Properties outputPatterns,
  35.             Keywords keywords, boolean reportFailureTrace, boolean compressFailureTrace) {
  36.         super(TXT, output, defaultPatterns(), outputPatterns, keywords, reportFailureTrace, compressFailureTrace);
  37.     }

  38.     private static Properties defaultPatterns() {
  39.         Properties patterns = new Properties();
  40.         patterns.setProperty("beforeStep", "");
  41.         patterns.setProperty("dryRun", "{0}\n");
  42.         patterns.setProperty("storyCancelled", "{0} ({1} {2} s)\n");
  43.         patterns.setProperty("beforeStory", "{1}\n({2})\n");
  44.         patterns.setProperty("afterStory", "\n");
  45.         patterns.setProperty("metaStart", "{0}\n");
  46.         patterns.setProperty("metaProperty", "{0}{1} {2}\n");    
  47.         patterns.setProperty("metaEnd", "\n");
  48.         patterns.setProperty("filter", "{0}\n");
  49.         patterns.setProperty("narrative", "{0}\n{1} {2}\n{3} {4}\n{5} {6}\n");
  50.         patterns.setProperty("lifecycleStart", "{0}\n");
  51.         patterns.setProperty("lifecycleEnd", "\n");
  52.         patterns.setProperty("lifecycleBeforeStart", "{0}\n");
  53.         patterns.setProperty("lifecycleBeforeEnd", "\n");
  54.         patterns.setProperty("lifecycleAfterStart", "{0}\n");
  55.         patterns.setProperty("lifecycleAfterEnd", "\n");
  56.         patterns.setProperty("lifecycleBeforeScopeStart", "{0} {1}\n");
  57.         patterns.setProperty("lifecycleBeforeScopeEnd", "\n");
  58.         patterns.setProperty("lifecycleAfterScopeStart", "{0} {1}\n");
  59.         patterns.setProperty("lifecycleAfterScopeEnd", "\n");
  60.         patterns.setProperty("lifecycleOutcomeStart", "{0} {1}\n");
  61.         patterns.setProperty("lifecycleOutcomeEnd", "\n");
  62.         patterns.setProperty("lifecycleMetaFilter", "{0} {1}\n");
  63.         patterns.setProperty("lifecycleStep", "{0}\n");
  64.         patterns.setProperty("beforeBeforeStoriesSteps", "BeforeStories\n");
  65.         patterns.setProperty("afterBeforeStoriesSteps", "\n");
  66.         patterns.setProperty("beforeAfterStoriesSteps", "AfterStories\n");
  67.         patterns.setProperty("afterAfterStoriesSteps", "\n");
  68.         patterns.setProperty("beforeBeforeSystemStorySteps", "BeforeSystemStorySteps\n");
  69.         patterns.setProperty("afterBeforeSystemStorySteps", "\n");
  70.         patterns.setProperty("beforeAfterSystemStorySteps", "AfterSystemStorySteps\n");
  71.         patterns.setProperty("afterAfterSystemStorySteps", "\n");
  72.         patterns.setProperty("beforeBeforeUserStorySteps", "BeforeUserStorySteps\n");
  73.         patterns.setProperty("afterBeforeUserStorySteps", "\n");
  74.         patterns.setProperty("beforeAfterUserStorySteps", "AfterUserStorySteps\n");
  75.         patterns.setProperty("afterAfterUserStorySteps", "\n");
  76.         patterns.setProperty("beforeBeforeSystemScenarioSteps", "BeforeSystemScenarioSteps\n");
  77.         patterns.setProperty("afterBeforeSystemScenarioSteps", "\n");
  78.         patterns.setProperty("beforeAfterSystemScenarioSteps", "AfterSystemScenarioSteps\n");
  79.         patterns.setProperty("afterAfterSystemScenarioSteps", "\n");
  80.         patterns.setProperty("beforeBeforeUserScenarioSteps", "BeforeUserScenarioSteps\n");
  81.         patterns.setProperty("afterBeforeUserScenarioSteps", "\n");
  82.         patterns.setProperty("beforeAfterUserScenarioSteps", "AfterUserScenarioSteps\n");
  83.         patterns.setProperty("afterAfterUserScenarioSteps", "\n");
  84.         patterns.setProperty("beforeScenario", "{1} {2}\n");
  85.         patterns.setProperty("afterScenario", "\n");
  86.         patterns.setProperty("afterScenarioWithFailure", "\n{0}\n");
  87.         patterns.setProperty("givenStories", "{0} {1}\n");
  88.         patterns.setProperty("givenStoriesStart", "{0}\n");
  89.         patterns.setProperty("givenStory", "{0}{1}\n");
  90.         patterns.setProperty("givenStoriesEnd", "\n");
  91.         patterns.setProperty("successful", "{0}\n");
  92.         patterns.setProperty("ignorable", "{0}\n");
  93.         patterns.setProperty("comment", "{0}\n");
  94.         patterns.setProperty("pending", "{0} ({1})\n({2})\n");
  95.         patterns.setProperty("notPerformed", "{0} ({1})\n");
  96.         patterns.setProperty("failed", "{0} ({1})\n({2})\n");
  97.         patterns.setProperty("restarted", "{0} ({1})\n");
  98.         patterns.setProperty("restartedStory", "{0} ({1})\n");
  99.         patterns.setProperty("outcomesTableStart", "");
  100.         patterns.setProperty("outcomesTableHeadStart", "|");
  101.         patterns.setProperty("outcomesTableHeadCell", "{0}|");
  102.         patterns.setProperty("outcomesTableHeadEnd", "\n");
  103.         patterns.setProperty("outcomesTableBodyStart", "");
  104.         patterns.setProperty("outcomesTableRowStart", "|");
  105.         patterns.setProperty("outcomesTableCell", "{0}|");
  106.         patterns.setProperty("outcomesTableRowEnd", "\n");
  107.         patterns.setProperty("outcomesTableBodyEnd", "");
  108.         patterns.setProperty("outcomesTableEnd", "");
  109.         patterns.setProperty("beforeExamples", "{0}\n");
  110.         patterns.setProperty("examplesStep", "{0}\n");
  111.         patterns.setProperty("afterExamples", "\n");
  112.         patterns.setProperty("examplesTableStart", "\n");
  113.         patterns.setProperty("examplesTableHeadStart", "|");
  114.         patterns.setProperty("examplesTableHeadCell", "{0}|");
  115.         patterns.setProperty("examplesTableHeadEnd", "\n");
  116.         patterns.setProperty("examplesTableBodyStart", "");
  117.         patterns.setProperty("examplesTableRowStart", "|");
  118.         patterns.setProperty("examplesTableCell", "{0}|");
  119.         patterns.setProperty("examplesTableRowEnd", "\n");
  120.         patterns.setProperty("examplesTableBodyEnd", "");
  121.         patterns.setProperty("examplesTableEnd", "");
  122.         patterns.setProperty("example", "\n{0} {1}\n");
  123.         patterns.setProperty("parameterValueStart", "");
  124.         patterns.setProperty("parameterValueEnd", "");
  125.         patterns.setProperty("parameterValueNewline", "\n");    
  126.         return patterns;
  127.     }
  128. }