|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.jbehave.scenario.reporters.PrintStreamScenarioReporter
public class PrintStreamScenarioReporter
Scenario reporter that outputs to a PrintStream, defaulting to System.out.
The output of the reported event is also configurable via two other means:
Let's look at example of providing custom output patterns, e.g. for the
failed event.
we'd need to provide the custom pattern, say we want to have something like
"(step being executed) <<< FAILED", keyed on the method name:
Properties patterns = new Properties();
patterns.setProperty("failed", "{0} <<< {1}");
The pattern is by default processed and formatted by the
MessageFormat. Both the #format() and
#lookupPattern() methods are overrideable and a different formatter
or pattern lookup can be used by subclasses.
If the keyword "FAILED" (or any other keyword used by the reporter) needs to
be expressed in a different language, all we need to do is to provide an
instance of I18nKeyWords using the appropriate Locale, e.g.
KeyWords keywords = new I18nKeyWords(new Locale("it");
| Nested Class Summary | |
|---|---|
static class |
PrintStreamScenarioReporter.Format
|
| Field Summary | |
|---|---|
protected java.io.PrintStream |
output
|
| Constructor Summary | |
|---|---|
PrintStreamScenarioReporter()
|
|
PrintStreamScenarioReporter(KeyWords keywords)
|
|
PrintStreamScenarioReporter(java.io.PrintStream output)
|
|
PrintStreamScenarioReporter(java.io.PrintStream output,
java.util.Properties outputPatterns,
KeyWords keywords,
boolean reportErrors)
|
|
PrintStreamScenarioReporter(java.io.PrintStream output,
java.util.Properties outputPatterns,
PrintStreamScenarioReporter.Format format,
KeyWords keywords,
boolean reportErrors)
|
|
PrintStreamScenarioReporter(java.util.Properties outputPatterns)
|
|
PrintStreamScenarioReporter(java.util.Properties outputPatterns,
PrintStreamScenarioReporter.Format format)
|
|
| Method Summary | |
|---|---|
void |
afterExamples()
|
void |
afterScenario()
|
void |
afterStory()
|
void |
afterStory(boolean embeddedStory)
|
void |
beforeExamples(java.util.List<java.lang.String> steps,
ExamplesTable table)
|
void |
beforeScenario(java.lang.String title)
|
void |
beforeStory(Blurb blurb)
|
void |
beforeStory(StoryDefinition story,
boolean embeddedStory)
|
void |
dryRun()
|
protected java.lang.Object[] |
escape(PrintStreamScenarioReporter.Format format,
java.lang.Object... args)
Escapes args' string values according to format |
void |
example(java.util.Map<java.lang.String,java.lang.String> tableRow)
|
void |
examplesTable(ExamplesTable table)
|
void |
examplesTableRow(java.util.Map<java.lang.String,java.lang.String> tableRow)
|
void |
failed(java.lang.String step,
java.lang.Throwable cause)
|
protected java.lang.String |
format(java.lang.String key,
java.lang.String defaultPattern,
java.lang.Object... args)
Formats event output by key, usually equal to the method name. |
void |
givenScenarios(java.util.List<java.lang.String> givenScenarios)
|
void |
ignorable(java.lang.String step)
|
protected java.lang.String |
lookupPattern(java.lang.String key,
java.lang.String defaultPattern)
Looks up the format pattern for the event output by key, conventionally equal to the method name. |
void |
notPerformed(java.lang.String step)
|
void |
pending(java.lang.String step)
|
protected void |
print(java.lang.String text)
Prints text to output stream, replacing parameter start and end placeholders |
void |
successful(java.lang.String step)
|
protected void |
usePrintStream(java.io.PrintStream output)
Changes print stream used for output |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected java.io.PrintStream output
| Constructor Detail |
|---|
public PrintStreamScenarioReporter()
public PrintStreamScenarioReporter(java.io.PrintStream output)
public PrintStreamScenarioReporter(java.util.Properties outputPatterns)
public PrintStreamScenarioReporter(java.util.Properties outputPatterns,
PrintStreamScenarioReporter.Format format)
public PrintStreamScenarioReporter(KeyWords keywords)
public PrintStreamScenarioReporter(java.io.PrintStream output,
java.util.Properties outputPatterns,
KeyWords keywords,
boolean reportErrors)
public PrintStreamScenarioReporter(java.io.PrintStream output,
java.util.Properties outputPatterns,
PrintStreamScenarioReporter.Format format,
KeyWords keywords,
boolean reportErrors)
| Method Detail |
|---|
public void successful(java.lang.String step)
successful in interface ScenarioReporterpublic void ignorable(java.lang.String step)
ignorable in interface ScenarioReporterpublic void pending(java.lang.String step)
pending in interface ScenarioReporterpublic void notPerformed(java.lang.String step)
notPerformed in interface ScenarioReporter
public void failed(java.lang.String step,
java.lang.Throwable cause)
failed in interface ScenarioReporter
public void beforeStory(StoryDefinition story,
boolean embeddedStory)
beforeStory in interface ScenarioReporterpublic void beforeStory(Blurb blurb)
beforeStory in interface ScenarioReporterpublic void afterStory(boolean embeddedStory)
afterStory in interface ScenarioReporterpublic void afterStory()
afterStory in interface ScenarioReporterpublic void givenScenarios(java.util.List<java.lang.String> givenScenarios)
givenScenarios in interface ScenarioReporterpublic void beforeScenario(java.lang.String title)
beforeScenario in interface ScenarioReporterpublic void afterScenario()
afterScenario in interface ScenarioReporter
public void beforeExamples(java.util.List<java.lang.String> steps,
ExamplesTable table)
beforeExamples in interface ScenarioReporterpublic void example(java.util.Map<java.lang.String,java.lang.String> tableRow)
example in interface ScenarioReporterpublic void afterExamples()
afterExamples in interface ScenarioReporterpublic void examplesTable(ExamplesTable table)
examplesTable in interface ScenarioReporterpublic void examplesTableRow(java.util.Map<java.lang.String,java.lang.String> tableRow)
examplesTableRow in interface ScenarioReporterpublic void dryRun()
dryRun in interface ScenarioReporter
protected java.lang.String format(java.lang.String key,
java.lang.String defaultPattern,
java.lang.Object... args)
key - the event keydefaultPattern - the default pattern to return if a custom pattern
is not foundargs - the args used to format output
protected java.lang.Object[] escape(PrintStreamScenarioReporter.Format format,
java.lang.Object... args)
format - the Format used by the PrintStreamargs - the array of args to escape
protected java.lang.String lookupPattern(java.lang.String key,
java.lang.String defaultPattern)
MessageFormat#format() method. If no pattern is found
for key or needs to be overridden, the default pattern should be
returned.
key - the format pattern keydefaultPattern - the default pattern if no pattern is
protected void usePrintStream(java.io.PrintStream output)
output - the new PrintStream to useprotected void print(java.lang.String text)
text - the String to print
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||