doc / ch.tutteli.atrium / returnValueOf

returnValueOf

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

Creates an IAssertionPlant which immediately evaluates IAssertions using the value returned by calling method of the subject.

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckImmediately

fun <T : Any, TReturnValue : Any> IAssertionPlant<T>.returnValueOf(method: KFunction0<TReturnValue>, createAssertions: IAssertionPlant<TReturnValue>.() -> Unit): IAssertionPlant<TReturnValue>

Creates an IAssertionPlant which lazily evaluates IAssertions using the value returned by calling method of the subject.

The given createAssertions function is called after the plant has been created. It could create IAssertions for the given property which are lazily evaluated by the newly created IAssertionPlant after the call to createAssertions is made.

Exceptions

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

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckLazily

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

Creates an IAssertionPlant which immediately evaluates IAssertions using the value returned by calling method of the subject with arg1.

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckImmediately

fun <T : Any, T1, TReturnValue : Any> IAssertionPlant<T>.returnValueOf(method: KFunction1<T1, TReturnValue>, arg1: T1, createAssertions: IAssertionPlant<TReturnValue>.() -> Unit): IAssertionPlant<TReturnValue>

Creates an IAssertionPlant which lazily evaluates IAssertions using the value returned by calling method of the subject with arg1.

The given createAssertions function is called after the plant has been created. It could create IAssertions for the given property which are lazily evaluated by the newly created IAssertionPlant after the call to createAssertions is made.

Exceptions

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

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckLazily

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

Creates an IAssertionPlant which immediately evaluates IAssertions using the value returned by calling method of the subject with arg1 and arg2.

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckImmediately

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

Creates an IAssertionPlant which lazily evaluates IAssertions using the value returned by calling method of the subject with arg1 and arg2.

The given createAssertions function is called after the plant has been created. It could create IAssertions for the given property which are lazily evaluated by the newly created IAssertionPlant after the call to createAssertions is made.

Exceptions

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

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckLazily

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

Creates an IAssertionPlant which immediately evaluates IAssertions using the value returned by calling method of the subject with arg1, arg2 and arg3.

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckImmediately

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

Creates an IAssertionPlant which lazily evaluates IAssertions using the value returned by calling method of the subject with arg1, arg2 and arg3.

The given createAssertions function is called after the plant has been created. It could create IAssertions for the given property which are lazily evaluated by the newly created IAssertionPlant after the call to createAssertions is made.

Exceptions

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

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckLazily

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

Creates an IAssertionPlant which immediately evaluates IAssertions using the value returned by calling method of the subject with arg1, arg2, arg3 and arg4.

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckImmediately

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

Creates an IAssertionPlant which lazily evaluates IAssertions using the value returned by calling method of the subject with arg1, arg2, arg3 and arg4.

The given createAssertions function is called after the plant has been created. It could create IAssertions for the given property which are lazily evaluated by the newly created IAssertionPlant after the call to createAssertions is made.

Exceptions

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

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckLazily

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

Creates an IAssertionPlant which immediately evaluates IAssertions using the value returned by calling method of the subject with arg1, arg2, arg3, arg4 and arg5.

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckImmediately

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

Creates an IAssertionPlant which lazily evaluates IAssertions using the value returned by calling method of the subject with arg1, arg2, arg3, arg4 and arg5.

The given createAssertions function is called after the plant has been created. It could create IAssertions for the given property which are lazily evaluated by the newly created IAssertionPlant after the call to createAssertions is made.

Exceptions

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

Return
An IAssertionPlant for the given method, using an AtriumFactory.newFeatureAssertionChecker.

See Also

IAtriumFactory.newCheckLazily