LocaleSupport.java

/*
 * Copyright 2013 Martin Kouba
 *
 * 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.
 */
package org.trimou.engine.locale;

import java.util.Locale;

import org.trimou.engine.config.ConfigurationAware;
import org.trimou.engine.resolver.Mapper;

/**
 * Locale support. Implementation must be thread-safe.
 *
 * @author Martin Kouba
 */
public interface LocaleSupport extends ConfigurationAware {

    /**
     * @return the current locale
     */
    Locale getCurrentLocale();

    /**
     * The caller may supply a {@link Mapper} instance which could be used to
     * lookup the current locale.
     *
     * @param mapper
     * @return the locale
     * @since 2.0
     */
    default Locale getCurrentLocale(Mapper mapper) {
        return getCurrentLocale();
    }

}