Package com.tccc.kos.commons.core.localization

Class LocalizationBuilder

java.lang.Object

com.tccc.kos.commons.core.localization.LocalizationBuilder

public class LocalizationBuilder
extends Object

Builder for constructing localization data from a KAB when the KAB doesn't contain a standard localization fragment in the descriptor.

Version:

2024-04-27

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LocalizationBuilder.LocaleBuilder	Builder for a locale within a NamespaceBuilder .
static class	LocalizationBuilder.NamespaceBuilder	Builder for a namespace within a LocalizationBuilder .

Constructor Summary

Constructors

Constructor	Description
LocalizationBuilder()	Create empty builder that can be used to manually create localization information that can be added to a LocalizationContext .
LocalizationBuilder(KabFile kab)	Create a builder that is populate from the localization descriptor in the specified kab.

Method Summary

Modifier and Type	Method	Description
LocalizationBuilder.NamespaceBuilder	addNamespace(String name)	Add a namespace to the builder.
String	getDefaultLocale()
Collection<LocalizationBuilder.NamespaceBuilder>	getNamespaces()	Return the namespaces in the builder.
LocalizationBuilder	setDefaultLocale(String defaultLocale)	Set the default locale for all the translations in the builder following IETF BCP 47 standards using ISO 639 alpha2 language codes and optional ISO 3166 alpha2 country codes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LocalizationBuilder

public LocalizationBuilder()

Create empty builder that can be used to manually create localization information that can be added to a LocalizationContext .

LocalizationBuilder

public LocalizationBuilder(KabFile kab)

Create a builder that is populate from the localization descriptor in the specified kab. If there is no descriptor then this builder will remain empty.

Parameters:

kab - the kab to populate the builder with

Method Details

setDefaultLocale

public LocalizationBuilder setDefaultLocale(String defaultLocale)

Set the default locale for all the translations in the builder following IETF BCP 47 standards using ISO 639 alpha2 language codes and optional ISO 3166 alpha2 country codes. These standard dictate lower case language codes, upper case country codes and a dash separator. kOS will accommodate underscores as a common alternative.

addNamespace

public LocalizationBuilder.NamespaceBuilder addNamespace(String name)

Add a namespace to the builder. If the namespace already exists, the existing namespace builder will be returned.

Parameters:

name - name of the namespace

getNamespaces

public Collection<LocalizationBuilder.NamespaceBuilder> getNamespaces()

Return the namespaces in the builder.

getDefaultLocale

public String getDefaultLocale()