io.cucumber.java.Transpose Maven / Gradle / Ivy

package io.cucumber.java;

import org.apiguardian.api.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.
 * 

 * For example, if you have the following Gherkin step with a table
 * 
 * 
 * Given the user is
 *    | firstname	| Roberto	|
 *    | lastname	| Lo Giacco |
 *    | nationality	| Italian	|
 * 
 * 
 * And a data table type to create a User
 *
 * 
 * {@code
 * @DataTableType
 * public User convert(Map entry){
 *    return new User(
 *        entry.get("firstname"),
 *        entry.get("lastname")
 *        entry.get("nationality")
 *   );
 * }
 * }
 * 
 * 
 * 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;
 * }
 * 
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.PARAMETER })
@API(status = API.Status.STABLE)
public @interface Transpose {

    boolean value() default true;

}