bundles/org.eclipse.e4.tools.services/src/org/eclipse/e4/tools/services/IMessageFactoryService.java

package org.eclipse.e4.tools.services;

import java.util.Locale;
import java.util.ResourceBundle;

import org.eclipse.osgi.service.localization.BundleLocalization;

/**
 * Service that is responsible for creating and managing message class instances.
 */
public interface IMessageFactoryService {
	
	/**
	 * Returns an instance of the of a given messages class for the given {@link Locale}.
	 * If configured it caches the created instances and return the already created instances.
	 * Otherwise a new instance will be created.
	 * 
	 * @param locale The {@link Locale} for which the message class instance is requested.
	 * @param messages The type of the message class whose instance is requested.
	 * @param localization The service that is needed to retrieve {@link ResourceBundle} objects from a bundle 
	 * 			with a given locale.
	 * @return An instance of the given messages class and {@link Locale}.
	 */
	public <M> M getMessageInstance(final Locale locale, final Class<M> messages, BundleLocalization localization);
}