algoutils-tutor/org.tudalgo.algoutils.tutor.general.assertions.basic/BasicResult

BasicResult

public abstract class BasicResult<RT extends Result<RT, AT, TT, ET>, AT extends Actual, TT extends Test<TT, ET, RT, AT>, ET extends Expected> implements Result<RT, AT, TT, ET>(source)

An abstract basic implementation of a test.

Author

Dustin Glaser

Parameters

<TT>

the type of the test

<ET>

the type of the expected behavior

<RT>

the type of the result

<AT>

the type of the actual behavior

Inheritors

BasicResultOfCall

BasicResultOfExceptionalCall

BasicResultOfObject

BasicResultOfFail

Constructors

BasicResult

protected void BasicResult(Environment environment, TT test, AT actual, Throwable exception)

Constructs a new result with the given environment, test, actual behavior, exception and state if the test was successful.

Types

Builder

public abstract class Builder<RT extends Result<RT, AT, TT, ET>, AT extends Actual, TT extends Test<TT, ET, RT, AT>, ET extends Expected, BT extends Result.Builder<RT, AT, TT, ET, BT>> implements Result.Builder<RT, AT, TT, ET, BT>

Properties

actual

protected final AT actual

environment

protected final Environment environment

exception

protected final Throwable exception

test

protected final TT test

Functions

actual

public AT actual()

Returns the actual of this result.

cause

public Throwable cause()

If this result is not successful due to an exception, this method returns the causing exception.

check

public RT check(Context context, PreCommentSupplier<? super RT> preCommentSupplier)

If this result is not successful, this method throws an AssertionFailedError informing about the failure.

expected

public ET expected()

Returns the expected behavior of this result.

successful

public boolean successful()

Returns if the test was successful.

test

public TT test()

Returns the test this result belongs to.