public class MustacheTemplateEngine extends Object implements TemplateEngine
TemplateEngine
implemented using JMustache.
Note that JMustache has been repackaged and embedded to prevent classpath conflicts.
| Constructor and Description |
|---|
MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver)
Creates a new
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve template paths. |
MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver,
Charset templateEncoding)
Creates a new
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve template paths, reading them using the
given templateEncoding. |
MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver,
Charset templateEncoding,
org.springframework.restdocs.mustache.Mustache.Compiler compiler)
Creates a new
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve templates and the given
compiler to compile them. |
MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver,
Charset templateEncoding,
org.springframework.restdocs.mustache.Mustache.Compiler compiler,
Map<String,Object> context)
Creates a new
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve templates. |
MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver,
org.springframework.restdocs.mustache.Mustache.Compiler compiler)
Creates a new
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve templates and the given
compiler to compile them. |
MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver,
org.springframework.restdocs.mustache.Mustache.Compiler compiler,
Map<String,Object> context)
Creates a new
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve templates. |
| Modifier and Type | Method and Description |
|---|---|
Template |
compileTemplate(String name)
Compiles the template at the given
path. |
protected org.springframework.restdocs.mustache.Mustache.Compiler |
getCompiler()
Returns the
Mustache.Compiler used to compile Mustache templates. |
protected TemplateResourceResolver |
getTemplateResourceResolver()
Returns the
TemplateResourceResolver used to resolve the template resources
prior to compilation. |
public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver)
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve template paths. Templates will be read
as UTF-8.templateResourceResolver - the resolver to usepublic MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver, Charset templateEncoding)
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve template paths, reading them using the
given templateEncoding.templateResourceResolver - the resolver to usetemplateEncoding - the charset to use when reading the templatespublic MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver, org.springframework.restdocs.mustache.Mustache.Compiler compiler)
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve templates and the given
compiler to compile them. Templates will be read as UTF-8.templateResourceResolver - the resolver to usecompiler - the compiler to usepublic MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver, Charset templateEncoding, org.springframework.restdocs.mustache.Mustache.Compiler compiler)
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve templates and the given
compiler to compile them. Templates will be read using the given
templateEncoding.templateResourceResolver - the resolver to usetemplateEncoding - the charset to use when reading the templatescompiler - the compiler to usepublic MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver, org.springframework.restdocs.mustache.Mustache.Compiler compiler, Map<String,Object> context)
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve templates. Templates will be read as
UTF-8. Once read, the given compiler will be used to compile them. Compiled
templates will be created with the given context.templateResourceResolver - the resolver to usecompiler - the compiler to usecontext - the context to pass to compiled templatesMustacheTemplate.MustacheTemplate(org.springframework.restdocs.mustache.Template,
Map)public MustacheTemplateEngine(TemplateResourceResolver templateResourceResolver, Charset templateEncoding, org.springframework.restdocs.mustache.Mustache.Compiler compiler, Map<String,Object> context)
MustacheTemplateEngine that will use the given
templateResourceResolver to resolve templates. Template will be read using
the given templateEncoding. Once read, the given compiler will be
used to compile them. Compiled templates will be created with the given
context.templateResourceResolver - the resolver to usetemplateEncoding - the charset to use when reading the templatescompiler - the compiler to usecontext - the context to pass to compiled templatesMustacheTemplate.MustacheTemplate(org.springframework.restdocs.mustache.Template,
Map)public Template compileTemplate(String name) throws IOException
TemplateEnginepath. Typically, a
TemplateResourceResolver will be used to resolve the path into a resource
that can be read and compiled.compileTemplate in interface TemplateEnginename - the path of the templateTemplateIOException - if compilation failsprotected final org.springframework.restdocs.mustache.Mustache.Compiler getCompiler()
Mustache.Compiler used to compile Mustache templates.protected final TemplateResourceResolver getTemplateResourceResolver()
TemplateResourceResolver used to resolve the template resources
prior to compilation.