io.cucumber.core.backend.StepDefinition Maven / Gradle / Ivy

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

There is a newer version: 7.18.0

package io.cucumber.core.backend;

import org.apiguardian.api.API;

import java.util.List;

@API(status = API.Status.STABLE)
public interface StepDefinition extends Located {

    /**
     * Invokes the step definition. The method should raise a Throwable if the
     * invocation fails, which will cause the step to fail.
     *
     * @param  args                              The arguments for the step
     * @throws CucumberBackendException          of a failure to invoke the step
     * @throws CucumberInvocationTargetException in case of a failure in the
     *                                           step.
     */
    void execute(Object[] args) throws CucumberBackendException, CucumberInvocationTargetException;

    /**
     * @return parameter information, may not return null
     */
    List parameterInfos();

    /**
     * @return the pattern associated with this instance. Used for error
     *         reporting only.
     */
    String getPattern();

}