Package jmri.jmrit.consisttool

Class Bundle

java.lang.Object

jmri.Bundle

jmri.jmrit.Bundle

jmri.jmrit.consisttool.Bundle

@ParametersAreNonnullByDefault
@CheckReturnValue
@Immutable
public class Bundle
extends Bundle

Provides standard access for resource bundles in a package. Convention is to provide a subclass of this name in each package, working off the local resource bundle name.

Since:

3.3.1

Constructor Summary

Constructors

Constructor	Description
Bundle()

Method Summary

Modifier and Type	Method	Description
protected String	bundleName()
protected static Bundle	getBundle()
(package private) static String	getMessage(String key)	Provides a translated string for a given key from the package resource bundle or parent.
(package private) static String	getMessage(String key, Object... subs)	Merges user data with a translated string for a given key from the package resource bundle or parent.
(package private) static String	getMessage(Locale locale, String key)	Provides a translated string for a given key in a given locale from the package resource bundle or parent.
(package private) static String	getMessage(Locale locale, String key, Object... subs)	Merges user data with a translated string for a given key in a given locale from the package resource bundle or parent.
protected String	retry(Locale locale, String key)

Methods inherited from class jmri.Bundle

formatMessage, handleGetMessage, handleGetMessage, handleGetMessage, handleGetMessage

Methods inherited from class java.lang.Object

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

Constructor Details

Bundle

public Bundle()

Method Details

getMessage

static String getMessage(String key)

Provides a translated string for a given key from the package resource bundle or parent.

Note that this is intentionally package-local access.

Parameters:

key - Bundle key to be translated

Returns:

Internationalized text

getMessage

static String getMessage(Locale locale,
 String key)

Provides a translated string for a given key in a given locale from the package resource bundle or parent.

Note that this is intentionally package-local access.

Parameters:

locale - The locale to be used

key - Bundle key to be translated

Returns:

Internationalized text

getMessage

static String getMessage(String key,
 Object... subs)

Merges user data with a translated string for a given key from the package resource bundle or parent.

Uses the transformation conventions of the Java MessageFormat utility.

Note that this is intentionally package-local access.

Parameters:

key - Bundle key to be translated

subs - One or more objects to be inserted into the message

Returns:

Internationalized text

See Also:

• MessageFormat

getMessage

static String getMessage(Locale locale,
 String key,
 Object... subs)

Merges user data with a translated string for a given key in a given locale from the package resource bundle or parent.

Uses the transformation conventions of the Java MessageFormat utility.

Note that this is intentionally package-local access.

Parameters:

locale - The locale to be used

key - Bundle key to be translated

subs - One or more objects to be inserted into the message

Returns:

Internationalized text

See Also:

• MessageFormat

bundleName

@CheckForNull
protected String bundleName()

Overrides:

bundleName in class Bundle

getBundle

protected static Bundle getBundle()

retry

protected String retry(Locale locale,
 String key)

Overrides:

retry in class Bundle