main.java.pro.verron.officestamper.api.OfficeStamper Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of engine Show documentation

Office-stamper is a Java template engine for docx documents, forked from org.wickedsource.docx-stamper

There is a newer version: 2.6.0

package pro.verron.officestamper.api;

import org.docx4j.openpackaging.packages.OpcPackage;

import java.io.OutputStream;

/**
 * This is an interface that defines the contract for stamping
 * templates with context and writing the result to an {@link OutputStream}.
 *
 * @param  The type of the template that can be stamped.
 * @author Joseph Verron
 * @version ${version}
 * @since 1.6.4
 */
public interface OfficeStamper {
	/**
	 * Stamps the template with the context and writes the result to the outputStream.
	 *
	 * @param template     template to stamp
	 * @param context      context to use for stamping
	 * @param outputStream output stream to write the result to
	 * @throws OfficeStamperException if the stamping fails
	 */
	void stamp(
			T template,
			Object context,
			OutputStream outputStream
	) throws OfficeStamperException;
}