How to use example method of net.serenitybdd.jbehave.SerenityReporter class

...505    @Override506    public void givenStories(List<String> strings) {507        logger.debug("givenStories {}", strings);508    }509    int exampleCount = 0;510    @Override511    public void beforeExamples(List<String> steps, ExamplesTable table) {512        logger.debug("beforeExamples {} {}", steps, table);513        if (givenStoryMonitor.isInGivenStory()) {514            return;515        }516        exampleCount = 0;517        StepEventBus.getEventBus().useExamplesFrom(serenityTableFrom(table));518    }519    private DataTable serenityTableFrom(ExamplesTable table) {520        String scenarioOutline = scenarioOutlineFrom(currentScenario());521        return DataTable.withHeaders(table.getHeaders())522                .andScenarioOutline(scenarioOutline)523                .andMappedRows(table.getRows())524                .build();525    }526    private String scenarioOutlineFrom(Scenario scenario) {527        StringBuilder outline = new StringBuilder();528        for (String step : scenario.getSteps()) {529            outline.append(step.trim()).append(System.lineSeparator());530        }531        return outline.toString();532    }533    @Override534    public void example(Map<String, String> tableRow, int exampleIndex) {535        StepEventBus.getEventBus().clearStepFailures();536        if (givenStoryMonitor.isInGivenStory()) {537            return;538        }539        if (executingExamples()) {540            finishExample();541        }542        exampleCount++;543        startExample(tableRow);544    }545    private void startExample(Map<String, String> data) {546        StepEventBus.getEventBus().exampleStarted(data);547    }548    private void finishExample() {549        StepEventBus.getEventBus().exampleFinished();550    }551    private boolean executingExamples() {552        return (exampleCount > 0);553    }554    @Override555    public void afterExamples() {556        if (givenStoryMonitor.isInGivenStory()) {557            return;558        }559        finishExample();560    }561    @Override562    public void beforeStep(String stepTitle) {563        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle(stepTitle));564    }565    @Override566    public void successful(String title) {567        if (annotatedResultTakesPriority()) {568            processAnnotatedResult();569        } else {570            StepEventBus.getEventBus().updateCurrentStepTitle(normalized(title));571            StepEventBus.getEventBus().stepFinished();572        }573    }574    private void processAnnotatedResult() {575        TestResult forcedResult = StepEventBus.getEventBus().getForcedResult().get();576        switch (forcedResult) {577            case PENDING:578                StepEventBus.getEventBus().stepPending();579                break;580            case IGNORED:581                StepEventBus.getEventBus().stepIgnored();582                break;583            case SKIPPED:584                StepEventBus.getEventBus().stepIgnored();585                break;586            default:587                StepEventBus.getEventBus().stepIgnored();588        }589    }590    private boolean annotatedResultTakesPriority() {591        return StepEventBus.getEventBus().getForcedResult().isPresent();592    }593    @Override594    public void ignorable(String title) {595        StepEventBus.getEventBus().updateCurrentStepTitle(normalized(title));596        StepEventBus.getEventBus().stepIgnored();597    }598    @Override599    public void comment(String step) {600        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle(step));601        StepEventBus.getEventBus().stepIgnored();602    }603    @Override604    public void pending(String stepTitle) {605        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle(normalized(stepTitle)));606        StepEventBus.getEventBus().stepPending();607    }608    @Override609    public void notPerformed(String stepTitle) {610        StepEventBus.getEventBus().stepStarted(ExecutedStepDescription.withTitle(normalized(stepTitle)));611        StepEventBus.getEventBus().stepIgnored();612    }613    @Override614    public void failed(String stepTitle, Throwable cause) {615        if (!StepEventBus.getEventBus().testSuiteHasStarted()) {616            declareOutOfSuiteFailure();617        }618        if (!errorOrFailureRecordedForStep(cause.getCause())) {619            StepEventBus.getEventBus().updateCurrentStepTitle(stepTitle);620            Throwable rootCause = new RootCauseAnalyzer(cause.getCause()).getRootCause().toException();621            if (isAssumptionFailure(rootCause)) {622                StepEventBus.getEventBus().assumptionViolated(rootCause.getMessage());623            } else {624                StepEventBus.getEventBus().stepFailed(new StepFailure(ExecutedStepDescription.withTitle(normalized(stepTitle)), rootCause));625            }626        }627    }628    private void declareOutOfSuiteFailure() {629        String storyName = !storyStack.isEmpty() ? storyStack.peek().getName() : "Before or After Story";630        String storyId = !storyStack.isEmpty() ? storyStack.peek().getPath() : null;631        StepEventBus.getEventBus().testStarted(storyName, storyId);632    }633    private boolean isAssumptionFailure(Throwable rootCause) {634        return (AssumptionViolatedException.class.isAssignableFrom(rootCause.getClass()));635    }636    public List<String> processExcludedByFilter(final Story story, final Set<String> exclude) {637        final Meta storyMeta = story.getMeta();638        final List<Scenario> processing = new LinkedList<>();639        final List<String> processed = new LinkedList<>();640        if (isSkipped(storyMeta) || isIgnored(storyMeta)) { //this story should be excluded by filter641            processing.addAll(story.getScenarios());642        } else {643            for (Scenario scenario : story.getScenarios()) {644                final Meta scenarioMeta = scenario.getMeta();645                if (isSkipped(scenarioMeta) || isIgnored(scenarioMeta)) { //this scenario should be excluded by filter646                    processing.add(scenario);647                }648            }649        }650        if (processing.size() > 0) {651            final Story beforeStory = new Story();652            beforeStory.namedAs(BEFORE_STORIES);653            final Story afterStory = new Story();654            afterStory.namedAs(AFTER_STORIES);655            final Narrative narrative = story.getNarrative();656            beforeStory(beforeStory, false);657            afterStory(false);658            beforeStory(story, false);659            narrative(narrative);660            for (final Scenario filtered : processing) {661                final String scenarioKey = scenarioKey(story, filtered);662                if (!exclude.contains(scenarioKey)) {663                    beforeScenario(filtered);664                    final List<String> steps = filtered.getSteps();665                    if (ExamplesTable.EMPTY == filtered.getExamplesTable() || filtered.getExamplesTable().getRows().size() == 0) {666                        for (final String step : steps) {667                            beforeStep(step);668                            successful(step);669                        }670                    } else {671                        final ExamplesTable examples = filtered.getExamplesTable();672                        beforeExamples(steps, examples);673                        for (final Map<String, String> row : examples.getRows()) {674                            example(row);675                            for (final String step : steps) {676                                beforeStep(step);677                                successful(step);678                            }679                        }680                        afterExamples();681                    }682                    afterScenario();683                    processed.add(scenarioKey(story, filtered));684                }685            }686            afterStory(false);687            beforeStory(afterStory, false);688            afterStory(false);...

1import net.serenitybdd.jbehave.SerenityReporter;2public class Example {3    public void exampleMethod() {4        SerenityReporter reporter = new SerenityReporter();5        reporter.example("example", "example", "example");6    }7}8The example() method of the SerenityReporter class has the following signature:9public void example(Map<String, String> tableRow);10The example() method of the SerenityReporter class has the following signature:11public void example(Map<String, String> tableRow);12public class MyTable {13    private String name;14    private String value;15    public MyTable(String name, String value) {16        this.name = name;17        this.value = value;18    }19    public String getName() {20        return name;21    }22    public String getValue() {23        return value;24    }25}26public class MySteps {27    private final SerenityReporter reporter = new SerenityReporter();28    @Given("the following data: $data")29    public void givenTheFollowingData(Map<String, String> data) {30        MyTable table = new MyTable(data.get("name"), data.get("value"));31        reporter.example(table);32    }33}34The example() method of the SerenityReporter class has the following signature:35public void example(Object example);36The example() method of the SerenityReporter class has the following signature:37public void example(Object example);38public class MySteps {39    private final SerenityReporter reporter = new SerenityReporter();40    @Given("the following data: $data")41    public void givenTheFollowingData(Map<String, String> data) {42        MyTable table = new MyTable(data.get("name"), data.get("value"));43        reporter.example(table);44    }45}46The example() method of the SerenityReporter class has the following signature

1    public void runSerenityReporterExample() {2        SerenityReporter reporter = new SerenityReporter();3        reporter.example(null, null, null, null);4    }5    public void runSerenityReporterExample() {6        SerenityReporter reporter = new SerenityReporter();7        reporter.example(null, null, null, null);8    }9    public void runSerenityReporterExample() {10        SerenityReporter reporter = new SerenityReporter();11        reporter.example(null, null, null, null);12    }13    public void runSerenityReporterExample() {14        SerenityReporter reporter = new SerenityReporter();15        reporter.example(null, null, null, null);16    }17    public void runSerenityReporterExample() {18        SerenityReporter reporter = new SerenityReporter();19        reporter.example(null, null, null, null);20    }21    public void runSerenityReporterExample() {22        SerenityReporter reporter = new SerenityReporter();23        reporter.example(null, null, null, null);24    }25    public void runSerenityReporterExample() {26        SerenityReporter reporter = new SerenityReporter();27        reporter.example(null, null, null, null);28    }29    public void runSerenityReporterExample() {30        SerenityReporter reporter = new SerenityReporter();31        reporter.example(null, null, null, null);32    }

1import net.serenitybdd.jbehave.SerenityReporter;2public class MyStepDefinitions {3    @Given("I have a step that takes a screenshot")4    public void iHaveAStepThatTakesAScreenshot() {5        SerenityReporter reporter = new SerenityReporter();6        reporter.example("Screenshot", "screenshot", reporter.screenshot());7    }8}9import net.thucydides.core.reports.html.HtmlAggregateStoryReporter;10public class MyStepDefinitions {11    @Given("I have a step that takes a screenshot")12    public void iHaveAStepThatTakesAScreenshot() {13        HtmlAggregateStoryReporter reporter = new HtmlAggregateStoryReporter();14        reporter.example("Screenshot", "screenshot", reporter.screenshot());15    }16}17import net.thucydides.core.annotations.Screenshot;18public class MyStepDefinitions {19    @Given("I have a step that takes a screenshot")20    public void iHaveAStepThatTakesAScreenshot() {21    }22}23import net.thucydides.core.annotations.Screenshot;24public class MyStepDefinitions {25    @Given("I have a step that takes a screenshot")26    @Screenshot(name="My screenshot")27    public void iHaveAStepThatTakesAScreenshot() {28    }29}30import net.thucydides.core.annotations.Screenshot;31public class MyStepDefinitions {32    @Given("I have a step that takes a screenshot")33    @Screenshot(name="My screenshot", type=ScreenshotType.BROWSER)34    public void iHaveAStepThatTakesAScreenshot() {35    }36}

1SerenityReporter.reportStep("This is a message", StepEventBus.getEventBus().getCurrentStep().get().getDuration());2SerenityReporter.reportStep("This is a message", StepEventBus.getEventBus().getCurrentStep().get().getDuration());3SerenityReporter.reportStep("This is a message", StepEventBus.getEventBus().getCurrentStep().get().getDuration());4SerenityReporter.reportStep("This is a message", StepEventBus.getEventBus().getCurrentStep().get().getDuration());5SerenityReporter.reportStep("This is a message", StepEventBus.getEventBus().getCurrentStep().get().getDuration());6SerenityReporter.reportStep("This is a message", StepEventBus.getEventBus().getCurrentStep().get().getDuration());7SerenityReporter.reportStep("This is a message", StepEventBus.getEventBus().getCurrentStep().get().getDuration());8SerenityReporter.reportStep("This is a message", StepEventBus.getEventBus().getCurrentStep().get().getDuration());9SerenityReporter.reportStep("This is a message", StepEventBus.getEventBus().getCurrentStep().get().getDuration());

1public class MySteps extends SerenityReporter {2    @Then("I should see the screenshot")3    public void thenIShouldSeeTheScreenshot() {4        example("Screenshot", "This is a screenshot", "screenshot.png");5    }6}7public class MySteps extends SerenityReporter {8    @Then("I should see the screenshot")9    public void thenIShouldSeeTheScreenshot() {10        example("Screenshot", "This is a screenshot", "screenshot.png");11    }12}13public class MySteps extends SerenityReporter {14    @Then("I should see the screenshot")15    public void thenIShouldSeeTheScreenshot() {16        example("Screenshot", "This is a screenshot", "screenshot.png");17    }18}19public class MySteps extends SerenityReporter {20    @Then("I should see the screenshot")21    public void thenIShouldSeeTheScreenshot() {22        example("Screenshot", "This is a screenshot", "screenshot.png");23    }24}

1reporter.example("name", new ExampleTable(" |a|b| |1|2| |3|4|"));2reporter.example("name", new ExampleTable(" |a|b| |1|2| |3|4|"));3package net.serenitybdd.jbehave;4import net.thucydides.core.model.DataTable;5import net.thucydides.core.model.DataTableRow;6import net.thucydides.core.model.ExamplesTable;7import net.thucydides.core.model.ExamplesTableFactory;8import net.thucydides.core.model.Story;9import net.thucydides.core.model.TestOutcome;10import net.thucydides.core.model.TestResult;11import net.thucydides.core.model.TestStep;12import net.thucydides.core.model.TestTag;13import net.thucydides.core.model.TestType;14import net.thucydides.core.model.UserStory;15import net.thucydides.core.reports.TestOutcomes;16import net.thucydides.core.steps.StepEventBus;17import net.thucydides.core.steps.StepFailure;18import net.thucydides.core.util.EnvironmentVariables;19import net.thucydides.core.util.NameConverter;20import net.thucydides.core.util.SystemEnvironmentVariables;21import org.apache.commons.lang3.StringUtils;22import org.jbehave.core.configuration.Keywords;23import org.jbehave.core.failures.UUIDExceptionWrapper;24import org.jbehave.core.model.ExamplesTable;25import org.jbehave.core.model.GivenStories;26import org.jbehave.core.model.GivenStories.Value;27import org.jbehave.core.model.OutcomesTable.Outcome;28import org.jbehave.core.model.OutcomesTable.Outcomes;29import org.jbehave.core.model.Scenario;30import org.jbehave.core.model.Story;31import org.jbehave.core.model.StoryDuration;32import org.jbehave.core.model.TableTransformers;33import org.jbehave.core.model.TableTransformers.TableTransformer;34import org.jbehave.core.model.TableTransformers.TableTransformerByType;35import org.jbehave.core.model.TableTransformers.TableTransformerByTypeAndProperty;36import org.jbehave.core.model.TableTransformers.TableTransformerByTypeAndPropertyAndColumn;