de.citunius.businesslogicapi.common.services

Class LocalisationService

java.lang.Object

de.citunius.businesslogicapi.common.services.LocalisationService

public class LocalisationService
extends java.lang.Object

LocalisationService is the class responsible for the language translation of all business logic message replies and webpages.

There are a couple of supported languages but in case that suggested language is not supported, the default language 'English' will be used. Moreover, the language labels are defined in various string_<LANGUAGE-CODE>.properties files located in the business logic project under '/<project-root>/resources/localization/'. This class is responsible to read a language label for a chosen language from the string_<lang>.properties file and supply the language label to compose a business logic webpage or return a message reply to the Business Bot Platform (which is send to the instant messenger user).

Since:

1.0

Field Summary

Fields

Modifier and Type	Field and Description
java.util.HashMap<java.lang.String,java.lang.String>	pluginMap

Constructor Summary

Constructors

Constructor and Description
LocalisationService(java.util.HashMap<java.lang.String,java.lang.String> pluginMap) Private constructor due to singleton

Method Summary

Modifier and Type	Method and Description
static <T,E> java.lang.String	getLanguageCodeByName(E value) Get language code by name
java.lang.String	getString(java.lang.String key) Get a string in default language (en)
java.lang.String	getString(java.lang.String key, java.lang.String language) Get a string in default language
java.util.HashMap<java.lang.String,java.lang.String>	getSupportedLanguages()
boolean	isLanguageCodeSupported(java.lang.String languageCode) Check if language is supported

Methods inherited from class java.lang.Object

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

Field Detail

pluginMap

public java.util.HashMap<java.lang.String,java.lang.String> pluginMap

Constructor Detail

LocalisationService

public LocalisationService(java.util.HashMap<java.lang.String,java.lang.String> pluginMap)

Private constructor due to singleton

Parameters:

pluginMap - the plugin map

Method Detail

getString

public java.lang.String getString(java.lang.String key)

Get a string in default language (en)

Parameters:

key - key of the resource to fetch

Returns:

fetched string or error message otherwise

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String language)

Get a string in default language

Parameters:

key - the key of the resource to fetch

language - the language of the key (e.g. en = english; de=german)

Returns:

fetched string or error message otherwise

getSupportedLanguages

public java.util.HashMap<java.lang.String,java.lang.String> getSupportedLanguages()

getLanguageCodeByName

public static <T,E> java.lang.String getLanguageCodeByName(E value)

Get language code by name

Type Parameters:

T - This is the type parameter

E - This is the enum parameter

Parameters:

value - the value (e.g. english)

Returns:

the language code (e.g. en) on success; otherwise null

isLanguageCodeSupported

public boolean isLanguageCodeSupported(java.lang.String languageCode)

Check if language is supported

Parameters:

languageCode - the language code

Returns:

true if language is supported; otherwise false