001    /*
002     * JBoss DNA (http://www.jboss.org/dna)
003     * See the COPYRIGHT.txt file distributed with this work for information
004     * regarding copyright ownership.  Some portions may be licensed
005     * to Red Hat, Inc. under one or more contributor license agreements.
006     * See the AUTHORS.txt file in the distribution for a full listing of 
007     * individual contributors. 
008     *
009     * JBoss DNA is free software. Unless otherwise indicated, all code in JBoss DNA
010     * is licensed to you under the terms of the GNU Lesser General Public License as
011     * published by the Free Software Foundation; either version 2.1 of
012     * the License, or (at your option) any later version.
013     *
014     * JBoss DNA is distributed in the hope that it will be useful,
015     * but WITHOUT ANY WARRANTY; without even the implied warranty of
016     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
017     * Lesser General Public License for more details.
018     *
019     * You should have received a copy of the GNU Lesser General Public
020     * License along with this software; if not, write to the Free
021     * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
022     * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
023     */
024    package org.jboss.dna.common.i18n;
025    
026    import java.net.URL;
027    import java.util.Locale;
028    
029    /**
030     * A repository of localized property files used by the {@link I18n internationalization framework}.
031     * @author Randall Hauch
032     */
033    public interface LocalizationRepository {
034    
035        /**
036         * Obtain the URL to the properties file containing the localized messages given the supplied bundle name. This method is
037         * responsible for searching to find the most appropriate localized messages given the locale, but does not need to search
038         * using the {@link Locale#getDefault() default locale} (as that is done by the {@link I18n#text(Object...) calling} method.
039         * @param bundleName the name of the bundle of properties; never null
040         * @param locale the locale for which the properties file URL is desired
041         * @return the URL to the properties file containing the localized messages for the named bundle, or null if no such bundle
042         * could be found
043         */
044        URL getLocalizationBundle( String bundleName, Locale locale );
045    
046    }