com.xiaoleilu.hutool.extra.template.RythmUtil Maven / Gradle / Ivy

Go to download
package com.xiaoleilu.hutool.extra.template;

import java.io.Writer;
import java.util.Map;
import java.util.Properties;

import org.rythmengine.Rythm;
import org.rythmengine.RythmEngine;

/**
 * Rythm模板引擎工具类

 * 文档：http://rythmengine.org/doc/index
 * 
 * @author Looly
 *
 */
public class RythmUtil {

	/**
	 * 新建自定义的Rythm模板引擎
	 * 
	 * @param userConfiguration 配置文件，可以使用Props类
	 * @return {@link RythmEngine}
	 */
	public static RythmEngine newEngine(Properties userConfiguration) {
		return new RythmEngine(userConfiguration);
	}

	/**
	 * 使用{@link RythmEngine}渲染模板
	 * 
	 * @param engine {@link RythmEngine}
	 * @param template 模板内容
	 * @param args 变量值
	 * @return 渲染后的内容
	 */
	public static String render(RythmEngine engine, String template, Object... args) {
		return engine.render(template, args);
	}

	/**
	 * 使用{@link RythmEngine}渲染模板
	 * 
	 * @param engine {@link RythmEngine}
	 * @param writer 写出到的{@link Writer}
	 * @param template 模板内容
	 * @param args 变量值
	 */
	public static void render(RythmEngine engine, Writer writer, String template, Object... args) {
		engine.render(writer, template, args);
	}

	/**
	 * 使用{@link RythmEngine}渲染模板
	 * 
	 * @param engine {@link RythmEngine}
	 * @param writer 写出到的{@link Writer}
	 * @param template 模板内容
	 * @param args 变量值
	 */
	public static void render(RythmEngine engine, Writer writer, String template, Map args) {
		engine.render(writer, template, args);
	}

	/**
	 * 使用全局单例{@link RythmEngine}渲染模板
	 * 
	 * @param template 模板内容
	 * @param args 变量值
	 * @return 渲染后的内容
	 */
	public static String render(String template, Object... args) {
		return Rythm.render(template, args);
	}

	/**
	 * 使用{@link RythmEngine}渲染模板
	 * 
	 * @param engine {@link RythmEngine}
	 * @param template 模板内容
	 * @param args 变量值
	 * @return 渲染后的内容
	 */
	public static String render(RythmEngine engine, String template, Map args) {
		return engine.render(template, args);
	}

	/**
	 * 使用全局单例{@link RythmEngine}渲染模板
	 * 
	 * @param template 模板内容
	 * @param args 变量值
	 * @return 渲染后的内容
	 */
	public static String render(String template, Map args) {
		return Rythm.render(template, args);
	}
}