View Javadoc
1   /**
2    * This file Copyright (c) 2013-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.i18nsystem;
35  
36  /**
37   * The TranslationService is responsible for getting translated text corresponding to the given Locale, basename and keys.
38   * Different implementations will use different mechanisms for retrieving the translated text.
39   *
40   * As a rule of thumb, one should probably not use TranslationService directly. Use {@link I18nizer} or {@link SimpleTranslator} instead.
41   *
42   * @see I18nizer
43   * @see SimpleTranslator
44   */
45  public interface TranslationService {
46  
47      String translate(LocaleProvider localeProvider, String[] keys);
48      // TODO or would it make more sense to do String translate(I18nKeyGenerator keyGen) ?
49  
50      /**
51       * @param basename Usage of a basename is deprecated since 5.1. This method is here to allow backwards compatibility.
52       * @deprecated since 5.1. Should not be using a basename. Currently in use for backwards compatibility.
53       */
54      @Deprecated
55      String translate(LocaleProvider localeProvider, String basename, String[] keys);
56  
57      /**
58       * Allows to reload all the message bundles - useful in development.
59       *
60       * @deprecated since 5.5.2. {@link DefaultMessageBundlesLoader} is responsible for reloading message bundles.
61       */
62      @Deprecated
63      void reloadMessageBundles();
64  }