hu.icellmobilsoft.coffee.module.localization.BaseLocalizedBundleResolver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of coffee-module-localization Show documentation
The newest version!
/*-
 * #%L
 * Coffee
 * %%
 * Copyright (C) 2020 i-Cell Mobilsoft Zrt.
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

package hu.icellmobilsoft.coffee.module.localization;

import java.io.Serializable;
import java.util.Locale;

import jakarta.inject.Inject;

import org.apache.deltaspike.core.api.message.LocaleResolver;
import org.apache.deltaspike.core.api.message.Message;
import org.apache.deltaspike.core.api.message.MessageContext;

import hu.icellmobilsoft.coffee.cdi.logger.AppLogger;
import hu.icellmobilsoft.coffee.cdi.logger.ThisLogger;

/**
 * A general class for handling dictionaries
 *
 * @author imre.scheffer
 * @since 1.0.0
 */
public abstract class BaseLocalizedBundleResolver {

    @Inject
    @ThisLogger
    private AppLogger log;

    @Inject
    private MessageContext messageContext;

    @Inject
    private LocaleResolver localeResolver;

    /**
     * Default constructor, constructs a new object.
     */
    public BaseLocalizedBundleResolver() {
        super();
    }

    /**
     * for properties like this:

     * 
     * hello=Hello, %s is %d
     * 

     * can use this syntax:

     * 
     * messageTemplate("{hello}", "now", date)
     * 

     * getting something like: "Hello, now is 2016-12-12 12:12:12"
     *
     * @see http://deltaspike.apache.org/documentation/core.html#CreatingMessageInstances
     * @param template
     *            key from properties file
     * @param arguments
     *            parameters in value of key
     * @return localized value by REST header
     */
    public String message(String template, Serializable... arguments) {
        Message message = messageContext.localeResolver(localeResolver).messageSource(getSources()).message();
        return message.template(template).argument(arguments).toString();
    }

    /**
     * for properties like this:

     * 
     * hello=Hello, %s is %d
     * 

     * can use this syntax:

     * 
     * messageTemplate("{hello}", "now", date)
     * 

     * getting something like: "Hello, now is 2016-12-12 12:12:12"
     *
     * @see http://deltaspike.apache.org/documentation/core.html#CreatingMessageInstances
     * @param template
     *            key from properties file
     * @param arguments
     *            parameters in value of key
     * @return localized value by REST header
     */
    public String messageArray(String template, Serializable[] arguments) {
        Message message = messageContext.localeResolver(localeResolver).messageSource(getSources()).message();
        return message.template(template).argumentArray(arguments).toString();
    }

    /**
     * Message by enum value.
     *
     * @param enumm
     *            enum to add to the message
     * @param arguments
     *            arguments to add to the message
     * @return message {@code String}
     */
    public String message(Enum enumm, Serializable... arguments) {
        return message(enumm.getClass(), enumm.name(), arguments);
    }

    /**
     * Message by enum value.
     *
     * @param enumm
     *            enum to add to the message
     * @param arguments
     *            arguments to add to the message
     * @return message {@code String}
     */
    public String messageArray(Enum enumm, Serializable[] arguments) {
        return messageArray(enumm.getClass(), enumm.name(), arguments);
    }

    /**
     * Message by class, key and arguments.
     *
     * @param 
     *            class type
     * @param clazz
     *            class to add to the message
     * @param key
     *            key to add to the message
     * @param arguments
     *            arguments to add to the message
     * @return message {@code String}
     */
    public  String message(Class clazz, String key, Serializable... arguments) {
        if (clazz == null) {
            return message("{" + key + "}", arguments);
        }
        return message("{" + clazz.getName() + "." + key + "}", arguments);
    }

    /**
     * message array by class, key and arguments
     *
     * @param 
     *            class type
     * @param clazz
     *            class to add to the message
     * @param key
     *            key to add to the message
     * @param arguments
     *            arguments to add to the message
     * @return message {@code String}
     */
    public  String messageArray(Class clazz, String key, Serializable[] arguments) {
        if (clazz == null) {
            return messageArray("{" + key + "}", arguments);
        }
        return messageArray("{" + clazz.getName() + "." + key + "}", arguments);
    }

    /**
     * Message by language.
     *
     * @param language
     *            language to base the message on
     * @param template
     *            template to base the message on
     * @param arguments
     *            arguments to add to the message
     * @return message {@code String}
     */
    public String messageByLanguage(String language, String template, Serializable... arguments) {
        LocaleResolver customLocaleResolver = new LocaleResolver() {
            private static final long serialVersionUID = 1L;

            @Override
            public Locale getLocale() {
                return new Locale(language);
            }
        };
        Message message = messageContext.localeResolver(customLocaleResolver).messageSource(getSources()).message();
        return message.template(template).argument(arguments).toString();
    }

    /**
     * Configures locale resources.
     * 
     * @return {@code String[]} of resources.
     */
    protected abstract String[] getSources();

}