org.ops4j.gaderian.impl.MessageFormatter.java Source code

Introduction

Here is the source code for org.ops4j.gaderian.impl.MessageFormatter.java

Source

// Copyright 2004-2006 The Apache Software Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package org.ops4j.gaderian.impl;

import java.util.Locale;
import java.util.MissingResourceException;
import java.util.ResourceBundle;

import org.apache.commons.logging.Log;
import org.ops4j.gaderian.util.Defense;

/**
 * A wrapper around {@link java.util.ResourceBundle} that makes it easier to access and format
 * messages.
 * 
 * @author Howard Lewis Ship
 */
public class MessageFormatter extends AbstractMessages {
    private final ResourceBundle _bundle;

    public MessageFormatter(ResourceBundle bundle) {
        Defense.notNull(bundle, "bundle");
        _bundle = bundle;
    }

    /**
     * @deprecated in 1.2, to be removed in a later release. Use
     *             {@link #MessageFormatter(ResourceBundle)} instead.
     */
    public MessageFormatter(Log log, ResourceBundle bundle) {
        this(bundle);
    }

    /**
     * Assumes that the bundle name is the same as the reference class, with "Messages" stripped
     * off, and "Strings" appended.
     * 
     * @since 1.1
     */
    public MessageFormatter(Class referenceClass) {
        this(referenceClass, getStringsName(referenceClass));
    }

    public MessageFormatter(Class referenceClass, String name) {
        this(getResourceBundleName(referenceClass, name));
    }

    /**
     * @deprecated in 1.2, to be removed in a later release. Use
     *             {@link #MessageFormatter(Class, String)} instead.
     */
    public MessageFormatter(Log log, Class referenceClass, String name) {
        this(referenceClass, name);
    }

    public MessageFormatter(String bundleName) {
        this(ResourceBundle.getBundle(bundleName));
    }

    /**
     * @deprecated in 1.2, to be removed in a later release. Use {@link #MessageFormatter(String)}
     *             instead.
     */
    public MessageFormatter(Log log, String bundleName) {
        this(bundleName);
    }

    protected String findMessage(String key) {
        try {
            return _bundle.getString(key);
        } catch (MissingResourceException ex) {
            return null;
        }
    }

    protected Locale getLocale() {
        return Locale.getDefault();
    }

    private static String getStringsName(Class referenceClass) {
        String className = referenceClass.getName();

        int lastDotIndex = className.lastIndexOf('.');

        String justClass = className.substring(lastDotIndex + 1);

        int mpos = justClass.indexOf("Messages");

        return justClass.substring(0, mpos) + "Strings";
    }

    private static String getResourceBundleName(Class referenceClass, String name) {
        String packageName = null;
        if (referenceClass.getPackage() != null) {
            packageName = referenceClass.getPackage().getName();
        } else {
            final int lastDotIndex = referenceClass.getName().lastIndexOf('.');
            packageName = (lastDotIndex == -1 ? "" : referenceClass.getName().substring(0, lastDotIndex));

        }
        return packageName.equals("") ? name : packageName + "." + name;
    }
}