Package io.qameta.allure.model

Class Parameter

java.lang.Object
io.qameta.allure.model.Parameter
All Implemented Interfaces:
Serializable
public class Parameter extends Object implements Serializable
The model object that could be used to pass information about test parameters to test results. Note that parameters with empty (blank) name will be omitted during report generation.

Parameters are used in history key generation for test results. In general words, if test's results have the same parameters they will be considered as retries. But if at least one parameter is differ (or, for example, missed) results will be considered as separate results.

You can exclude parameters from history key calculation by setting excluded property to true.

Since:
2.0
See Also:

  • Constructor Details

    • Parameter

      public Parameter()

  • Method Details

    • getName

      public String getName()
      Gets name.
      Returns:
      the name

    • setName

      public Parameter setName(String value)
      Sets name.
      Parameters:
      value - the value
      Returns:
      self for method chaining.

    • getValue

      public String getValue()
      Gets value.
      Returns:
      the value

    • setValue

      public Parameter setValue(String value)
      Sets value.
      Parameters:
      value - the value
      Returns:
      self for method chaining.

    • getExcluded

      public Boolean getExcluded()
      Gets excluded.
      Returns:
      the excluded

    • setExcluded

      public Parameter setExcluded(Boolean excluded)
      Sets excluded.
      Parameters:
      excluded - the excluded
      Returns:
      self for method chaining.

    • getMode

      public Parameter.Mode getMode()
      Gets mode.
      Returns:
      the mode

    • setMode

      public Parameter setMode(Parameter.Mode mode)
      Sets mode.
      Parameters:
      mode - the mode
      Returns:
      self for method chaining.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object