org.springframework.restdocs.templates.mustache

Class MustacheTemplateEngine

java.lang.Object

org.springframework.restdocs.templates.mustache.MustacheTemplateEngine

All Implemented Interfaces:

TemplateEngine

public class MustacheTemplateEngine
extends Object
implements TemplateEngine

A Mustache-based TemplateEngine implemented using JMustache.

Note that JMustache has been repackaged and embedded to prevent classpath conflicts.

Author:

Andy Wilkinson

Constructor Summary

Constructors

Constructor and Description
MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver) Creates a new MustacheTemplateEngine that will use the given templateResourceResolver to resolve template paths.

Method Summary

Modifier and Type	Method and Description
Template	compileTemplate(String name) Compiles the template at the given path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MustacheTemplateEngine

public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver)

Creates a new MustacheTemplateEngine that will use the given templateResourceResolver to resolve template paths.

Parameters:

templateResourceResolver - The resolve to use

Method Detail

compileTemplate

public Template compileTemplate(String name)
                         throws IOException

Description copied from interface: TemplateEngine

Compiles the template at the given path. Typically, a TemplateResourceResolver will be used to resolve the path into a resource that can be read and compiled.

Specified by:

compileTemplate in interface TemplateEngine

Parameters:

name - the path of the template

Returns:

the compiled Template

Throws:

IOException - if compilation fails