io.qameta.allure

Annotation Type Param

@Documented
 @Inherited
 @Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface Param

This annotation used to add parameters to results from method parameters.

See Also:

Parameter, Parameter.Mode, Allure.parameter(String, Object)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	excluded Set it to true to exclude the parameter from historyKey generation.
io.qameta.allure.model.Parameter.Mode	mode The parameter mode.
java.lang.String	name The name of parameter.
java.lang.String	value Alias for name().

Element Detail

value

public abstract java.lang.String value

Alias for name(). Overrides value, specified in name().

Default:

""

name

public abstract java.lang.String name

The name of parameter. Be careful, changing parameter's name may affect method signature and, as result, may get different test case generated.

If not specified, the parameter name from reflection will be used.

Returns:

the name of parameter.

Default:

""

mode

public abstract io.qameta.allure.model.Parameter.Mode mode

The parameter mode.

Returns:

the parameter mode.

Default:

io.qameta.allure.model.Parameter.Mode.DEFAULT

excluded

public abstract boolean excluded

Set it to true to exclude the parameter from historyKey generation.

Returns:

true if parameter is excluded, false otherwise.

Default:

false