atrium-core-impl-robstoll-lib / ch.tutteli.atrium.reporting.translating / PropertiesPerEntityAndLocaleTranslationSupplier

PropertiesPerEntityAndLocaleTranslationSupplier

class PropertiesPerEntityAndLocaleTranslationSupplier : PropertiesBasedTranslationSupplier<String>

Represents a TranslationSupplier which is based on properties-files which are structured per entity (enum, object or class) and Locale.

For instance, the translations for ch.tutteli.atrium.DescriptionAnyAssertion and the Locale de_CH are stored in a properties file named DescriptionAnyAssertion_de_CH.properties in the folder /ch/tutteli/atrium/ (compatible with the behaviour of ResourceBundle - thus properties files should also use ISO-8859-1 as encoding).

An entry in such a file would look like as follows: TO_BE = a translation for TO_BE

Constructors

<init>

PropertiesPerEntityAndLocaleTranslationSupplier()

Represents a TranslationSupplier which is based on properties-files which are structured per entity (enum, object or class) and Locale.

Functions

getNotForRoot

fun getNotForRoot(translatable: Translatable, locale: Locale): String?

Returns the translation for the given translatable and the given locale or null if it does not have any translation.

Inherited Functions

get

fun get(translatable: Translatable, locale: Locale): String?

getFileNameFor

fun getFileNameFor(baseName: String, locale: Locale): String

Returns the name of the properties file without extension -- including the package (as prefixed relative path) in which it resides if necessary -- in which we expect to find a translation in the given locale for baseName.