FunProxy

interface FunProxy<ReturnValue, SideEffect : Function<ReturnValue>> : KMockContract.Proxy<ReturnValue, Array<out Any?>> , KMockContract.ProxyReturnValueSetter<ReturnValue> , KMockContract.ProxySideEffectBuilder<ReturnValue, SideEffect>

Shared Properties of synchronous and asynchronous functions Proxies.

Author

Matthias Geisler

Parameters

ReturnValue

the return value of the Function.

SideEffect

the function signature.

Functions

clear

common

abstract fun clear()

Clears the Proxies captured arguments

get

common

abstract operator fun get(callIndex: Int): Array<out Any?>

Alias for getArgumentsForCall

getArgumentsForCall

common

abstract fun getArgumentsForCall(callIndex: Int): Array<out Any?>

Resolves given arguments of an invocation.

returns

common

abstract infix override fun returns(value: ReturnValue)

Alias setter of returnValue.

returnsMany

common

abstract infix override fun returnsMany(values: List<ReturnValue>)

Alias setter of returnValues.

run

common

abstract infix fun run(action: SideEffect)

Alias method for sideEffect

runs

common

abstract infix fun runs(action: SideEffect): KMockContract.ProxySideEffectBuilder<ReturnValue, SideEffect>

Convenient method for multiple SideEffects, which uses under the sideEffects property.

throws

common

abstract infix fun throws(error: Throwable)

Alias setter of error.

throwsMany

common

abstract infix fun throwsMany(errors: List<Throwable>)

Alias setter of errors.

Properties

calls

common

abstract val calls: Int

Counter of the actual invocations of the Proxy.

error

common

abstract var error: Throwable

Setter/Getter in order to set/get a constant error which is thrown on the invocation of the Proxy.

errors

common

abstract var errors: List<Throwable>

Setter/Getter in order to set/get a constant error which is thrown on the invocation of the Proxy.

frozen

common

abstract val frozen: Boolean

Indicates that the proxies uses the frozen memory model.

common

abstract val id: String

Unique Id of the Proxy derived from the Interface which it build upon.

ignorableForVerification

common

abstract val ignorableForVerification: Boolean

Marks the Proxy as ignore during verification (e.g.

returnValue

common

abstract var returnValue: ReturnValue

Setter/Getter in order to set/get constant ReturnValue of the function.

returnValues

common

abstract var returnValues: List<ReturnValue>

Setter/Getter in order to set/get a List of ReturnValues of the Proxy.

sideEffect

common

abstract var sideEffect: SideEffect

Setter/Getter in order to set/get a custom SideEffect for the function.

sideEffects

common

abstract val sideEffects: KMockContract.SideEffectChainBuilder<ReturnValue, SideEffect>

SideEffectChainBuilder to chain multiple SideEffects.

throws

common

abstract var throws: Throwable

Setter/Getter in order to set/get a constant error which is thrown on the invocation of the Proxy.

throwsMany

common

abstract var throwsMany: List<Throwable>

Setter/Getter in order to set/get a constant error which is thrown on the invocation of the Proxy.

Inheritors

KMockContract

Extensions

getAllArgumentsBoxedByType

common

inline fun <T : Any> KMockContract.FunProxy<*, *>.getAllArgumentsBoxedByType(): List<List<T>>

Retrieves arguments for given type of FunProxy, while boxing them in sub lists for each call.

getAllArgumentsByType

common

inline fun <T : Any> KMockContract.FunProxy<*, *>.getAllArgumentsByType(): List<T>

Retrieves arguments for given type of FunProxy.

getArgumentsByType

common

inline fun <T : Any> KMockContract.FunProxy<*, *>.getArgumentsByType(callIndex: Int): List<T>

Retrieves arguments of a call at a given index for a given type of FunProxy.