Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
TranslationBundle | 33 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.localization; | |
21 | ||
22 | import java.util.Locale; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | ||
26 | /** | |
27 | * A collection of translations in various Locales. | |
28 | * | |
29 | * @version $Id: d0c47a321c2961b0548a5f9b778b4e55babc926b $ | |
30 | * @since 4.3M2 | |
31 | */ | |
32 | @Role | |
33 | public interface TranslationBundle extends Comparable<TranslationBundle> | |
34 | { | |
35 | /** | |
36 | * The default priority of a Bundle. | |
37 | */ | |
38 | int DEFAULTPRIORITY = 1000; | |
39 | ||
40 | /** | |
41 | * @return the unique identifier of the bundle | |
42 | */ | |
43 | String getId(); | |
44 | ||
45 | /** | |
46 | * When searching for a translation, the bundles are searched in order until one of these bundles contains a value | |
47 | * for the searched key. The bundle priority defines this order. Lower is better, meaning that a bundle with a | |
48 | * smaller priority value will be searched before a bundle with a higher value. | |
49 | * | |
50 | * @return the priority | |
51 | * @see #compareTo(Object) | |
52 | */ | |
53 | int getPriority(); | |
54 | ||
55 | /** | |
56 | * Return the translation for the given key, in the specified {@link Locale}. If not translation for the exact | |
57 | * Locale can be found it fallback on the language and then on the default translation if any. | |
58 | * | |
59 | * @param key the key to translate. | |
60 | * @param locale the locale to translate into. | |
61 | * @return the {@link Translation} or null if none can be found. | |
62 | */ | |
63 | Translation getTranslation(String key, Locale locale); | |
64 | } |