Package com.github.jknack.handlebars.io
Interface TemplateLoader
-
- All Known Implementing Classes:
AbstractTemplateLoader
,ClassPathTemplateLoader
,CompositeTemplateLoader
,FileTemplateLoader
,ServletContextTemplateLoader
,URLTemplateLoader
public interface TemplateLoader
Strategy interface for loading resources from class path, file system, etc.
Templates prefix and suffix
A
TemplateLoader
provides two important properties:- prefix: useful for setting a default prefix where templates are stored.
- suffix: useful for setting a default suffix or file extension for your templates. Default is:
'.hbs'
- Since:
- 0.1.0
-
-
Field Summary
Fields Modifier and Type Field Description static String
DEFAULT_PREFIX
The default view prefix.static String
DEFAULT_SUFFIX
The default view suffix.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
getPrefix()
String
getSuffix()
String
resolve(String location)
Resolve a relative location to an absolute location.void
setPrefix(String prefix)
Set the prefix that gets prepended to view names when building a URI.void
setSuffix(String suffix)
Set the suffix that gets appended to view names when building a URI.TemplateSource
sourceAt(String location)
Get a template source from location.
-
-
-
Field Detail
-
DEFAULT_PREFIX
static final String DEFAULT_PREFIX
The default view prefix.- See Also:
- Constant Field Values
-
DEFAULT_SUFFIX
static final String DEFAULT_SUFFIX
The default view suffix.- See Also:
- Constant Field Values
-
-
Method Detail
-
sourceAt
TemplateSource sourceAt(String location) throws IOException
Get a template source from location.- Parameters:
location
- The location of the template source. Required.- Returns:
- A new template source.
- Throws:
IOException
- If the template's source can't be resolved.
-
resolve
String resolve(String location)
Resolve a relative location to an absolute location.- Parameters:
location
- The candidate location.- Returns:
- Resolve the uri to an absolute location.
-
getPrefix
String getPrefix()
- Returns:
- The prefix that gets prepended to view names when building a URI.
-
getSuffix
String getSuffix()
- Returns:
- The suffix that gets appended to view names when building a URI.
-
setPrefix
void setPrefix(String prefix)
Set the prefix that gets prepended to view names when building a URI.- Parameters:
prefix
- The prefix that gets prepended to view names when building a URI.
-
setSuffix
void setSuffix(String suffix)
Set the suffix that gets appended to view names when building a URI.- Parameters:
suffix
- The suffix that gets appended to view names when building a URI.
-
-