mokkery-runtime/dev.mokkery.answering/Answer

Answer

@DelicateMokkeryApi

interface Answer<out T>(source)

An answer for a function call.

call with MokkeryBlockingCallScope is invoked on blocking function call.
call with MokkerySuspendCallScope is invoked on suspending function call.

Tips for providing correct implementation:

If you want to provide the same implementation for both blocking and suspending call, implement Answer.Unified instead.
If you want your answer to support only blocking or suspending calls, implement Answer.Blocking or Answer.Suspending.
Implement pure Answer if you want implement both methods separately.
Answers should not be used directly. It's a good practice to provide extension based API.

Check existing answers implementations for samples.

Inheritors

Types

Autofill

object Autofill : Answer.Unified<Any?>

Used whenever there is no defined answer for a call to mock that is in dev.mokkery.MockMode.autofill. Refer to AutofillProvider.forMockMode to read more about returned values.

Block

class Block<T>(val block: BlockingCallDefinitionScope<T>.(CallArgs) -> T) : Answer.Blocking<T> , Renderable

Calls block on call.

Blocking

interface Blocking<T> : Answer<T>

Convenience interface for blocking only answers. By default, it throws runtime exception on suspending call.

BlockSuspend

class BlockSuspend<T>(val block: suspend SuspendCallDefinitionScope<T>.(CallArgs) -> T) : Answer.Suspending<T> , Renderable

Just like Block but for suspending functions.

Const

class Const<T>(val value: T) : Answer.Unified<T> , Renderable

Returns value on call.

Sequential

interface Sequential<T> : Answer<T>

Interface for every answer that have to be called in repeat when specified in sequentially.

SequentialByIterator

class SequentialByIterator<T>(val iterator: Iterator<Answer<T>>) : Answer.Sequential<T> , Renderable

Returns results of answers from iterator until empty. It supports nested Sequential answers and calls them until they are empty.

Suspending

interface Suspending<T> : Answer<T>

Convenience interface for suspend only answers. By default, it throws runtime exception on blocking call.

Throws

class Throws(val throwable: Throwable) : Answer.Unified<Nothing> , Renderable

Throws throwable on call.

Unified

interface Unified<T> : Answer<T>

Convenience interface for answers with identical implementation for both blocking and suspending call.

Functions

call

abstract fun call(scope: MokkeryBlockingCallScope): T

Provides a return value for a blocking function call with given scope.

abstract suspend fun call(scope: MokkerySuspendCallScope): T

Provides a return value for a suspend function call with given scope.

description

open fun ~~description~~(): String

Returns human-readable answer description. By default, it returns answers $this. It's used for debugging purposes.