io.cucumber.java.eo.Do Maven / Gradle / Ivy
package io.cucumber.java.eo;
import io.cucumber.java.StepDefinitionAnnotations;
import io.cucumber.java.StepDefinitionAnnotation;
import org.apiguardian.api.API;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
* To execute steps in a feature file the steps must be
* connected to executable code. This can be done by annotating
* a method with a cucumber or regular expression.
*
* The parameters extracted from the step by the expression
* along with the data table or doc string argument are provided as
* arguments to the method.
*
* The types of the parameters are determined by the cucumber or
* regular expression.
*
* The type of the data table or doc string argument is determined
* by the argument name value. When none is provided cucumber will
* attempt to transform the data table or doc string to the type
* of the last argument.
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@StepDefinitionAnnotation
@Documented
@Repeatable(Do.Dos.class)
@API(status = API.Status.STABLE)
public @interface Do {
/**
* A cucumber or regular expression.
*
* @return a cucumber or regular expression
*/
String value();
/**
* Allows the use of multiple 'Do's on a single method.
*/
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@StepDefinitionAnnotations
@Documented
@interface Dos {
Do[] value();
}
}