doc / ch.tutteli.atrium.reporting.translating / Translatable

Translatable

interface Translatable

Something which is translatable, identified by id with a default representation given by getDefault.

Properties

id

open val id: String

The id of this Translatable -- per default it is "KClass.fullName ID_SEPARATOR" without the spaces.

name

abstract val name: String

The name of this Translatable -- the name together with its KClass.qualifiedName should identify a Translatable (see id).

Functions

getDefault

abstract fun getDefault(): String

Returns the default representation of this Translatable.

Companion Object Properties

ID_SEPARATOR

const val ID_SEPARATOR: String

The separator used in id to separate KClass.qualifiedName and name.

Inheritors

StringBasedTranslatable

interface StringBasedTranslatable : Translatable

Something which is Translatable and provides a default representation by value.

TranslatableWithArgs

data class TranslatableWithArgs : Translatable

A Translatable which contains placeholders for arguments.

Untranslatable

class Untranslatable : Translatable

Represents a Translatable which is not translatable but has only a fixed name which serves as getDefault.