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 import java.lang.reflect.AnnotatedElement;
37
38 /**
39 * An {@link I18nKeyGenerator} is responsible for deriving i18n keys for any given instance of T.
40 *
41 * @param <T> the type of Object this {@link I18nKeyGenerator} generates keys for.
42 * @see AbstractI18nKeyGenerator
43 */
44 public interface I18nKeyGenerator<T> {
45 /**
46 * Generates the possible keys for the given <T>object's annotated element.
47 *
48 * @param undecoratedResult the value returned by the undecorated underlying method call. It is generally expected
49 * that this value will be part of the returned keys, such that an object with an explicitly configured key or label
50 * will be translated using that value rather than derived keys.
51 * @param el the element being translated - typically a {@link java.lang.reflect.Method} instance.
52 */
53 String[] keysFor(String undecoratedResult, T object, AnnotatedElement el);
54
55 /**
56 * If <T> has a property that can be used to determine the bundle name (i18nBasename), return that.
57 * The keys will be tried with and without it.
58 *
59 * @deprecated since 5.4.5. Will be removed in a future version
60 */
61 @Deprecated
62 String messageBundleNameFor(T object);
63 }