Package org.jbehave.core.reporters

Interface StoryReporter

All Known Implementing Classes:

ANSIConsoleOutput, ConcurrentStoryReporter, ConsoleOutput, ContextStoryReporter, DelegatingStoryReporter, HtmlOutput, HtmlTemplateOutput, IdeOnlyConsoleOutput, JsonOutput, JsonTemplateOutput, JUnit4StoryReporter, NullStoryReporter, PostStoryStatisticsCollector, PrintStreamOutput, SilentSuccessFilter, StepFailureDecorator, TeamCityConsoleOutput, TemplateableOutput, TxtOutput, XmlOutput, XmlTemplateOutput

public interface StoryReporter

Allows the runner to report the state of running stories

Author:

Elizabeth Keogh, Mauro Talevi

Method Summary

Modifier and Type	Method	Description
void	afterComposedSteps()
void	afterExamples()
void	afterGivenStories()
void	afterScenario(Timing timing)
void	afterScenarios()
void	afterScenarioSteps(StepCollector.Stage stage, Lifecycle.ExecutionType type)
void	afterStoriesSteps(StepCollector.Stage stage)
void	afterStory(boolean givenOrRestartingStory)
void	afterStorySteps(StepCollector.Stage stage, Lifecycle.ExecutionType type)
void	beforeComposedSteps()
void	beforeExamples(List<String> steps, ExamplesTable table)
void	beforeGivenStories()
void	beforeScenario(Scenario scenario)
void	beforeScenarios()
void	beforeScenarioSteps(StepCollector.Stage stage, Lifecycle.ExecutionType type)
void	beforeStep(Step step)
void	beforeStoriesSteps(StepCollector.Stage stage)
void	beforeStory(Story story, boolean givenStory)
void	beforeStorySteps(StepCollector.Stage stage, Lifecycle.ExecutionType type)
void	comment(String step)
void	dryRun()
void	example(Map<String,String> tableRow, int exampleIndex)
void	failed(String step, Throwable cause)
void	failedOutcomes(String step, OutcomesTable table)
void	givenStories(List<String> storyPaths)
void	givenStories(GivenStories givenStories)
void	ignorable(String step)
void	lifecycle(Lifecycle lifecycle)
void	narrative(Narrative narrative)
void	notPerformed(String step)
void	pending(String step)	Deprecated. Use pending(PendingStep)
void	pending(StepCreator.PendingStep step)
void	pendingMethods(List<String> methods)	Deprecated. pendingMethod info is added as a part of each pending step pending(PendingStep)
void	restarted(String step, Throwable cause)
void	restartedStory(Story story, Throwable cause)
void	scenarioExcluded(Scenario scenario, String filter)
void	storyCancelled(Story story, StoryDuration storyDuration)
void	storyExcluded(Story story, String filter)
void	successful(String step)

Method Details

beforeStoriesSteps

void beforeStoriesSteps(StepCollector.Stage stage)

afterStoriesSteps

void afterStoriesSteps(StepCollector.Stage stage)

storyExcluded

void storyExcluded(Story story,
 String filter)

storyCancelled

void storyCancelled(Story story,
 StoryDuration storyDuration)

beforeStory

void beforeStory(Story story,
 boolean givenStory)

afterStory

void afterStory(boolean givenOrRestartingStory)

beforeScenarios

void beforeScenarios()

afterScenarios

void afterScenarios()

narrative

void narrative(Narrative narrative)

lifecycle

void lifecycle(Lifecycle lifecycle)

beforeStorySteps

void beforeStorySteps(StepCollector.Stage stage,
 Lifecycle.ExecutionType type)

afterStorySteps

void afterStorySteps(StepCollector.Stage stage,
 Lifecycle.ExecutionType type)

beforeScenarioSteps

void beforeScenarioSteps(StepCollector.Stage stage,
 Lifecycle.ExecutionType type)

afterScenarioSteps

void afterScenarioSteps(StepCollector.Stage stage,
 Lifecycle.ExecutionType type)

beforeComposedSteps

void beforeComposedSteps()

afterComposedSteps

void afterComposedSteps()

scenarioExcluded

void scenarioExcluded(Scenario scenario,
 String filter)

beforeScenario

void beforeScenario(Scenario scenario)

afterScenario

void afterScenario(Timing timing)

beforeGivenStories

void beforeGivenStories()

givenStories

void givenStories(GivenStories givenStories)

givenStories

void givenStories(List<String> storyPaths)

afterGivenStories

void afterGivenStories()

beforeExamples

void beforeExamples(List<String> steps,
 ExamplesTable table)

example

void example(Map<String,String> tableRow,
 int exampleIndex)

afterExamples

void afterExamples()

beforeStep

void beforeStep(Step step)

successful

void successful(String step)

ignorable

void ignorable(String step)

comment

void comment(String step)

pending

void pending(StepCreator.PendingStep step)

pending

@Deprecated
void pending(String step)

Deprecated.

Use pending(PendingStep)

Report pending step

Parameters:

step - string representation of pending step

notPerformed

void notPerformed(String step)

failed

void failed(String step,
 Throwable cause)

failedOutcomes

void failedOutcomes(String step,
 OutcomesTable table)

restarted

void restarted(String step,
 Throwable cause)

restartedStory

void restartedStory(Story story,
 Throwable cause)

dryRun

void dryRun()

pendingMethods

@Deprecated
void pendingMethods(List<String> methods)

Deprecated.

pendingMethod info is added as a part of each pending step pending(PendingStep)

Report list of pending methods

Parameters:

methods - list of generated methods