• Home
• net.sf.m-m-m
• mmm-util-nls
• 8.7.0
• source code
• NlsMessageFactory.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

net.sf.mmm.util.nls.api.NlsMessageFactory Maven / Gradle / Ivy

/* Copyright (c) The m-m-m Team, Licensed under the Apache License, Version 2.0
 * http://www.apache.org/licenses/LICENSE-2.0 */
package net.sf.mmm.util.nls.api;

import java.util.Map;

/**
 * This is the interface for a factory used to create instances of {@link NlsMessage}.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public interface NlsMessageFactory {

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param internationalizedMessage is the {@link NlsMessage#getInternationalizedMessage() internationalized
   *        message}.
   * @param messageArguments are the {@link NlsMessage#getArgument(String) arguments} filled into the message
   *        after nationalization.
   * @return the new {@link NlsMessage} instance.
   * @deprecated use {@link #create(String, Map)} instead.
   */
  @Deprecated
  NlsMessage create(String internationalizedMessage, Object... messageArguments);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param template is the {@link NlsTemplate} for the {@link NlsMessage#getInternationalizedMessage() raw
   *        message}.
   * @param messageArguments are the {@link NlsMessage#getArgument(String) arguments} filled into the message
   *        after nationalization.
   *
   * @return the new {@link NlsMessage} instance.
   * @deprecated use {@link #create(NlsTemplate, Map)} instead.
   */
  @Deprecated
  NlsMessage create(NlsTemplate template, Object... messageArguments);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param internationalizedMessage is the {@link NlsMessage#getInternationalizedMessage() internationalized
   *        message}.
   * @param key1 is the {@link NlsMessage#getArgument(String) key} of the first argument.
   * @param argument1 is the {@link NlsMessage#getArgument(String) value} of the first argument.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(String internationalizedMessage, String key1, Object argument1);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param template is the {@link NlsTemplate} for the {@link NlsMessage#getInternationalizedMessage() raw
   *        message}.
   * @param key1 is the {@link NlsMessage#getArgument(String) key} of the first argument.
   * @param argument1 is the {@link NlsMessage#getArgument(String) value} of the first argument.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(NlsTemplate template, String key1, Object argument1);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param internationalizedMessage is the {@link NlsMessage#getInternationalizedMessage() internationalized
   *        message}.
   * @param key1 is the {@link NlsMessage#getArgument(String) key} of the first argument.
   * @param argument1 is the {@link NlsMessage#getArgument(String) value} of the first argument.
   * @param key2 is the {@link NlsMessage#getArgument(String) key} of the second argument.
   * @param argument2 is the {@link NlsMessage#getArgument(String) value} of the second argument.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(String internationalizedMessage, String key1, Object argument1, String key2, Object argument2);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param template is the {@link NlsTemplate} for the {@link NlsMessage#getInternationalizedMessage() raw
   *        message}.
   * @param key1 is the {@link NlsMessage#getArgument(String) key} of the first argument.
   * @param argument1 is the {@link NlsMessage#getArgument(String) value} of the first argument.
   * @param key2 is the {@link NlsMessage#getArgument(String) key} of the second argument.
   * @param argument2 is the {@link NlsMessage#getArgument(String) value} of the second argument.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(NlsTemplate template, String key1, Object argument1, String key2, Object argument2);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param internationalizedMessage is the {@link NlsMessage#getInternationalizedMessage() internationalized
   *        message}.
   * @param key1 is the {@link NlsMessage#getArgument(String) key} of the first argument.
   * @param argument1 is the {@link NlsMessage#getArgument(String) value} of the first argument.
   * @param key2 is the {@link NlsMessage#getArgument(String) key} of the second argument.
   * @param argument2 is the {@link NlsMessage#getArgument(String) value} of the second argument.
   * @param key3 is the {@link NlsMessage#getArgument(String) key} of the third argument.
   * @param argument3 is the {@link NlsMessage#getArgument(String) value} of the third argument.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(String internationalizedMessage, String key1, Object argument1, String key2, Object argument2, String key3, Object argument3);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param template is the {@link NlsTemplate} for the {@link NlsMessage#getInternationalizedMessage() raw
   *        message}.
   * @param key1 is the {@link NlsMessage#getArgument(String) key} of the first argument.
   * @param argument1 is the {@link NlsMessage#getArgument(String) value} of the first argument.
   * @param key2 is the {@link NlsMessage#getArgument(String) key} of the second argument.
   * @param argument2 is the {@link NlsMessage#getArgument(String) value} of the second argument.
   * @param key3 is the {@link NlsMessage#getArgument(String) key} of the third argument.
   * @param argument3 is the {@link NlsMessage#getArgument(String) value} of the third argument.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(NlsTemplate template, String key1, Object argument1, String key2, Object argument2, String key3, Object argument3);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param internationalizedMessage is the {@link NlsMessage#getInternationalizedMessage() internationalized
   *        message}.
   * @param key1 is the {@link NlsMessage#getArgument(String) key} of the first argument.
   * @param argument1 is the {@link NlsMessage#getArgument(String) value} of the first argument.
   * @param key2 is the {@link NlsMessage#getArgument(String) key} of the second argument.
   * @param argument2 is the {@link NlsMessage#getArgument(String) value} of the second argument.
   * @param key3 is the {@link NlsMessage#getArgument(String) key} of the third argument.
   * @param argument3 is the {@link NlsMessage#getArgument(String) value} of the third argument.
   * @param key4 is the {@link NlsMessage#getArgument(String) key} of the fourth argument.
   * @param argument4 is the {@link NlsMessage#getArgument(String) value} of the fourth argument.
   * @return the new {@link NlsMessage} instance.
   * @since 1.1.1
   */
  // CHECKSTYLE:OFF (many arguments for convenience)
  NlsMessage create(String internationalizedMessage, String key1, Object argument1, String key2, Object argument2, String key3, Object argument3, String key4,
      Object argument4);

  // CHECKSTYLE:ON

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param template is the {@link NlsTemplate} for the {@link NlsMessage#getInternationalizedMessage() raw
   *        message}.
   * @param key1 is the {@link NlsMessage#getArgument(String) key} of the first argument.
   * @param argument1 is the {@link NlsMessage#getArgument(String) value} of the first argument.
   * @param key2 is the {@link NlsMessage#getArgument(String) key} of the second argument.
   * @param argument2 is the {@link NlsMessage#getArgument(String) value} of the second argument.
   * @param key3 is the {@link NlsMessage#getArgument(String) key} of the third argument.
   * @param argument3 is the {@link NlsMessage#getArgument(String) value} of the third argument.
   * @param key4 is the {@link NlsMessage#getArgument(String) key} of the fourth argument.
   * @param argument4 is the {@link NlsMessage#getArgument(String) value} of the fourth argument.
   * @return the new {@link NlsMessage} instance.
   * @since 1.1.1
   */
  // CHECKSTYLE:OFF (many arguments for convenience)
  NlsMessage create(NlsTemplate template, String key1, Object argument1, String key2, Object argument2, String key3, Object argument3, String key4,
      Object argument4);

  // CHECKSTYLE:ON

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param internationalizedMessage is the {@link NlsMessage#getInternationalizedMessage() internationalized
   *        message}.
   * @param messageArguments are the {@link NlsMessage#getArgument(String) arguments} filled into the message
   *        after nationalization.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(String internationalizedMessage, Map messageArguments);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments. 

   * ATTENTION:

   * This us an uncommon way for creating an {@link NlsMessage}. It should only be used for specific cases
   * where both {@link NlsBundle} and {@link net.sf.mmm.util.nls.base.AbstractResourceBundle} are NOT
   * suitable. Please read {@link net.sf.mmm.util.nls.api} as motivation and introduction.
   *
   * @see #createDirect(String, String, Map)
   *
   * @param bundleName is the {@link java.util.ResourceBundle#getBundle(String, java.util.Locale) base-name}
   *        of the bundle containing the message.
   * @param key is the {@link java.util.ResourceBundle#getString(String) key} for the lookup. Will be used as
   *        fallback for the {@link NlsMessage#getInternationalizedMessage() internationalized message}.
   * @return the new {@link NlsMessage} instance.
   * @since 3.1.0
   */
  NlsMessage createDirect(String bundleName, String key);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments. 

   * ATTENTION:

   * This us an uncommon way for creating an {@link NlsMessage}. It should only be used for specific cases
   * where both {@link NlsBundle} and {@link net.sf.mmm.util.nls.base.AbstractResourceBundle} are NOT
   * suitable. Please read {@link net.sf.mmm.util.nls.api} as motivation and introduction.
   *
   * @param bundleName is the {@link java.util.ResourceBundle#getBundle(String, java.util.Locale) base-name}
   *        of the bundle containing the message.
   * @param key is the {@link java.util.ResourceBundle#getString(String) key} for the lookup. Will be used as
   *        fallback for the {@link NlsMessage#getInternationalizedMessage() internationalized message}.
   * @param messageArguments are the {@link NlsMessage#getArgument(String) arguments} filled into the message
   *        after nationalization.
   * @return the new {@link NlsMessage} instance.
   * @since 3.1.0
   */
  NlsMessage createDirect(String bundleName, String key, Map messageArguments);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param template is the {@link NlsTemplate} for the {@link NlsMessage#getInternationalizedMessage() raw
   *        message}.
   * @param messageArguments are the {@link NlsMessage#getArgument(String) arguments} filled into the message
   *        after nationalization.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(NlsTemplate template, Map messageArguments);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @param internationalizedMessage is the {@link NlsMessage#getInternationalizedMessage() internationalized
   *        message}.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(String internationalizedMessage);

  /**
   * This method creates a new instance of {@link NlsMessage} from the given arguments.
   *
   * @see #create(NlsTemplate, Map)
   *
   * @param template is the {@link NlsTemplate} for the {@link NlsMessage#getInternationalizedMessage() raw
   *        message}.
   * @return the new {@link NlsMessage} instance.
   */
  NlsMessage create(NlsTemplate template);

}