de.griefed.serverpackcreator.i18n

Class I18n

java.lang.Object

de.griefed.serverpackcreator.i18n.I18n

@Component
public final class I18n
extends java.lang.Object

This is the localizationManager for ServerPackCreator.
To use it, initialize it by calling initialize(). Then use getMessage(String) to use a language key from the resource bundle corresponding to the specified locale. If no locale is provided during the launch of ServerPackCreator, en_US is used by default.
All localization properties-files need to be stored in the de/griefed/resources/lang/ -directory and be named using following pattern: lang_{language code in lowercase}_{country code in lowercase}. For example: lang_en_us.properties.
Currently, only supports Strings to be used in localized fields.
By default, ServerPackCreator tries to load language definitions from the local filesystem, in the lang-folder. If no file can be found for the specified locale, ServerPackCreator tries to load language definitions from inside the JAR-file, from the resource bundles. If the specified key can not be retrieved when calling getMessage(String), a default is retrieved from the lang_en_us-bundle inside the JAR-file by default.

Constructor Summary

Constructors

Constructor and Description
I18n(ApplicationProperties injectedApplicationProperties) Constructor for our I18n using the locale set in the ApplicationProperties-instance passed to this constructor.
I18n(ApplicationProperties injectedApplicationProperties, java.lang.String locale) Constructor for our I18n with a given locale.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage(java.lang.String languageKey) Acquires a localized String for the provided language key from the initialized locale resource.
void	initialize() Initialize the I18n with en_us as the locale.
void	initialize(java.lang.String locale) Initializes the I18n with a provided locale.

Methods inherited from class java.lang.Object

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

Constructor Detail

I18n

@Autowired
public I18n(ApplicationProperties injectedApplicationProperties)

Constructor for our I18n using the locale set in the ApplicationProperties-instance passed to this constructor. If initialization with the provided ApplicationProperties-instance fails, the I18n is initialized with the default locale en_us.

Parameters:

injectedApplicationProperties - Instance of ApplicationProperties required for various different things.

I18n

public I18n(ApplicationProperties injectedApplicationProperties,
            java.lang.String locale)

Constructor for our I18n with a given locale. If initialization with the provided locale fails, the I18n is initialized with the locale set in the instance of ApplicationProperties. If this also fails, the default locale en_us is used.

Parameters:

injectedApplicationProperties - Instance of ApplicationProperties required for various different things.

locale - String. The locale to initialize with.

Method Detail

initialize

public void initialize(java.lang.String locale)
                throws IncorrectLanguageException

Initializes the I18n with a provided locale.

Parameters:

locale - Locale to be used by application in this run.

Throws:

IncorrectLanguageException - Thrown if the language specified in the properties file is not supported by ServerPackCreator or specified in the invalid format.

initialize

public void initialize()

Initialize the I18n with en_us as the locale.

getMessage

public java.lang.String getMessage(java.lang.String languageKey)

Acquires a localized String for the provided language key from the initialized locale resource. If the specified langkey can not be found in the lang-file loaded, a fallback from the en_us-definitions is used.

Parameters:

languageKey - The language key to search for.

Returns:

Localized string that is referred to by the language key.