biz.aQute.bnd.reporter.helpers

Class LocaleHelper

java.lang.Object

biz.aQute.bnd.reporter.helpers.LocaleHelper

public class LocaleHelper
extends Object

An helper to extract localization data from a Jar.

Method Summary

Modifier and Type	Method and Description
static LocaleHelper	createIfPresent(Jar jar, Locale locale, String basePath) Create a LocaleHelper if localization data are found at the specified path, otherwise return null.
static LocaleHelper	empty()
String	get(String variableOrValue) If the argument is a variable, its corresponding value will be returned for the default locale of this helper instance.
String	get(String variableOrValue, Locale locale) If the argument is a variable, its corresponding value will be returned for the specified locale.

Methods inherited from class java.lang.Object

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

Method Detail

createIfPresent

public static LocaleHelper createIfPresent(Jar jar,
                                           Locale locale,
                                           String basePath)

Create a LocaleHelper if localization data are found at the specified path, otherwise return null.

Parameters:

jar - the jar containing the localization file, must not be null

locale - the default locale for this helper, must not be null

basePath - a base path in the Jar to the localization property files without its extension and its locale suffix, must not be null

Returns:

a LocaleHelper which contains localization data or null if there is no localization data at the specified path.

empty

public static LocaleHelper empty()

Returns:

a LocaleHelper without localization data, never null

get

public String get(String variableOrValue)

If the argument is a variable, its corresponding value will be returned for the default locale of this helper instance. Otherwise, the argument is returned.

Values will be search from the most specific to the less specific locale including unlocalized (empty locale) value.

Parameters:

variableOrValue - a variable (starting with '%') or a value, can be null

Returns:

the localized value, can be null

get

public String get(String variableOrValue,
                  Locale locale)

If the argument is a variable, its corresponding value will be returned for the specified locale. Otherwise, the argument is returned.

Values will be search from the most specific to the less specific locale including unlocalized (empty locale) value.

Parameters:

variableOrValue - a variable (starting with '%') or a value, can be null

locale - the locale, must not be null

Returns:

the localized value, can be null