doc / ch.tutteli.atrium.creating

Package ch.tutteli.atrium.creating

Everything involved in creating Assertions.

Types

AssertionPlant

interface AssertionPlant<out T : Any> : BaseAssertionPlant<T, AssertionPlant<T>>

Represents a plant for Assertions based on a non nullable subject.

AssertionPlantNullable

interface AssertionPlantNullable<out T> : BaseAssertionPlant<T, AssertionPlantNullable<T>>

Represents an assertion plant for nullable types.

AssertionPlantWithCommonFields

interface AssertionPlantWithCommonFields<out T>

An assertion plant which has CommonFields.

BaseAssertionPlant

interface BaseAssertionPlant<out T, out A : BaseAssertionPlant<T, A>>

Represents a plant for Assertions and offers methods to addAssertions to this plant.

BaseCollectingAssertionPlant

interface BaseCollectingAssertionPlant<out T, out A : BaseAssertionPlant<T, A>, out C : BaseCollectingAssertionPlant<T, A, C>> : BaseAssertionPlant<T, A>

Represents a BaseAssertionPlant which is intended to serve as receiver object for lambdas which create Assertions, in which this assertion plant collects the so created assertions.

BaseReportingAssertionPlant

interface BaseReportingAssertionPlant<out T, out A : BaseAssertionPlant<T, A>> : BaseAssertionPlant<T, A>, AssertionPlantWithCommonFields<T>

Represents a plant for Assertions and offers methods to addAssertions to this plant.

CheckingAssertionPlant

interface CheckingAssertionPlant<out T : Any> : AssertionPlant<T>

Represents a plant for Assertions and offers the possibility to check whether allAssertionsHold which have been added to this plant (since the last check).

CollectingAssertionPlant

interface CollectingAssertionPlant<out T : Any> : AssertionPlant<T>, BaseCollectingAssertionPlant<T, AssertionPlant<T>, CollectingAssertionPlant<T>>

Represents an AssertionPlant which is intended to serve as receiver object for lambdas which create Assertions, in which this assertion plant collects the so created assertions.

CollectingAssertionPlantNullable

interface CollectingAssertionPlantNullable<out T> : AssertionPlantNullable<T>, BaseCollectingAssertionPlant<T, AssertionPlantNullable<T>, CollectingAssertionPlantNullable<T>>

Represents an AssertionPlantNullable which is intended to serve as receiver object for lambdas which create Assertions, in which this assertion plant collects the so created assertions.

MaybeSubject

sealed class MaybeSubject<out T>

Represents a BaseAssertionPlant.subject which might be Present or Absent.

ReportingAssertionPlant

interface ReportingAssertionPlant<out T : Any> : AssertionPlant<T>, BaseReportingAssertionPlant<T, AssertionPlant<T>>

Represents a plant for Assertions and offers the possibility to addAssertions and to report them.

ReportingAssertionPlantNullable

interface ReportingAssertionPlantNullable<out T> : AssertionPlantNullable<T>, BaseReportingAssertionPlant<T, AssertionPlantNullable<T>>

Represents an assertion plant for nullable types and offers the possibility to addAssertions and to report them.

Annotations

AssertMarker

annotation class AssertMarker

DSL Marker for AssertionPlant (and its type alias Assert).

Exceptions

PlantHasNoSubjectException

class PlantHasNoSubjectException : RuntimeException

Represents the Exception that an AssertionPlant.subject was not defined but one tried to access it.

Type Aliases

Assert

typealias Assert<T> = AssertionPlant<T>

Type alias for AssertionPlant which should be used in API modules.