Package net.jqwik.api.lifecycle

Schnittstelle TryExecutionResult

@API(status=MAINTAINED,
     since="1.4.0")
public interface TryExecutionResult

Represents the result of calling a property method with a list of parameters.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Schnittstelle	Beschreibung
static enum	TryExecutionResult.Status	Status of running a single try.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
static TryExecutionResult	falsified(@Nullable Throwable throwable)	Create a result that falsified the current property and will immediately finish this property as failed.
default List<String>	footnotes()	List of footnotes to be added to failure report
static TryExecutionResult	invalid()	Create a result that calls out the current parameter list as invalid.
static TryExecutionResult	invalid(@Nullable Throwable throwable)	Create a result that calls out the current parameter list as invalid.
default boolean	isFalsified()
default boolean	isInvalid()
default boolean	isSatisfied()
static TryExecutionResult	satisfied()	Create a result that satisfies the current property with the current parameter set.
static TryExecutionResult	satisfied(boolean shouldPropertyFinishEarly)	Create a result that satisfies the current property and will immediately finish this property as successful.
boolean	shouldPropertyFinishEarly()
TryExecutionResult.Status	status()
Optional<Throwable>	throwable()	Will return Optional.empty() if status is anything but TryExecutionResult.Status.FALSIFIED.
default TryExecutionResult	withFootnotes(Collection<String> otherFootnotes)	Add one or more footnotes to be added to failure report

Methodendetails

satisfied

static TryExecutionResult satisfied()

Create a result that satisfies the current property with the current parameter set. All remaining tries to be executed.

Gibt zurück:

result instance

satisfied

static TryExecutionResult satisfied(boolean shouldPropertyFinishEarly)

Create a result that satisfies the current property and will immediately finish this property as successful.

Gibt zurück:

result instance

falsified

static TryExecutionResult falsified(@Nullable Throwable throwable)

Create a result that falsified the current property and will immediately finish this property as failed.

Parameter:

throwable - The throwable to describe the reason of falsification

Gibt zurück:

result instance

invalid

static TryExecutionResult invalid(@Nullable Throwable throwable)

Create a result that calls out the current parameter list as invalid. All remaining tries will be executed.

Parameter:

throwable - A (potentially null) exception. Usually of type TestAbortedException.

Gibt zurück:

result instance

invalid

static TryExecutionResult invalid()

Create a result that calls out the current parameter list as invalid. All remaining tries will be executed.

Gibt zurück:

result instance

isSatisfied

default boolean isSatisfied()

Gibt zurück:

true if status is satisfied

isFalsified

default boolean isFalsified()

Gibt zurück:

true if status is falsified

isInvalid

default boolean isInvalid()

Gibt zurück:

true if status is invalid

footnotes

@API(status=MAINTAINED,
     since="1.5.5")
default List<String> footnotes()

List of footnotes to be added to failure report

Gibt zurück:

list of Strings

withFootnotes

@API(status=MAINTAINED,
     since="1.5.5")
default TryExecutionResult withFootnotes(Collection<String> otherFootnotes)

Add one or more footnotes to be added to failure report

Parameter:

otherFootnotes - a list of footnotes to add

status

TryExecutionResult.Status status()

Gibt zurück:

Status enum

throwable

Optional<Throwable> throwable()

Will return Optional.empty() if status is anything but TryExecutionResult.Status.FALSIFIED.

Gibt zurück:

instance of Throwable or subtype

shouldPropertyFinishEarly

boolean shouldPropertyFinishEarly()

Gibt zurück:

true if status is satisfied and remaining tries shall be skipped