nucleus/common/common-util/src/main/java/com/sun/enterprise/util/LocalStringManagerImpl.java

/*
 * Copyright (c) 1997, 2018 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0, which is available at
 * http://www.eclipse.org/legal/epl-2.0.
 *
 * This Source Code may also be made available under the following Secondary
 * Licenses when the conditions for such availability set forth in the
 * Eclipse Public License v. 2.0 are satisfied: GNU General Public License,
 * version 2 with the GNU Classpath Exception, which is available at
 * https://www.gnu.org/software/classpath/license.html.
 *
 * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
 */

package com.sun.enterprise.util;

import java.text.MessageFormat;
import java.util.Locale;
import java.util.ResourceBundle;
import java.util.logging.*;
//END OF IASRI 4660742


/**
 * Implementation of a local string manager.
 * Provides access to i18n messages for classes that need them.
 */

public class LocalStringManagerImpl implements LocalStringManager {

    private Class defaultClass;

    /**
     * Create a string manager that looks for LocalStrings.properties in
     * the package of the defaultClass.
     * @param defaultClass Class whose package has default localized strings
     */
    public LocalStringManagerImpl(Class defaultClass) {
        this.defaultClass = defaultClass;
    }

    /**
     * Get a localized string.
     * Strings are stored in a single property file per package named
     * LocalStrings[_locale].properties. Starting from the class of the
     * caller, we walk up the class hierarchy until we find a package
     * resource bundle that provides a value for the requested key.
     *
     * <p>This simplifies access to resources, at the cost of checking for
     * the resource bundle of several classes upon each call. However, due
     * to the caching performed by <tt>ResourceBundle</tt> this seems
     * reasonable.
     *
     * <p>Due to that, sub-classes <strong>must</strong> make sure they don't
     * have conflicting resource naming.
     * @param callerClass The object making the call, to allow per-package
     * resource bundles
     * @param key The name of the resource to fetch
     * @param defaultValue The default return value if not found
     * @return The localized value for the resource
     */
    public String getLocalString(
        Class callerClass,
        String key,
        String defaultValue
    ) {
        Class stopClass  = defaultClass.getSuperclass();
        Class startClass = ((callerClass != null) ? callerClass :
                            defaultClass);
        ResourceBundle resources  = null;
        boolean globalDone = false;
        for (Class c = startClass;
             c != stopClass && c != null;
             c = c.getSuperclass()) {
            globalDone = (c == defaultClass);
            try {
                // Construct the bundle name as LocalStrings in the
                // caller class's package.
                StringBuffer resFileName = new StringBuffer(
                    c.getName().substring(0, c.getName().lastIndexOf(".")));
                resFileName.append(".LocalStrings");

                resources = ResourceBundle.getBundle(resFileName.toString(), Locale.getDefault(), c.getClassLoader());
                if ( resources != null ) {
                    String value = resources.getString(key);
                    if ( value != null )
                        return value;
                }
            } catch (Exception ex) {
            }
        }

        // Look for a global resource (defined by defaultClass)
        if ( ! globalDone ) {
            return getLocalString(null, key, defaultValue);
        } else {
            CULoggerInfo.getLogger().log(Level.FINE, "No local string for", key);
            return defaultValue;
        }
    }

    /**
     * Get a localized string from the package of the default class.
     * @param key The name of the resource to fetch
     * @param defaultValue The default return value if not found
     * @return The localized string
     */
    public String getLocalString(String key, String defaultValue) {
        return getLocalString(null, key, defaultValue);
    }

    /**
     * Get a local string for the caller and format the arguments accordingly.
     * @param callerClass The caller (to walk through its class hierarchy)
     * @param key The key to the local format string
     * @param fmt The default format if not found in the resources
     * @param arguments The set of arguments to provide to the formatter
     * @return A formatted localized string
     */

    public String getLocalString(
        Class callerClass,
        String key,
        String defaultFormat,
        Object... arguments
    ) {
        MessageFormat f = new MessageFormat(
            getLocalString(callerClass, key, defaultFormat));
        for (int i = 0; i < arguments.length; i++) {
            if ( arguments[i] == null ) {
                arguments[i] = "null";
            } else if  ( !(arguments[i] instanceof String) &&
                 !(arguments[i] instanceof Number) &&
                 !(arguments[i] instanceof java.util.Date)) {
                arguments[i] = arguments[i].toString();
            }
        }
        return f.format(arguments);
    }

    /**
     * Get a local string from the package of the default class and
     * format the arguments accordingly.
     * @param key The key to the local format string
     * @param fmt The default format if not found in the resources
     * @param arguments The set of arguments to provide to the formatter
     * @return A formatted localized string
     */
    public String getLocalString(
        String key,
        String defaultFormat,
        Object... arguments
    ) {
        return getLocalString(null, key, defaultFormat, arguments);
    }
}