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

TranslatorOptionCommon

interface TranslatorOptionCommon (source)

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

Properties

localeOrderDecider

abstract val localeOrderDecider: LocaleOrderDecider

The previously chosen LocaleOrderDecider.

translationSupplier

abstract val translationSupplier: TranslationSupplier

The previously chosen TranslationSupplier.

Functions

withDefaultTranslator

abstract fun withDefaultTranslator(primaryLocale: Locale, vararg fallbackLocales: Locale): ObjectFormatterOption

Uses CoreFactory.newTranslator as Translator where the specified translationSupplier is used to retrieve translations, the specified localeOrderDecider to determine candidate Locales and primaryLocale is used as primary Locale and the optional fallbackLocales as fallback Locales.

withTranslator

abstract fun withTranslator(factory: (TranslationSupplier, LocaleOrderDecider) -> Translator): ObjectFormatterOption

Uses the given factory to build a Translator.

Inheritors

TranslatorOption

expect interface TranslatorOption : TranslatorOptionCommon

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