io.cucumber.java.sv

Annotation Type När

@Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Documented
 @API(status=STABLE)
public @interface När

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.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value A cucumber or regular expression.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
long	timeout Deprecated. use a library based solution instead. E.g. Awaitility or JUnit 5s Assertions.assertTimeout.

Element Detail

value

public abstract String value

A cucumber or regular expression.

Returns:

a cucumber or regular expression

timeout

@Deprecated
public abstract long timeout

Deprecated. use a library based solution instead. E.g. Awaitility or JUnit 5s Assertions.assertTimeout.

Duration in milliseconds this step is allowed to run. Cucumber will mark the step as failed when exceeded. When the maximum duration is exceeded the thread will receive an in interrupt. Note: if the interrupt is ignored cucumber will wait for the this hook to finish.

Returns:

timeout in milliseconds. 0 (default) means no restriction.

Default:

0L