org.dromara.hutool.extra.template.Template Maven / Gradle / Ivy
/*
* Copyright (c) 2013-2024 Hutool Team and hutool.cn
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.dromara.hutool.extra.template;
import org.dromara.hutool.core.io.file.FileUtil;
import org.dromara.hutool.core.io.IoUtil;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.OutputStream;
import java.io.StringWriter;
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 输出到的文件
*/
default void render(final Map bindingMap, final File file) {
BufferedOutputStream out = null;
try {
out = FileUtil.getOutputStream(file);
this.render(bindingMap, out);
} finally {
IoUtil.closeQuietly(out);
}
}
/**
* 将模板与绑定参数融合后返回为字符串
*
* @param bindingMap 绑定的参数，此Map中的参数会替换模板中的变量
* @return 融合后的内容
*/
default String render(final Map bindingMap) {
final StringWriter writer = new StringWriter();
render(bindingMap, writer);
return writer.toString();
}
}