cucumber.api.Transpose Maven / Gradle / Ivy

Go to download

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

There is a newer version: 1.2.6

package cucumber.api;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 
 * This annotation can be specified on step definition method parameters to give Cucumber a hint
 * to transpose a DataTable into an object or list of objects. 
 * 
 * For example, if you have the following Gherkin step with a table
 * 
 *  * Given the user is
 *    | firstname	| Roberto	|
 *    | lastname	| Lo Giacco |
 *    | nationality	| Italian	|
 * 
 * 
 * Then the following Java Step Definition would convert that into an User object:
 * 
 *  * @Given("^the user is$")
 * public void the_user_is(@Transpose User user) {
 *     this.user = user;
 * }
 * 
 * 
 * 
 * This annotation also works for data tables that are transformed to a list of beans.
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.PARAMETER)
public @interface Transpose {
    boolean value() default true;
}