langtools/src/share/classes/com/sun/tools/javac/api/Messages.java
changeset 1471 57506cdfb7b4
child 2085 4792e12a8ca2
equal deleted inserted replaced
1470:6ff8524783fa 1471:57506cdfb7b4
       
     1 /*
       
     2  * Copyright 2008 Sun Microsystems, Inc.  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.  Sun designates this
       
     8  * particular file as subject to the "Classpath" exception as provided
       
     9  * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
       
    22  * CA 95054 USA or visit www.sun.com if you need additional information or
       
    23  * have any 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  * @author Maurizio Cimadamore
       
    36  */
       
    37 public interface Messages {
       
    38 
       
    39     /**
       
    40      * Add a new resource bundle to the list that is searched for localized messages.
       
    41      * @param bundleName the name to identify the resource bundle of localized messages.
       
    42      * @throws MissingResourceException if the given resource is not found
       
    43      */
       
    44     void add(String bundleName) throws MissingResourceException;
       
    45 
       
    46     /**
       
    47      * Get a localized formatted string
       
    48      * @param l locale in which the text is to be localized
       
    49      * @param key locale-independent message key
       
    50      * @param args misc message arguments
       
    51      * @return a localized formatted string
       
    52      */
       
    53     String getLocalizedString(Locale l, String key, Object... args);
       
    54 }