cn.hutool.extra.template.Template Maven / Gradle / Ivy

Go to download

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

Hutool是一个小而全的Java工具类库，通过静态方法封装，降低相关API的学习成本，提高工作效率，使Java拥有函数式语言般的优雅，让Java语言也可以“甜甜的”。

There is a newer version: 5.8.34

package cn.hutool.extra.template;

import java.io.File;
import java.io.OutputStream;
import java.io.Writer;
import java.util.Map;

/**
 * 抽象模板接口
 * 
 * @author looly
 *
 */
public interface Template {

	/**
	 * 将模板与绑定参数融合后输出到Writer
	 * 
	 * @param bindingMap 绑定的参数，此Map中的参数会替换模板中的变量
	 * @param writer 输出
	 */
	void render(Map bindingMap, Writer writer);

	/**
	 * 将模板与绑定参数融合后输出到流
	 * 
	 * @param bindingMap 绑定的参数，此Map中的参数会替换模板中的变量
	 * @param out 输出
	 */
	void render(Map bindingMap, OutputStream out);

	/**
	 * 写出到文件
	 * @param bindingMap 绑定的参数，此Map中的参数会替换模板中的变量
	 * @param file 输出到的文件
	 */
	void render(Map bindingMap, File file);

	/**
	 * 将模板与绑定参数融合后返回为字符串
	 * 
	 * @param bindingMap 绑定的参数，此Map中的参数会替换模板中的变量
	 * @return 融合后的内容
	 */
	String render(Map bindingMap);
}