fr.vergne.translation.util.MapNamer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of translation-core Show documentation

Basic features to support a translation project.

The newest version!

package fr.vergne.translation.util;

import fr.vergne.translation.TranslationMap;
import fr.vergne.translation.TranslationProject;

/**
 * A {@link MapNamer} allows to associate a name to a {@link TranslationMap}.
 * Because {@link TranslationMap}s are retrieved from a
 * {@link TranslationProject} through its {@link MapID}, the {@link MapNamer}
 * associate the name to this {@link MapID} too, which allows to know the name
 * of the {@link TranslationMap} without needing to load it.
 * 
 * @author Matthieu VERGNE 
 * 
 * @param 
 */
public interface MapNamer {

	/**
	 * 
	 * @return the name of this {@link MapNamer}
	 */
	public String getName();

	/**
	 * 
	 * @return the detailed purpose of this {@link MapNamer}
	 */
	public String getDescription();

	/**
	 * 
	 * @param id
	 *            the ID of the {@link TranslationMap}
	 * @return the name of the {@link TranslationMap}
	 */
	public String getNameFor(MapID id);
}