Package io.cucumber.plugin.event

Interface EventPublisher

  • @API(status=STABLE)
public interface EventPublisher

    • Method Detail

      • registerHandlerFor

        <T> void registerHandlerFor​(Class<T> eventType,
                            EventHandler<T> handler)
        Registers an event handler for a specific event.

        The available events types are:

        • Event - all events.
        • TestRunStarted - the first event sent.
        • TestSourceRead - sent for each feature file read, contains the feature file source.
        • SnippetsSuggestedEvent - sent for each step that could not be matched to a step definition, contains the raw snippets for the step.
        • StepDefinedEvent - sent for each step definition as it is loaded, contains the StepDefinition
        • TestCaseStarted - sent before starting the execution of a Test Case(/Pickle/Scenario), contains the Test Case
        • TestStepStarted - sent before starting the execution of a Test Step, contains the Test Step
        • EmbedEvent - calling scenario.attach in a hook triggers this event.
        • WriteEvent - calling scenario.log in a hook triggers this event.
        • TestStepFinished - sent after the execution of a Test Step, contains the Test Step and its Result.
        • TestCaseFinished - sent after the execution of a Test Case(/Pickle/Scenario), contains the Test Case and its Result.
        • TestRunFinished - the last event sent.
        Type Parameters:
        T - the event type
        Parameters:
        eventType - the event type for which the handler is being registered
        handler - the event handler
        See Also:
        Event

      • removeHandlerFor

        <T> void removeHandlerFor​(Class<T> eventType,
                          EventHandler<T> handler)
        Unregister an event handler for a specific event
        Type Parameters:
        T - the event type
        Parameters:
        eventType - the event type for which the handler is being registered
        handler - the event handler