Package org.silverpeas.kernel.test.extension

Class LocalizationBundleStub

java.lang.Object

org.silverpeas.kernel.test.extension.LocalizationBundleStub

All Implemented Interfaces:

org.junit.jupiter.api.extension.AfterEachCallback, org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.Extension

public class LocalizationBundleStub
extends Object
implements org.junit.jupiter.api.extension.BeforeEachCallback, org.junit.jupiter.api.extension.AfterEachCallback

Provides easy stubbing on the LocalizationBundle in unit tests. This class is to declare as a field of the unit test class a LocalizationBundle that will be used by the tests and with which some translations can be preconfigured or modified without having to use a set of physical properties files (a LocalizationBundle is mapped to a l10n properties file). By annotating the field with the RegisterExtension annotation, the required resources initialization is performed before the execution of a unit test and the resource cleanup is applied once the unit test resumed.

Author:

silveryocha

Field Summary

Fields

Modifier and Type	Field	Description
static final String[]	LANGUAGE_ALL	All the languages the LocalizationBundle actually supports.
static final String	LANGUAGE_DE	The default ISO 639-1 code of the german language for the LocalizationBundle
static final String	LANGUAGE_EN	The default ISO 639-1 code of the english language for the LocalizationBundle
static final String	LANGUAGE_FR	The default ISO 639-1 code of the french language for the LocalizationBundle

Constructor Summary

Constructors

Constructor	Description
LocalizationBundleStub(String bundleName, String... languages)

Method Summary

Modifier and Type	Method	Description
void	afterEach(org.junit.jupiter.api.extension.ExtensionContext context)
void	beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
protected void	clear()
LocalizationBundleStub	put(String key, String value)	Puts a couple key / value linked to default locale set by the extension itself.
LocalizationBundleStub	put(String locale, String key, String value)	Puts a couple key / value linked to specified locale.

Methods inherited from class java.lang.Object

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

Field Details

LANGUAGE_FR

public static final String LANGUAGE_FR

The default ISO 639-1 code of the french language for the LocalizationBundle

See Also:

• Constant Field Values

LANGUAGE_EN

public static final String LANGUAGE_EN

The default ISO 639-1 code of the english language for the LocalizationBundle

See Also:

• Constant Field Values

LANGUAGE_DE

public static final String LANGUAGE_DE

The default ISO 639-1 code of the german language for the LocalizationBundle

See Also:

• Constant Field Values

LANGUAGE_ALL

public static final String[] LANGUAGE_ALL

All the languages the LocalizationBundle actually supports.

Constructor Details

LocalizationBundleStub

public LocalizationBundleStub(String bundleName,
 String... languages)

Method Details

put

public LocalizationBundleStub put(String key,
 String value)

Puts a couple key / value linked to default locale set by the extension itself.

Parameters:

key - the key.

value - the value.

Returns:

itself.

put

public LocalizationBundleStub put(String locale,
 String key,
 String value)

Puts a couple key / value linked to specified locale.

Parameters:

locale - the locale.

key - the key.

value - the value.

Returns:

itself.

beforeEach

public void beforeEach(org.junit.jupiter.api.extension.ExtensionContext context)
                throws Exception

Specified by:

beforeEach in interface org.junit.jupiter.api.extension.BeforeEachCallback

Throws:

Exception

afterEach

public void afterEach(org.junit.jupiter.api.extension.ExtensionContext context)

Specified by:

afterEach in interface org.junit.jupiter.api.extension.AfterEachCallback

clear

protected void clear()