Home » freemarker-2.3.13 » freemarker.template » [javadoc | source]
freemarker.template
public interface: TemplateTransformModel [javadoc | source]

All Implemented Interfaces:
    TemplateModel

All Known Implementing Classes:
    NormalizeNewlines, TemplateProcessorModel, JythonRuntime, CaptureOutput, CaptureOutput, XmlEscape, HtmlEscape, StandardCompress, TagTransformModel

Objects that implement this interface can be used as user-defined directives (much like macros); you should rather use the newer TemplateDirectiveModel instead. Altough implementing output filters is more handy with this interface, this interface will be certainly deprecated as superfluous, starting from FreeMarker 2.4. But as far as the template engine is concerned, you can use both equivalently as a user-defined directive.

Note that, as of FreeMarker 2.1, TemplateTransformModel has changed. This is a more powerful implementation. There is a quick-and-dirty way to patch any legacy TemplateTransformModel so that it implements the new API. You simply add the following as your implementation of the getWriter() call:


public Writer getWriter(final Writer out,
Map args)
{
final StringBuffer buf = new StringBuffer();
return new Writer() {
public void write(char cbuf[], int off, int len) {
buf.append(cbuf, off, len);
}

public void flush() throws IOException {
out.flush();
}

public void close() throws IOException {
StringReader sr = new StringReader(buf.toString());
StringWriter sw = new StringWriter();
transform(sr, sw);
out.write(sw.toString());
}
};
}


Implementions of TemplateTransformModel should be thread-safe.

Method from freemarker.template.TemplateTransformModel Summary:
getWriter
Method from freemarker.template.TemplateTransformModel Detail:
 public Writer getWriter(Writer out,
    Map args) throws IOException, TemplateModelException
    Returns a writer that will be used by the engine to feed the transformation input to the transform. Each call to this method must return a new instance of the writer so that the transformation is thread-safe.