Interface MustacheTemplateLoader
-
- All Known Implementing Classes:
DefaultTemplateLoader
public interface MustacheTemplateLoader
Mustache template loader. Resource are retrieved usingDefaultResourceLoader
by default unless a specific resource loader is used during construction. Prefix and Suffix can be set, these will be used to retrieve template by its name (if given does not already starts with prefix and does not already ends with suffix). For example: - If prefix and suffix are null: getTemplate("foo"); // Call internally resourceLoader.getResource("foo"); - If prefix or suffix are not null: getTemplate("foo"); // Call internally resourceLoader.getResource({prefix} + "foo" + {suffix});
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addPartialAliases(Map<String,String> partialAliases)
Add partials mapping.void
addTemporaryPartialAliases(Map<String,String> partialAliases)
Add temporary partials aliases.Charset
getCharset()
The charset that will be used to read templates.String
getPrefix()
Get prefix used on template names.String
getSuffix()
Get suffix used on template names.Reader
getTemplate(String name)
Get template from name.void
removeTemporaryPartialAliases()
Remove temporary partial aliases previously added withaddTemporaryPartialAliases(java.util.Map)
method.String
resolve(String name)
Resolve template location from template name.void
setCharset(Charset charset)
Set the charset to use to read templates.void
setPrefix(String prefix)
Set prefix on template names.void
setSuffix(String suffix)
Set suffix on template names.
-
-
-
Method Detail
-
getTemplate
Reader getTemplate(String name)
Get template from name.- Parameters:
name
- Name of template.- Returns:
- Template reader.
-
resolve
String resolve(String name)
Resolve template location from template name. This location must include prefix and suffix of template location.- Parameters:
name
- Template name.- Returns:
- Full template location.
-
setPrefix
void setPrefix(String prefix)
Set prefix on template names.- Parameters:
prefix
- New prefix.
-
setSuffix
void setSuffix(String suffix)
Set suffix on template names.- Parameters:
suffix
- New suffix.
-
getCharset
Charset getCharset()
The charset that will be used to read templates.- Returns:
- Charset.
-
setCharset
void setCharset(Charset charset)
Set the charset to use to read templates.- Parameters:
charset
- New charset.
-
getPrefix
String getPrefix()
Get prefix used on template names.- Returns:
- Prefix.
-
getSuffix
String getSuffix()
Get suffix used on template names.- Returns:
- Prefix.
-
addPartialAliases
void addPartialAliases(Map<String,String> partialAliases)
Add partials mapping. These partials cannot be removed. If you need partials aliases and remove them after compilation, useaddTemporaryPartialAliases(java.util.Map)
method.- Parameters:
partialAliases
- Partials aliases.
-
addTemporaryPartialAliases
void addTemporaryPartialAliases(Map<String,String> partialAliases)
Add temporary partials aliases. These partials can be removed later withremoveTemporaryPartialAliases()
method. Implementation should be thread safe.- Parameters:
partialAliases
- Partials aliases to add.
-
removeTemporaryPartialAliases
void removeTemporaryPartialAliases()
Remove temporary partial aliases previously added withaddTemporaryPartialAliases(java.util.Map)
method. Implementation should be thread safe.
-
-