001    /*
002     * Copyright 2008 Sun Microsystems, Inc.  All Rights Reserved.
003     * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004     *
005     * This code is free software; you can redistribute it and/or modify it
006     * under the terms of the GNU General Public License version 2 only, as
007     * published by the Free Software Foundation.  Sun designates this
008     * particular file as subject to the "Classpath" exception as provided
009     * by Sun in the LICENSE file that accompanied this code.
010     *
011     * This code is distributed in the hope that it will be useful, but WITHOUT
012     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013     * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
014     * version 2 for more details (a copy is included in the LICENSE file that
015     * accompanied this code).
016     *
017     * You should have received a copy of the GNU General Public License version
018     * 2 along with this work; if not, write to the Free Software Foundation,
019     * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020     *
021     * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022     * CA 95054 USA or visit www.sun.com if you need additional information or
023     * have any questions.
024     */
025    
026    package com.sun.tools.javac.api;
027    
028    import java.util.Locale;
029    import java.util.MissingResourceException;
030    
031    /**
032     * This interface defines the minimum requirements in order to provide support
033     * for localized formatted strings.
034     *
035     * @author Maurizio Cimadamore
036     */
037    public interface Messages {
038    
039        /**
040         * Add a new resource bundle to the list that is searched for localized messages.
041         * @param bundleName the name to identify the resource bundle of localized messages.
042         * @throws MissingResourceException if the given resource is not found
043         */
044        void add(String bundleName) throws MissingResourceException;
045    
046        /**
047         * Get a localized formatted string
048         * @param l locale in which the text is to be localized
049         * @param key locale-independent message key
050         * @param args misc message arguments
051         * @return a localized formatted string
052         */
053        String getLocalizedString(Locale l, String key, Object... args);
054    }