io.cucumber.plugin.event.PickleStepTestStep Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cucumber-plugin Show documentation

Plugin interface for Cucumber-JVM

There is a newer version: 7.18.1

package io.cucumber.plugin.event;

import org.apiguardian.api.API;

import java.net.URI;
import java.util.List;

/**
 * A pickle test step matches a line in a Gherkin scenario or background.
 */
@API(status = API.Status.STABLE)
public interface PickleStepTestStep extends TestStep {

    /**
     * The pattern or expression used to match the glue code to the Gherkin step.
     *
     * @return a pattern or expression
     */
    String getPattern();

    /**
     * The matched Gherkin step
     *
     * @return the matched step
     */
    Step getStep();

    /**
     * Returns the arguments provided to the step definition.
     * 
     * For example the step definition Given (.*) pickles
     * when matched with Given 15 pickles will receive
     * as argument "15".
     *
     * @return argument provided to the step definition
     */
    List getDefinitionArgument();

    /**
     * Returns arguments provided to the Gherkin step. E.g:
     * a data table or doc string.
     *
     * @return arguments provided to the gherkin step.
     * @deprecated use {@link #getStep()}
     */
    @Deprecated
    StepArgument getStepArgument();

    /**
     * The line in the feature file defining this step.
     *
     * @return a line number
     * @deprecated use {@link #getStep()}
     */
    @Deprecated
    int getStepLine();

    /**
     * A uri to to the feature of this step.
     *
     * @return a uri
     */
    URI getUri();

    /**
     * The full text of the Gherkin step.
     *
     * @return the step text
     * @deprecated use {@code #getStep()}
     */
    @Deprecated
    String getStepText();
}