View Javadoc

1   /*
2    * Copyright 2013 smartics, Kronseder & Reiner GmbH
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package de.smartics.resteasy.hypermedia.renderer;
17  
18  import java.util.Locale;
19  
20  /**
21   * Provides localization information for specific locales.
22   */
23  public interface I18nProvider
24  {
25    // ********************************* Fields *********************************
26  
27    // --- constants ------------------------------------------------------------
28  
29    // ****************************** Initializer *******************************
30  
31    // ****************************** Inner Classes *****************************
32  
33    // ********************************* Methods ********************************
34  
35    // --- get&set --------------------------------------------------------------
36  
37    // --- business -------------------------------------------------------------
38  
39    /**
40     * Returns localized information for the specified locale.
41     *
42     * @param locale the locale for which resource information is requested.
43     * @return the requested localized information.
44     * @throws NullPointerException if {@code locale} is <code>null</code>.
45     */
46    LocalizationProvider getProvider(Locale locale) throws NullPointerException;
47  
48    // --- object basics --------------------------------------------------------
49  
50  }