com.anrisoftware.resources.templates.api.TemplatesFactory Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012-2015 Erwin Müller 
 *
 * This file is part of resources-templates.
 *
 * resources-templates is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 *
 * resources-templates is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with resources-templates. If not, see .
 */
package com.anrisoftware.resources.templates.api;

import java.io.Serializable;
import java.util.Map;
import java.util.PropertyResourceBundle;
import java.util.ResourceBundle;

/**
 * Factory to create a new templates resources with the specified resource
 * bundle base name and optional class loader and resource bundle control.
 * Additional attributes can be passed to the underlying template engine.
 * 
 * The class {@link PropertyResourceBundle} is used to load the right property
 * file for the specified locale. The factory offers methods to create template
 * resources with just the base name, or with the class loader or also with the
 * {@link ResourceBundle.Control}.
 * 

 * Example:
 * 
 * 
 * TemplatesFactory templatesFactory;
 * Map attr;
 * Templates templates = templatesFactory.create("Templates", attr);
 * // ...
 * Locale locale = Locale.GERMAN;
 * TemplatesResource t = templates.getResource("hello", locale);
 * String textString = text.getText("name", "Erwin");
 * System.out.println(textString);
 * 
 * String textString = text.getText("name", "Erwin");
 * System.out.println(textString);
 * 
 * 
 * @author Erwin Mueller, [email protected]
 * @since 1.0
 * @see Templates
 */
public interface TemplatesFactory {

	/**
	 * Creates a new {@link Templates} with the resource bundle base name and
	 * the caller's class loader.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 */
	Templates create(String baseName);

	/**
	 * Creates a new {@link Templates} with the resource bundle base name and
	 * the caller's class loader.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param attributes
	 *            the attributes {@link Map} for the template.
	 * 
	 * @since 1.4
	 */
	Templates create(String baseName, Map attributes);

	/**
	 * Creates a new {@link Templates} with the resource bundle base name and
	 * the class loader.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param classLoader
	 *            the {@link ClassLoader}.
	 */
	Templates create(String baseName, ClassLoader classLoader);

	/**
	 * Creates a new {@link Templates} with the resource bundle base name and
	 * the class loader.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param attributes
	 *            the attributes {@link Map} for the template.
	 * 
	 * @param classLoader
	 *            the {@link ClassLoader}.
	 * 
	 * @since 1.4
	 */
	Templates create(String baseName,
			Map attributes, ClassLoader classLoader);

	/**
	 * Creates a new {@link Templates} with the resource bundle base name and
	 * the control.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param control
	 *            the {@link ResourceBundle.Control}.
	 */
	Templates create(String baseName, ResourceBundle.Control control);

	/**
	 * Creates a new {@link Templates} with the resource bundle base name and
	 * the control.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param attributes
	 *            the attributes {@link Map} for the template.
	 * 
	 * @param control
	 *            the {@link ResourceBundle.Control}.
	 * 
	 * @since 1.4
	 */
	Templates create(String baseName,
			Map attributes,
			ResourceBundle.Control control);

	/**
	 * Creates a new {@link Templates} with the resource bundle base name, the
	 * class loader and the control.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param classLoader
	 *            the {@link ClassLoader}.
	 * 
	 * @param control
	 *            the {@link ResourceBundle.Control}.
	 */
	Templates create(String baseName, ClassLoader classLoader,
			ResourceBundle.Control control);

	/**
	 * Creates a new {@link Templates} with the resource bundle base name, the
	 * class loader and the control.
	 * 
	 * @param baseName
	 *            the base name {@link String}.
	 * 
	 * @param attributes
	 *            the attributes {@link Map} for the template.
	 * 
	 * @param classLoader
	 *            the {@link ClassLoader}.
	 * 
	 * @param control
	 *            the {@link ResourceBundle.Control}.
	 * 
	 * @since 1.4
	 */
	Templates create(String baseName,
			Map attributes,
			ClassLoader classLoader, ResourceBundle.Control control);

}