doc / ch.tutteli.atrium.domain.builders.creating.changers / SubjectChangerBuilder / DescriptionRepresentationStep

DescriptionRepresentationStep

interface DescriptionRepresentationStep<T>
Deprecated: Use SubjectChangerBuilder.DescriptionRepresentationStep from atrium-logic; will be removed with 1.0.0

Step which allows to specify the description and representation of the change.

Parameters

T - the type of the current subject.

Properties

originalExpect

abstract val originalExpect: Expect<T>

The previously specified assertion container to which the new Expect will delegate assertion checking.

Functions

downCastTo

open fun <TSub : Any> downCastTo(subType: KClass<TSub>): SubjectChangerBuilder.FailureHandlerOption<T, TSub>

Uses DescriptionAnyAssertion.IS_A as description of the change, the given subType as representation and tries to perform a down-cast of originalExpect's Expect.maybeSubject to the given type TSub

withDescriptionAndRepresentation

open fun withDescriptionAndRepresentation(description: String, representation: Any?): SubjectChangerBuilder.TransformationStep<T>

Uses the given description and representation to represent the change by delegating to the other overload which expects a Translatable instead of a String.

abstract fun withDescriptionAndRepresentation(description: Translatable, representation: Any?): SubjectChangerBuilder.TransformationStep<T>

Uses the given description and representation to represent the change. Moreover, subsequent options in the building step allow to define rules when the change cannot be applied, in such a case an alternative description and representation might be used (depending on the implementation and chosen options).

Companion Object Functions

create

fun <T> create(originalAssertionContainer: Expect<T>): SubjectChangerBuilder.DescriptionRepresentationStep<T>

Creates a DescriptionRepresentationStep in the context of the SubjectChangerBuilder.