doc / ch.tutteli.atrium.domain.builders.reporting / ReporterBuilderCommon

ReporterBuilderCommon

interface ReporterBuilderCommon

Provides options to create a Translator or TranslationSupplier -- those options have to be provided on all platforms.

Functions

withDefaultTranslationSupplier

abstract fun withDefaultTranslationSupplier(): LocaleOrderDeciderOption

Uses a predefined method to create a TranslationSupplier -- see platform specific interface for further information.

withoutTranslations

abstract fun withoutTranslations(primaryLocale: Locale): ObjectFormatterOption

Uses UsingDefaultTranslator as Translator where the given primaryLocale is used to format arguments of TranslatableWithArgs.

withoutTranslationsUseDefaultLocale

open fun withoutTranslationsUseDefaultLocale(): ObjectFormatterOption

Uses UsingDefaultTranslator as Translator where getDefaultLocale is used to format arguments of TranslatableWithArgs.

withTranslationSupplier

abstract fun withTranslationSupplier(translationSupplier: TranslationSupplier): LocaleOrderDeciderOption

Uses the given translationSupplier as TranslationSupplier.

withTranslator

abstract fun withTranslator(translator: Translator): ObjectFormatterOption

Uses the given translator as Translator skipping the options for TranslationSupplier and LocaleOrderDecider assuming the given translator is implemented differently -- use withDefaultTranslationSupplier or withTranslationSupplier in case the given translator requires a TranslationSupplier or a LocaleOrderDecider.

Inheritors

ReporterBuilder

expect interface ReporterBuilder : ReporterBuilderCommon

Provides options to create a Translator or TranslationSupplier -- the platform specific interface might provide further options.