View Javadoc
1   /*
2    * Copyright (c) 2008, 2009, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package com.sun.tools.javac.api;
27  
28  import java.util.Locale;
29  import java.util.MissingResourceException;
30  
31  /**
32   * This interface defines the minimum requirements in order to provide support
33   * for localized formatted strings.
34   *
35   * <p><b>This is NOT part of any supported API.
36   * If you write code that depends on this, you do so at your own risk.
37   * This code and its internal interfaces are subject to change or
38   * deletion without notice.</b>
39   *
40   * @author Maurizio Cimadamore
41   */
42  public interface Messages {
43  
44      /**
45       * Add a new resource bundle to the list that is searched for localized messages.
46       * @param bundleName the name to identify the resource bundle of localized messages.
47       * @throws MissingResourceException if the given resource is not found
48       */
49      void add(String bundleName) throws MissingResourceException;
50  
51      /**
52       * Get a localized formatted string.
53       * @param l locale in which the text is to be localized
54       * @param key locale-independent message key
55       * @param args misc message arguments
56       * @return a localized formatted string
57       */
58      String getLocalizedString(Locale l, String key, Object... args);
59  }