duke@1: /*
duke@1: * Copyright 2005 Sun Microsystems, Inc. All Rights Reserved.
duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1: *
duke@1: * This code is free software; you can redistribute it and/or modify it
duke@1: * under the terms of the GNU General Public License version 2 only, as
duke@1: * published by the Free Software Foundation. Sun designates this
duke@1: * particular file as subject to the "Classpath" exception as provided
duke@1: * by Sun in the LICENSE file that accompanied this code.
duke@1: *
duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
duke@1: * version 2 for more details (a copy is included in the LICENSE file that
duke@1: * accompanied this code).
duke@1: *
duke@1: * You should have received a copy of the GNU General Public License version
duke@1: * 2 along with this work; if not, write to the Free Software Foundation,
duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1: *
duke@1: * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1: * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1: * have any questions.
duke@1: */
duke@1:
duke@1: package com.sun.tools.javac.util;
duke@1:
duke@1: import java.util.ResourceBundle;
duke@1: import java.util.MissingResourceException;
duke@1: import java.text.MessageFormat;
duke@1:
duke@1: /**
duke@1: * Support for localized messages.
duke@1: *
duke@1: *
This is NOT part of any API supported by Sun Microsystems. If
duke@1: * you write code that depends on this, you do so at your own risk.
duke@1: * This code and its internal interfaces are subject to change or
duke@1: * deletion without notice.
duke@1: */
duke@1: public class Messages {
duke@1: /** The context key for the Messages object. */
duke@1: protected static final Context.Key messagesKey =
duke@1: new Context.Key();
duke@1:
duke@1: /** Get the Messages instance for this context. */
duke@1: public static Messages instance(Context context) {
duke@1: Messages instance = context.get(messagesKey);
duke@1: if (instance == null)
duke@1: instance = new Messages(context);
duke@1: return instance;
duke@1: }
duke@1:
duke@1: private List bundles = List.nil();
duke@1:
duke@1: /** Creates a Messages object.
duke@1: */
duke@1: public Messages(Context context) {
duke@1: context.put(messagesKey, this);
duke@1: add(getDefaultBundle());
duke@1: }
duke@1:
duke@1: /** Creates a Messages object.
duke@1: * @param bundle the name to identify the resource buundle of localized messages.
duke@1: */
duke@1: public Messages(String bundleName) throws MissingResourceException {
duke@1: add(bundleName);
duke@1: }
duke@1:
duke@1: /** Creates a Messages object.
duke@1: * @param bundle the name to identif the resource buundle of localized messages.
duke@1: */
duke@1: public Messages(ResourceBundle bundle) throws MissingResourceException {
duke@1: add(bundle);
duke@1: }
duke@1:
duke@1: /** Add a new resource bundle to the list that is searched for localized messages.
duke@1: * @param bundle the name to identify the resource bundle of localized messages.
duke@1: */
duke@1: public void add(String bundleName) throws MissingResourceException {
duke@1: add(ResourceBundle.getBundle(bundleName));
duke@1: }
duke@1:
duke@1: /** Add a new resource bundle to the list that is searched for localized messages.
duke@1: * Resource bundles will be searched in reverse order in which they are added.
duke@1: * @param bundle the bundle of localized messages.
duke@1: */
duke@1: public void add(ResourceBundle bundle) {
duke@1: bundles = bundles.prepend(bundle);
duke@1: }
duke@1:
duke@1: /** Gets the localized string corresponding to a key, formatted with a set of args.
duke@1: */
duke@1: public String getLocalizedString(String key, Object... args) {
duke@1: return getLocalizedString(bundles, key, args);
duke@1: }
duke@1:
duke@1:
duke@1: /* Static access:
duke@1: * javac has a firmly entrenched notion of a default message bundle
duke@1: * which it can access from any static context. This is used to get
duke@1: * easy access to simple localized strings.
duke@1: */
duke@1:
duke@1: private static final String defaultBundleName =
duke@1: "com.sun.tools.javac.resources.compiler";
duke@1: private static ResourceBundle defaultBundle;
duke@1: private static Messages defaultMessages;
duke@1:
duke@1:
duke@1: /**
duke@1: * Gets a localized string from the compiler's default bundle.
duke@1: */
duke@1: // used to support legacy Log.getLocalizedString
duke@1: static String getDefaultLocalizedString(String key, Object... args) {
duke@1: return getLocalizedString(List.of(getDefaultBundle()), key, args);
duke@1: }
duke@1:
duke@1: // used to support legacy static Diagnostic.fragment
duke@1: static Messages getDefaultMessages() {
duke@1: if (defaultMessages == null)
duke@1: defaultMessages = new Messages(getDefaultBundle());
duke@1: return defaultMessages;
duke@1: }
duke@1:
duke@1: public static ResourceBundle getDefaultBundle() {
duke@1: try {
duke@1: if (defaultBundle == null)
duke@1: defaultBundle = ResourceBundle.getBundle(defaultBundleName);
duke@1: return defaultBundle;
duke@1: }
duke@1: catch (MissingResourceException e) {
duke@1: throw new Error("Fatal: Resource for compiler is missing", e);
duke@1: }
duke@1: }
duke@1:
duke@1: private static String getLocalizedString(List bundles,
duke@1: String key,
duke@1: Object... args) {
duke@1: String msg = null;
duke@1: for (List l = bundles; l.nonEmpty() && msg == null; l = l.tail) {
duke@1: ResourceBundle rb = l.head;
duke@1: try {
duke@1: msg = rb.getString(key);
duke@1: }
duke@1: catch (MissingResourceException e) {
duke@1: // ignore, try other bundles in list
duke@1: }
duke@1: }
duke@1: if (msg == null) {
duke@1: msg = "compiler message file broken: key=" + key +
duke@1: " arguments={0}, {1}, {2}, {3}, {4}, {5}, {6}, {7}";
duke@1: }
duke@1: return MessageFormat.format(msg, args);
duke@1: }
duke@1:
duke@1:
duke@1: }