io.qameta.allure.model

Class Parameter

java.lang.Object

io.qameta.allure.model.Parameter

All Implemented Interfaces:

java.io.Serializable

public class Parameter
extends java.lang.Object
implements java.io.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:

TestResult, WithParameters, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Parameter.Mode The parameter render mode.

Constructor Summary

Constructors

Constructor and Description
Parameter()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Boolean	getExcluded() Gets excluded.
Parameter.Mode	getMode() Gets mode.
java.lang.String	getName() Gets name.
java.lang.String	getValue() Gets value.
int	hashCode()
Parameter	setExcluded(java.lang.Boolean excluded) Sets excluded.
Parameter	setMode(Parameter.Mode mode) Sets mode.
Parameter	setName(java.lang.String value) Sets name.
Parameter	setValue(java.lang.String value) Sets value.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Parameter

public Parameter()

Method Detail

getName

public java.lang.String getName()

Gets name.

Returns:

the name

setName

public Parameter setName(java.lang.String value)

Sets name.

Parameters:

value - the value

Returns:

self for method chaining.

getValue

public java.lang.String getValue()

Gets value.

Returns:

the value

setValue

public Parameter setValue(java.lang.String value)

Sets value.

Parameters:

value - the value

Returns:

self for method chaining.

getExcluded

public java.lang.Boolean getExcluded()

Gets excluded.

Returns:

the excluded

setExcluded

public Parameter setExcluded(java.lang.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(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object