Package io.qameta.allure

Annotation Interface Param

@Documented @Inherited @Retention(RUNTIME) @Target(PARAMETER) public @interface Param
This annotation used to add parameters to results from method parameters.
See Also:

  • Optional Element Summary

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

  • Element Details

    • value

      String value
      Alias for name(). Overrides value, specified in name().
      Default:
      ""

    • name

      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

      io.qameta.allure.model.Parameter.Mode mode
      The parameter mode.
      Returns:
      the parameter mode.
      Default:
      DEFAULT

    • excluded

      boolean excluded
      Set it to true to exclude the parameter from historyKey generation.
      Returns:
      true if parameter is excluded, false otherwise.
      Default:
      false