com.tngtech.jgiven.annotation.CaseDescription Maven / Gradle / Ivy
package com.tngtech.jgiven.annotation;
import java.lang.annotation.*;
import com.tngtech.jgiven.impl.params.DefaultCaseDescriptionProvider;
/**
* Use to define a description provider for scenario cases.
*
* By default, multiple cases in a parametrized scenario are described
* by just listing the parameter names with their corresponding values.
* Sometimes, however, it is useful to provide an explicit description the provides more semantic background for each case.
* This annotation can be used to define custom descriptions.
*
* @since 0.9.2
*
* @deprecated Since v0.15.0 this annotation is deprecated because it starts the argument enumeration from 0 and not from 1,
* like {@link com.tngtech.jgiven.annotation.As}. Please use {@link CaseAs}
*/
@Documented
@Inherited
@Retention( RetentionPolicy.RUNTIME )
@Target( { ElementType.METHOD, ElementType.TYPE } )
@Deprecated public @interface CaseDescription {
/**
* Dummy value to indicate that no value was set
*/
public static final String NO_VALUE = " - no value - ";
/**
* The description of the test case.
*
* Placeholders of the form {@code $i} can be used that will be filled with the values of the ith parameter, starting from 0.
*
* For example, a value {@code "Hi $0"} will be translated to {@code "Hi JGiven"} if "JGiven" is the value of the first parameter of the test method.
*/
String value() default NO_VALUE;
/**
* A custom implementation of the {@link com.tngtech.jgiven.annotation.CaseDescriptionProvider} to provide a case description.
*/
Class provider() default DefaultCaseDescriptionProvider.class;
/**
* Whether or not the arguments should be formatted to string using JGiven formatter.
* If this is set to true the list of parameter values passed to the CaseDescriptionProvider will be a list of strings,
* otherwise it will be a list of objects with the original values passed to the method.
*/
boolean formatValues() default true;
}