Package org.tudalgo.algoutils.tutor.general.assertions.basic

Class BasicResult<RT extends Result<RT,AT,TT,ET>,AT extends Actual,TT extends Test<TT,ET,RT,AT>,ET extends Expected>

java.lang.Object

org.tudalgo.algoutils.tutor.general.assertions.basic.BasicResult<RT,AT,TT,ET>

Type Parameters:

RT - the type of the result

AT - the type of the actual behavior

TT - the type of the test

ET - the type of the expected behavior

All Implemented Interfaces:

Result<RT,AT,TT,ET>

Direct Known Subclasses:

BasicResultOfCall, BasicResultOfExceptionalCall, BasicResultOfFail, BasicResultOfObject

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

An abstract basic implementation of a test.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BasicResult.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>>

Field Summary

Fields

Modifier and Type	Field	Description
protected final AT	actual
protected final Environment	environment
protected final Exception	exception
protected final TT	test

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BasicResult(Environment environment, TT test, AT actual, Exception exception)	Constructs a new result with the given environment, test, actual behavior, exception and state if the test was successful.

Method Summary

Modifier and Type	Method	Description
AT	actual()	Returns the actual of this result.
Exception	cause()	If this result is not Result.successful() due to an exception, this method returns the causing exception.
RT	check(Context context, PreCommentSupplier<? super RT> preCommentSupplier)	If this result is not successful, this method throws an AssertionFailedError informing about the failure.
TT	test()	Returns the test this result belongs to.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.tudalgo.algoutils.tutor.general.assertions.Result

expected, successful

Field Details

environment

protected final Environment environment

test

protected final TT extends Test<TT,ET,RT,AT> test

actual

protected final AT extends Actual actual

exception

protected final Exception exception

Constructor Details

BasicResult

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

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

Parameters:

environment - the environment

test - the test

actual - the actual behavior

exception - the exception

Method Details

actual

public AT actual()

Description copied from interface: Result

Returns the actual of this result.

If the test has failed due to an exception, the actual might be null and the exception trace can be retrieved using Result.cause().

Specified by:

actual in interface Result<RT extends Result<RT,AT,TT,ET>,AT extends Actual,TT extends Test<TT,ET,RT,AT>,ET extends Expected>

Returns:

the actual result of the test or null

cause

public Exception cause()

Description copied from interface: Result

If this result is not Result.successful() due to an exception, this method returns the causing exception. Otherwise null is returned.

Specified by:

cause in interface Result<RT extends Result<RT,AT,TT,ET>,AT extends Actual,TT extends Test<TT,ET,RT,AT>,ET extends Expected>

Returns:

the exception or null

check

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

Description copied from interface: Result

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

Specified by:

check in interface Result<RT extends Result<RT,AT,TT,ET>,AT extends Actual,TT extends Test<TT,ET,RT,AT>,ET extends Expected>

Parameters:

context - the context of the test

preCommentSupplier - the function for the pre-comment

Returns:

this result

test

public TT test()

Description copied from interface: Result

Returns the test this result belongs to.

Specified by:

test in interface Result<RT extends Result<RT,AT,TT,ET>,AT extends Actual,TT extends Test<TT,ET,RT,AT>,ET extends Expected>

Returns:

the test