doc / ch.tutteli.atrium.assertions.builders / AssertionGroupDescriptionAndEmptyRepresentationOption

AssertionGroupDescriptionAndEmptyRepresentationOption

interface AssertionGroupDescriptionAndEmptyRepresentationOption<out T : AssertionGroupType, R>

Option step which allows to specify the AssertionGroup.description -- Text.EMPTY is used as AssertionGroup.representation.

Properties

groupType

abstract val groupType: T

The previously defined AssertionGroup.type.

Functions

withDescription

open fun withDescription(description: String): R

Wraps the given description into an Untranslatable and uses it as AssertionGroup.description and uses Text.EMPTY as AssertionGroup.representation.

abstract fun withDescription(description: Translatable): R

Uses the given description as AssertionGroup.description and Text.EMPTY as AssertionGroup.representation.

Companion Object Functions

create

fun <T : AssertionGroupType, R> create(type: T, factory: (T, Translatable, Any) -> R): AssertionGroupDescriptionAndEmptyRepresentationOption<T, R>

Factory method to create a AssertionGroupDescriptionAndEmptyRepresentationOption step in the building process of an AssertionGroup.