1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.localization

File ContextualLocalizationManager.java

 

Code metrics

0
0
0
1
54
8
0
-
-
0
-

Classes

Class Line # Actions
ContextualLocalizationManager 33 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

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 org.xwiki.component.annotation.Role;
23   
24    /**
25    * A helper for {@link LocalizationManager} which get the {@link java.util.Locale} from {@link LocalizationContext} and
26    * provide various common use cases methods.
27    *
28    * @see LocalizationManager
29    * @version $Id: 2b3186a0201408dfa487992b69b900576840c2dc $
30    * @since 5.0M1
31    */
32    @Role
 
33    public interface ContextualLocalizationManager
34    {
35    /**
36    * Find a translation in the current language.
37    *
38    * @param key the key identifying the message to look for
39    * @return the translation in the current language, null if no translation could be found
40    * @see LocalizationManager#getTranslation(String, java.util.Locale)
41    * @see LocalizationContext#getCurrentLocale()
42    */
43    Translation getTranslation(String key);
44   
45    /**
46    * Find a translation in the current language.
47    *
48    * @param key the key identifying the message to look for
49    * @param parameters the parameters
50    * @return the translation in the current language rendered as plain text, null if no translation could be found
51    * @see #getTranslation(String)
52    */
53    String getTranslationPlain(String key, Object... parameters);
54    }