com.thoughtworks.gauge.BeforeScenario Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gauge-java Show documentation

Java plugin for Gauge

There is a newer version: 0.11.1

/*----------------------------------------------------------------
 *  Copyright (c) ThoughtWorks, Inc.
 *  Licensed under the Apache License, Version 2.0
 *  See LICENSE.txt in the project root for license information.
 *----------------------------------------------------------------*/
package com.thoughtworks.gauge;

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

/**
 * Methods annotated with this hook, execute before every scenario execution completes.
 * The scenario can be filtered by passing additional attributes.
 * 
 * If there is more than one method annotated with @BeforeScenario, the order of execution is as follows:
 * 

 * Hooks which are not filtered by tags.
 * 
Hooks filtered by tags.
 * 
 * If there is more than one hook of these categories, they are executed in alphabetical order based on method names.
 * 
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface BeforeScenario {

    /**
     * @return Array of tags to filter which scenarios the hook runs before.
     */
    String[] tags() default {};

    /**
     * @return OR: if hook should run for a scenario containing any of the tags provided
     * AND: if hook should run for a scenario containing all of the tags provided
     * Default is AND
     */
    Operator tagAggregation() default Operator.AND;
}