net.sf.mmm.util.nls.api.NlsBundleWithLookup 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 {@link NlsBundle}s that require {@link #getMessage(String, Map) generic lookup} of a
 * {@link NlsMessage}. 

 * Note:

 * Please only use this interface when the {@link #getMessage(String, Map)} is really required. Otherwise only extend
 * {@link NlsBundle}.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 3.1.0
 */
public abstract interface NlsBundleWithLookup extends NlsBundle, NlsMessageLookup {

  /**
   * {@inheritDoc}
   *
   * This allows generic access to invoke a specific method of your bundle. E.g. assume you have an interface
   * {@code NlsBundleMyExampleRoot} extending {@link NlsMessageLookup} that declares the following method:
   *
   *    * @NlsBundleMessage("The object \"{object}\" is null!")
   * NlsMessage errorArgumentNull(@Named("object") Object object);
   * 
   *
   * Then you could do:
   *
   *    * NlsBundleMyExampleRoot myBundle = {@link NlsAccess}.getBundleFactory().createBundle(NlsBundleMyExampleRoot.class);
   * Map<String, Object> parameters = new HashMap<>();
   * parameters.put("object", myObject);
   * {@link NlsMessage} message = myBundle.getMessage("errorArgumentNull", parameters);
   * 
   *
   * This would have the same result as {@code myBundle.errorArgumentNull(myObject)}.
   */
  @Override
  // ATTENTION: parameter names must NOT be changed!
  NlsMessage getMessage(String methodName, Map nlsArguments);

}