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