datetime-polyglot/dev.mmauro.datetimepolyglot.localizers.relative/RelativeYearOptions

RelativeYearOptions

data class RelativeYearOptions(val style: RelativeUnitStyle = RelativeUnitStyle.LONG, val allowedDirections: Set<RelativeDirection> = RelativeDirection.entries.toSet()) : RelativeUnitOptions, PolyglotLocalizerOptions<RelativeYearLocalizer> (source)

Localization options for RelativeYearLocalizer.

Constructors

RelativeYearOptions

constructor(style: RelativeUnitStyle = RelativeUnitStyle.LONG, allowedDirections: Set<RelativeDirection> = RelativeDirection.entries.toSet())

Properties

allowedDirections

open override val allowedDirections: Set<RelativeDirection>

list of allowed relative directions to use for word style localization (e.g. last year'). Pass an empty list to force numeric localization (e.g. 1 year ago`). All directions are enabled by default.

style

open override val style: RelativeUnitStyle

the style of the year

Functions

localizer

open override fun localizer(locale: PlatformLocale = getDefaultLocale()): RelativeYearLocalizer

Returns a new instance of the PolyglotLocalizer of type L that this options belongs to.