View Javadoc

1   /*
2    * ModeShape (http://www.modeshape.org)
3    * See the COPYRIGHT.txt file distributed with this work for information
4    * regarding copyright ownership.  Some portions may be licensed
5    * to Red Hat, Inc. under one or more contributor license agreements.
6    * See the AUTHORS.txt file in the distribution for a full listing of 
7    * individual contributors. 
8    *
9    * ModeShape is free software. Unless otherwise indicated, all code in ModeShape
10   * is licensed to you under the terms of the GNU Lesser General Public License as
11   * published by the Free Software Foundation; either version 2.1 of
12   * the License, or (at your option) any later version.
13   *
14   * ModeShape is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17   * Lesser General Public License for more details.
18   *
19   * You should have received a copy of the GNU Lesser General Public
20   * License along with this software; if not, write to the Free
21   * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22   * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
23   */
24  package org.modeshape.jdbc.util;
25  
26  import java.net.URL;
27  import java.util.Locale;
28  
29  /**
30   * A repository of localized property files used by the {@link I18n internationalization framework}.
31   */
32  public interface LocalizationRepository {
33  
34      /**
35       * Obtain the URL to the properties file containing the localized messages given the supplied bundle name. This method is
36       * responsible for searching to find the most appropriate localized messages given the locale, but does not need to search
37       * using the {@link Locale#getDefault() default locale} (as that is done by the {@link I18n#text(Object...) calling} method.
38       * 
39       * @param bundleName the name of the bundle of properties; never null
40       * @param locale the locale for which the properties file URL is desired
41       * @return the URL to the properties file containing the localized messages for the named bundle, or null if no such bundle
42       *         could be found
43       */
44      URL getLocalizationBundle( String bundleName,
45                                 Locale locale );
46  
47  }