org.craftercms.commons.i10n.I10nUtils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of crafter-commons-utilities Show documentation

Crafter Commons Utilities

There is a newer version: 4.1.8

Show newest version

/*
 * Copyright (C) 2007-2014 Crafter Software Corporation.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.craftercms.commons.i10n;

import java.text.MessageFormat;
import java.util.MissingResourceException;
import java.util.ResourceBundle;

import org.apache.commons.lang3.ArrayUtils;

/**
 * Utility class for localization stuff.
 *
 * @author avasquez
 */
public class I10nUtils {
    
    public static final String DEFAULT_ERROR_MESSAGE_BUNDLE_NAME = "crafter.commons.messages.errors";
    public static final String DEFAULT_LOGGING_MESSAGE_BUNDLE_NAME = "crafter.commons.messages.logging";

    private I10nUtils() {
    }

    /**
     * Returns a formatted, localized message according to the specified resource bundle and key.
     *
     * @param bundleName    the name of the resource bundle where the message format should be
     * @param key           the key of the message format
     * @param args          the args of the message format
     * @return the formatted, localized message
     */
    public static String getLocalizedMessage(String bundleName, String key, Object... args) {
        return getLocalizedMessage(ResourceBundle.getBundle(bundleName), key, args);
    }

    /**
     * Returns a formatted, localized message according to the specified resource bundle and key.
     *
     * @param bundle the resource bundle where the message format should be
     * @param key    the key of the message format
     * @param args   the args of the message format
     * @return the formatted, localized message
     */
    public static String getLocalizedMessage(ResourceBundle bundle, String key, Object... args) {
        String pattern;
        try {
            pattern = bundle.getString(key);
        } catch (MissingResourceException e) {
            pattern = key;
        }

        if (ArrayUtils.isNotEmpty(args)) {
            return MessageFormat.format(pattern, args);
        } else {
            return pattern;
        }
    }
}