001package jmri.jmrix.ecos.swing.locodatabase;
002
003import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
004import java.util.Locale;
005import javax.annotation.CheckReturnValue;
006import javax.annotation.CheckForNull;
007import javax.annotation.ParametersAreNonnullByDefault;
008
009@ParametersAreNonnullByDefault
010@CheckReturnValue
011@SuppressFBWarnings(value = "NM_SAME_SIMPLE_NAME_AS_SUPERCLASS", justification = "Desired pattern is repeated class names with package-level access to members")
012
013@javax.annotation.concurrent.Immutable
014
015/**
016 * Provides standard access for resource bundles in a package.
017 *
018 * Convention is to provide a subclass of this name in each package, working off
019 * the local resource bundle name.
020 *
021 * @author Bob Jacobsen Copyright (C) 2012
022 * @since 3.3.1
023 */
024public class Bundle extends jmri.jmrix.ecos.swing.Bundle {
025
026    @CheckForNull
027    private static final String name = null; // NOI18N
028
029    //
030    // below here is boilerplate to be copied exactly
031    //
032    /**
033     * Provides a translated string for a given key from the package resource
034     * bundle or parent.
035     * <p>
036     * Note that this is intentionally package-local access.
037     *
038     * @param key Bundle key to be translated
039     * @return Internationalized text
040     */
041    static String getMessage(String key) {
042        return getBundle().handleGetMessage(key);
043    }
044
045    /**
046     * Merges user data with a translated string for a given key from the
047     * package resource bundle or parent.
048     * <p>
049     * Uses the transformation conventions of the Java MessageFormat utility.
050     * <p>
051     * Note that this is intentionally package-local access.
052     *
053     * @see java.text.MessageFormat
054     * @param key  Bundle key to be translated
055     * @param subs One or more objects to be inserted into the message
056     * @return Internationalized text
057     */
058    static String getMessage(String key, Object... subs) {
059        return getBundle().handleGetMessage(key, subs);
060    }
061    private final static Bundle b = new Bundle();
062
063    /**
064     * Merges user data with a translated string for a given key in a given
065     * locale from the package resource bundle or parent.
066     * <p>
067     * Uses the transformation conventions of the Java MessageFormat utility.
068     * <p>
069     * Note that this is intentionally package-local access.
070     *
071     * @see java.text.MessageFormat
072     * @param locale The locale to be used
073     * @param key    Bundle key to be translated
074     * @param subs   One or more objects to be inserted into the message
075     * @return Internationalized text
076     */
077    static String getMessage(Locale locale, String key, Object... subs) {
078        return getBundle().handleGetMessage(locale, key, subs);
079    }
080
081
082    @Override
083    @CheckForNull
084    protected String bundleName() {
085        return name;
086    }
087
088    protected static jmri.Bundle getBundle() {
089        return b;
090    }
091
092    @Override
093    protected String retry(Locale locale, String key) {
094        return super.getBundle().handleGetMessage(locale,key);
095    }
096
097}