doc / ch.tutteli.atrium.api.cc.infix.en_UK / returnValueOf

returnValueOf

fun <T : Any, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction0<TReturnValue>): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction0<TReturnValue>, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

Exceptions

AssertionError - Might throw an AssertionError if an additionally created Assertion (by calling assertionCreator) does not hold.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction1<T1, TReturnValue>, arg1: T1): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction1<T1, TReturnValue>, arg1: T1, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

Exceptions

AssertionError - Might throw an AssertionError if an additionally created Assertion (by calling assertionCreator) does not hold.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, T2, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction2<T1, T2, TReturnValue>, arg1: T1, arg2: T2): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1 and arg2, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, T2, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction2<T1, T2, TReturnValue>, arg1: T1, arg2: T2, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1 and arg2, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

Exceptions

AssertionError - Might throw an AssertionError if an additionally created Assertion (by calling assertionCreator) does not hold.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, T2, T3, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction3<T1, T2, T3, TReturnValue>, arg1: T1, arg2: T2, arg3: T3): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2 and arg3, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, T2, T3, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction3<T1, T2, T3, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2 and arg3, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

Exceptions

AssertionError - Might throw an AssertionError if an additionally created Assertion (by calling assertionCreator) does not hold.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, T2, T3, T4, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2, arg3 and arg4, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, T2, T3, T4, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction4<T1, T2, T3, T4, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2, arg3 and arg4, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

Exceptions

AssertionError - Might throw an AssertionError if an additionally created Assertion (by calling assertionCreator) does not hold.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, T2, T3, T4, T5, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2, arg3, arg4 and arg5, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.

fun <T : Any, T1, T2, T3, T4, T5, TReturnValue : Any> Assert<T>.returnValueOf(method: KFunction5<T1, T2, T3, T4, T5, TReturnValue>, arg1: T1, arg2: T2, arg3: T3, arg4: T4, arg5: T5, assertionCreator: AssertionPlant<TReturnValue>.() -> Unit): AssertionPlant<TReturnValue>

Creates an AssertionPlant, for the value returned by calling method with arg1, arg2, arg3, arg4 and arg5, which eventually adds AssertionGroups with a FeatureAssertionGroupType, containing the assertions created for the return value, to the current plant -- starting with a group consisting of the Assertions created by the assertionCreator lambda.

Exceptions

AssertionError - Might throw an AssertionError if an additionally created Assertion (by calling assertionCreator) does not hold.

Return
An AssertionPlant for the return value of the given method, using an AtriumFactory.newFeatureAssertionChecker.