org.nuiton.i18n.util.BeanPropertyI18nKeyProducer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of i18n-runtime Show documentation

Runtime of i18n system

There is a newer version: 4.0-beta-27

package org.nuiton.i18n.util;

/*-
 * #%L
 * I18n :: Runtime
 * %%
 * Copyright (C) 2018 Code Lutin, Ultreia.io
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 *
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

/**
 * Produce i18n key for any property of a bean.
 * 
 * This should be used at application level to make easy translations of your objects.
 * 
 * Created by tchemit on 18/10/2018.
 *
 * @author Tony Chemit - [email protected]
 */
public interface BeanPropertyI18nKeyProducer {

    /**
     * Get the i18n property key for the given {@code property} of the given {@code type}.
     *
     * @param type     type of object
     * @param property property name
     * @return i18n property key (not translated)
     */
    String getI18nPropertyKey(Class type, String property);

    String getI18nTypeKey(Class type);
}