/*
 * RiskScape™ Copyright New Zealand Institute for Earth Science Limited
 * (Earth Sciences New Zealand) is distributed for research purposes only
 * under the terms of AGPLv3.
 *
 * RiskScape™ Copyright 2026 New Zealand Institute for Earth Science
 * Limited (Earth Sciences New Zealand). All rights reserved. Source code
 * available under the AGPLv3.
 * 
 * This program is free software: you can redistribute it and/or modify it under
 *  the terms of the GNU Affero 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 for RESEARCH PURPOSES ONLY, in the hope that it will
 * be useful for research and education initiatives.
 * 
 * If you are not a researcher, or you are a researcher who wishes to use this
 * program on terms other than AGPLv3 (including those who wish to restrict the
 * distribution of any source code created using this program), please contact:
 * https://riskscape.org.nz
 * 
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Affero General Public License for more details.  You should have received a copy
 * of the GNU Affero General Public License along with this program.  If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * By way of summary only, under the AGPLv3:
 *     • Permissions of this strongest copyleft license are conditioned
 *       on making available complete source code of licensed works and
 *       modifications, which include larger works using a licensed work,
 *       under the same license.
 *     • Copyright and license notices must be preserved.
 *     • Contributors provide an express grant of patent rights.
 *     • When a modified version is used to provide a service over a
 *       network, the complete source code of the modified version must be made
 *       available.
 */
package nz.org.riskscape.engine.i18n;

import java.text.MessageFormat;
import java.util.Locale;

/**
 * Strategy interface for resolving messages, with support for the parameterization and internationalization
 * of such messages.
 *
 * Inspired/Copied from:
 * https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/context/MessageSource.html
 *
 */
public interface MessageSource {

  /**
   * Same as {@link #getMessage(MessageKey, java.util.Locale)} for
   * {@link Locale#getDefault()}.
   *
   * @param resolvable
   * @return String
   */
  String getMessage(MessageKey resolvable);

  /**
   * Try to resolve the resolvable, returning {@link MessageKey#getDefaultMessage()} if lookup fails.
   *
   * All of the codes returned by {@link MessageKey#getCode()} are attempted in order until either:
   * - one resolves to a message with is returned
   * - none resolve to a message in which case the default is returned.
   *
   * @param resolvable
   * @param locale
   * @return the resolved message or default if lookup fails
   */
  String getMessage(MessageKey resolvable, Locale locale);

  /**
   * Same as {@link #getMessage(java.lang.String, java.lang.Object[], java.lang.String, java.util.Locale) }
   * with {@link Locale#getDefault() } and null default.
   *
   * @param code
   * @param args
   * @return the resolved message or null if lookup fails
   */
  String getMessage(String code, Object... args);

  /**
   * Same as {@link #getMessage(java.lang.String, java.lang.Object[], java.lang.String, java.util.Locale) }
   * with null default.
   *
   * @param code
   * @param args
   * @param locale
   * @return the resolved message or null if lookup fails
   */
  String getMessage(String code, Object[] args, Locale locale);

  /**
   * Try to resolve the message. Return default message if no message was found.
   *
   * @param code identifying message
   * @param args an array of arguments for {@link MessageFormat} replacements
   * @param defaultMessage a default message to return if lookup fails
   * @param locale the locale in which do to the lookup
   * @return the resolved message or default if lookup fails
   */
  String getMessage(String code, Object[] args, String defaultMessage, Locale locale);


  /**
   * Returns an implementation of the given factory class that resolves messages against the given locale and message
   * source.
   */
  <T extends MessageFactory> T getMessageFactory(Class<T> factory, Locale locale);

}
