doc / ch.tutteli.atrium.reporting / AtriumErrorAdjusterCommon

AtriumErrorAdjusterCommon

interface AtriumErrorAdjusterCommon (source)

Defines the general contract for AtriumError adjusters which all platforms have to fulfil.

Functions

adjust

abstract fun adjust(throwable: Throwable): Unit

Adjusts the given throwable - typically this involves filtering the stack trace (stackTrace in JVM, stack in JS) in some way or another as well as the stack traces of a Throwable.cause and other stack traces (e.g. stack traces of suppressed throwable in JVM).

adjustOtherThanStacks

abstract fun adjustOtherThanStacks(throwable: Throwable): Unit

Adjusts parts of the given throwable but not its stack trace.

Inheritors

AtriumErrorAdjuster

expect interface AtriumErrorAdjuster : AtriumErrorAdjusterCommon

Responsible to adjust a given Throwable (usually an AtriumError) for improved error reporting.