Package io.qameta.allure

Interface Allure.StepContext

Enclosing class:
Allure
public static interface Allure.StepContext
Step context.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    name(String name)
    Sets step's name.
    <T> T
    parameter(String name, T value)
    Adds parameter to a step.
    default <T> T
    parameter(String name, T value, io.qameta.allure.model.Parameter.Mode mode)
    Adds parameter to a step.
    default <T> T
    parameter(String name, T value, Boolean excluded)
    Adds parameter to a step.
    default <T> T
    parameter(String name, T value, Boolean excluded, io.qameta.allure.model.Parameter.Mode mode)
    Adds parameter to a step.

  • Method Details

    • name

      void name(String name)
      Sets step's name.
      Parameters:
      name - the deserted name of step.

    • parameter

      <T> T parameter(String name, T value)
      Adds parameter to a step.
      Type Parameters:
      T - the type of value.
      Parameters:
      name - the name of parameter.
      value - the value.
      Returns:
      the value.

    • parameter

      default <T> T parameter(String name, T value, Boolean excluded)
      Adds parameter to a step.
      Type Parameters:
      T - the type of value.
      Parameters:
      name - the name of parameter.
      value - the value.
      excluded - true if parameter should be excluded from history key generation, false otherwise.
      Returns:
      the value.

    • parameter

      default <T> T parameter(String name, T value, io.qameta.allure.model.Parameter.Mode mode)
      Adds parameter to a step.
      Type Parameters:
      T - the type of value.
      Parameters:
      name - the name of parameter.
      value - the value.
      mode - the parameter's mode.
      Returns:
      the value.

    • parameter

      default <T> T parameter(String name, T value, Boolean excluded, io.qameta.allure.model.Parameter.Mode mode)
      Adds parameter to a step.
      Type Parameters:
      T - the type of value.
      Parameters:
      name - the name of parameter.
      value - the value.
      excluded - true if parameter should be excluded from history key generation, false otherwise.
      mode - the parameter's mode.
      Returns:
      the value.