com.tngtech.jgiven.annotation.ExpectedScenarioState Maven / Gradle / Ivy

Go to download

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

JGiven core module

There is a newer version: 1.3.1

package com.tngtech.jgiven.annotation;

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

import com.tngtech.jgiven.annotation.ScenarioState.Resolution;

/**
 * Marks fields to be expected by a scenario stage.
 * The annotation behaves exactly like {@link ScenarioState},
 * but better indicates the usage of a field.
 */
@Documented
@Retention( RetentionPolicy.RUNTIME )
@Target( ElementType.FIELD )
public @interface ExpectedScenarioState {
    Resolution resolution() default Resolution.AUTO;

    /**
     * Marks this state as required for the stage. If in this case the state isn't provided, a
     * {@code JGivenMissingRequiredScenarioStateException} will be thrown.
     *
     * @since 0.14.0
     */
    boolean required() default false;
}