/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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 io.micronaut.context;

import io.micronaut.context.exceptions.NoSuchMessageException;
import io.micronaut.core.annotation.Indexed;
import io.micronaut.core.util.ArgumentUtils;

import edu.umd.cs.findbugs.annotations.NonNull;
import edu.umd.cs.findbugs.annotations.Nullable;
import javax.inject.Singleton;
import java.util.Collections;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;

Interface for resolving messages from some source.
Author:
graemerocher
Since:
1.2/**
 * Interface for resolving messages from some source.
 *
 * @author graemerocher
 * @since 1.2
 */
@Singleton
@Indexed(MessageSource.class)
public interface MessageSource {

    
An empty message source.
/**
     * An empty message source.
     */
    MessageSource EMPTY = new MessageSource() {
        @NonNull
        @Override
        public Optional<String> getRawMessage(@NonNull String code, @NonNull MessageContext context) {
            return Optional.empty();
        }

        @NonNull
        @Override
        public String interpolate(@NonNull String template, @NonNull MessageContext context) {
            return template;
        }
    };

    
Resolve a message for the given code and context.
Params:
code – The code
context – The context
Returns:
A message if present/**
     * Resolve a message for the given code and context.
     * @param code The code
     * @param context The context
     * @return A message if present
     */
    default @NonNull Optional<String> getMessage(@NonNull String code, @NonNull MessageContext context) {
        Optional<String> rawMessage = getRawMessage(code, context);
        return rawMessage.map(message -> this.interpolate(message, context));
    }

    
Resolve a message for the given code and context.
Params:
code – The code
context – The context
defaultMessage – The default message to use if no other message is found
Returns:
A message if present/**
     * Resolve a message for the given code and context.
     * @param code The code
     * @param context The context
     * @param defaultMessage The default message to use if no other message is found
     * @return A message if present
     */
    default @NonNull String getMessage(@NonNull String code, @NonNull MessageContext context, @NonNull String defaultMessage) {
        ArgumentUtils.requireNonNull("defaultMessage", defaultMessage);
        String rawMessage = getRawMessage(code, context, defaultMessage);
        return interpolate(rawMessage, context);
    }

    
Resolve a message for the given code and context.
Params:
code – The code
context – The context
Returns:
A message if present/**
     * Resolve a message for the given code and context.
     * @param code The code
     * @param context The context
     * @return A message if present
     */
    @NonNull Optional<String> getRawMessage(@NonNull String code, @NonNull MessageContext context);

    
Resolve a message for the given code and context.
Params:
code – The code
context – The context
defaultMessage – The default message to use if no other message is found
Returns:
A message if present/**
     * Resolve a message for the given code and context.
     * @param code The code
     * @param context The context
     * @param defaultMessage The default message to use if no other message is found
     * @return A message if present
     */
    default @NonNull String getRawMessage(@NonNull String code, @NonNull MessageContext context, @NonNull String defaultMessage) {
        ArgumentUtils.requireNonNull("defaultMessage", defaultMessage);
        return getRawMessage(code, context).orElse(defaultMessage);
    }

    
Interpolate the given message template.
Params:
template – The template
context – The context to use.
Throws:
IllegalArgumentException – If any argument specified is null
Returns:
The interpolated message./**
     * Interpolate the given message template.
     * @param template The template
     * @param context The context to use.
     * @return The interpolated message.
     * @throws IllegalArgumentException If any argument specified is null
     */
    @NonNull String interpolate(@NonNull String template, @NonNull MessageContext context);

    
Resolve a message for the given code and context or throw an exception.
Params:
code – The code
context – The context
Throws:
NoSuchMessageException – if the message is not found
Returns:
The message/**
     * Resolve a message for the given code and context or throw an exception.
     *
     * @param code The code
     * @param context The context
     * @return The message
     * @throws NoSuchMessageException if the message is not found
     */
    default @NonNull String getRequiredMessage(@NonNull String code, @NonNull MessageContext context) {
        return getMessage(code, context).orElseThrow(() ->
            new NoSuchMessageException(code)
        );
    }

    
Resolve a message for the given code and context or throw an exception.
Params:
code – The code
context – The context
Throws:
NoSuchMessageException – if the message is not found
Returns:
The message/**
     * Resolve a message for the given code and context or throw an exception.
     *
     * @param code The code
     * @param context The context
     * @return The message
     * @throws NoSuchMessageException if the message is not found
     */
    default @NonNull String getRequiredRawMessage(@NonNull String code, @NonNull MessageContext context) {
        return getRawMessage(code, context).orElseThrow(() ->
                new NoSuchMessageException(code)
        );
    }

    
The context to use.
/**
     * The context to use.
     */
    interface MessageContext {
        
The default message context.
/**
         * The default message context.
         */
        MessageContext DEFAULT = new MessageContext() { };

        
The locale to use to resolve messages.
Returns:
The locale/**
         * The locale to use to resolve messages.
         * @return The locale
         */
        @NonNull default Locale getLocale() {
            return Locale.getDefault();
        }

        
The locale to use to resolve messages.
Params:
defaultLocale – The locale to use if no locale is present
Returns:
The locale/**
         * The locale to use to resolve messages.
         * @param defaultLocale The locale to use if no locale is present
         * @return The locale
         */
        @NonNull default Locale getLocale(@Nullable Locale defaultLocale) {
            return defaultLocale != null ? defaultLocale : getLocale();
        }

        
Returns:
The variables to use resolve message place holders/**
         * @return The variables to use resolve message place holders
         */
        @NonNull default Map<String, Object> getVariables() {
            return Collections.emptyMap();
        }

        
Obtain a message context for the given locale.
Params:
locale – The locale
Returns:
The message context/**
         * Obtain a message context for the given locale.
         * @param locale The locale
         * @return The message context
         */
        static @NonNull MessageContext of(@Nullable Locale locale) {
            return new DefaultMessageContext(locale, null);
        }

        
Obtain a message context for the given variables.
Params:
variables – The variables.
Returns:
The message context/**
         * Obtain a message context for the given variables.
         * @param variables The variables.
         * @return The message context
         */
        static @NonNull MessageContext of(@Nullable Map<String, Object> variables) {
            return new DefaultMessageContext(null, variables);
        }

        
Obtain a message context for the given locale and variables.
Params:
locale – The locale
variables – The variables.
Returns:
The message context/**
         * Obtain a message context for the given locale and variables.
         * @param locale The locale
         * @param variables The variables.
         * @return The message context
         */
        static @NonNull MessageContext of(@Nullable Locale locale, @Nullable Map<String, Object> variables) {
            return new DefaultMessageContext(locale, variables);
        }
    }

}