public class Handlebars extends Object implements HelperRegistry
Handlebars provides the power necessary to let you build semantic templates effectively with no frustration.
Handlebars handlebars = new Handlebars();
Template template = handlebars.compileInline("Hello {{this}}!");
System.out.println(template.apply("Handlebars.java"));
This example load mytemplate.hbs from the root of the classpath:
Handlebars handlebars = new Handlebars();
Template template = handlebars.compileInline(URI.create("mytemplate"));
System.out.println(template.apply("Handlebars.java"));
You can specify a different ```TemplateLoader``` by:
TemplateLoader loader = ...; Handlebars handlebars = new Handlebars(loader);
| Modifier and Type | Class and Description |
|---|---|
static class |
Handlebars.SafeString
A
Handlebars.SafeString tell Handlebars that the content should not be
escaped as HTML. |
static class |
Handlebars.Utils
Utilities function like:
Handlebars.Utils.escapeExpression(CharSequence) and
Handlebars.Utils.isEmpty(Object). |
| Modifier and Type | Field and Description |
|---|---|
static String |
DELIM_END
The default end delimiter.
|
static String |
DELIM_START
The default start delimiter.
|
HELPER_MISSING| Constructor and Description |
|---|
Handlebars()
Creates a new
Handlebars with a ClassPathTemplateLoader and no
cache. |
Handlebars(TemplateLoader loader)
Creates a new
Handlebars with no cache. |
| Modifier and Type | Method and Description |
|---|---|
Template |
compile(String location)
Compile the resource located at the given uri.
|
Template |
compile(String location,
String startDelimiter,
String endDelimiter)
Compile the resource located at the given uri.
|
Template |
compile(TemplateSource source)
Compile a handlebars template.
|
Template |
compile(TemplateSource source,
String startDelimiter,
String endDelimiter)
Compile a handlebars template.
|
Template |
compileInline(String input)
Compile a handlebars template.
|
Template |
compileInline(String input,
String startDelimiter,
String endDelimiter)
Compile a handlebars template.
|
static void |
debug(String message)
Log the given message as debug and format the message within the args.
|
static void |
debug(String message,
Object... args)
Log the given message as debug and format the message within the args.
|
Decorator |
decorator(String name)
Find a decorator by name.
|
boolean |
deletePartialAfterMerge()
If true, templates will be deleted once applied.
|
Handlebars |
deletePartialAfterMerge(boolean deletePartialAfterMerge)
If true, templates will be deleted once applied.
|
Handlebars |
endDelimiter(String endDelimiter)
Set the end delimiter.
|
static void |
error(String message)
Log the given message as error and format the message within the args.
|
static void |
error(String message,
Object... args)
Log the given message as error and format the message within the args.
|
TemplateCache |
getCache()
The template cache.
|
EscapingStrategy |
getEscapingStrategy()
The escaping strategy.
|
Formatter.Chain |
getFormatter() |
TemplateLoader |
getLoader()
The resource locator.
|
ParserFactory |
getParserFactory()
Return a parser factory.
|
String |
handlebarsJsFile() |
Handlebars |
handlebarsJsFile(String location)
Set the handlebars.js location used it to compile/precompile template to JavaScript.
|
<C> Helper<C> |
helper(String name)
Find a helper by name.
|
Set<Map.Entry<String,Helper<?>>> |
helpers()
List all the helpers from registry.
|
boolean |
infiniteLoops()
If true, templates will be able to call him self directly or indirectly.
|
Handlebars |
infiniteLoops(boolean infiniteLoops)
If true, templates will be able to call him self directly or indirectly.
|
static void |
log(String message)
Log the given message and format the message within the args.
|
static void |
log(String message,
Object... args)
Log the given message and format the message within the args.
|
boolean |
parentScopeResolution() |
Handlebars |
parentScopeResolution(boolean parentScopeResolution)
Given:
|
boolean |
prettyPrint()
If true, unnecessary spaces and new lines will be removed from output.
|
Handlebars |
prettyPrint(boolean prettyPrint)
If true, unnecessary spaces and new lines will be removed from output.
|
Handlebars |
registerDecorator(String name,
Decorator decorator)
Register a decorator and make it accessible via
HelperRegistry.decorator(String). |
<H> Handlebars |
registerHelper(String name,
Helper<H> helper)
Register a helper in the helper registry.
|
<H> Handlebars |
registerHelperMissing(Helper<H> helper)
Register a missing helper in the helper registry.
|
Handlebars |
registerHelpers(Class<?> helperSource)
Register all the helper methods for the given helper source.
|
Handlebars |
registerHelpers(File input)
Register helpers from a JavaScript source.
|
Handlebars |
registerHelpers(Object helperSource)
Register all the helper methods for the given helper source.
|
Handlebars |
registerHelpers(String filename,
InputStream source)
Register helpers from a JavaScript source.
|
Handlebars |
registerHelpers(String filename,
Reader source)
Register helpers from a JavaScript source.
|
Handlebars |
registerHelpers(String filename,
String source)
Register helpers from a JavaScript source.
|
Handlebars |
registerHelpers(URI location)
Register helpers from a JavaScript source.
|
void |
setDeletePartialAfterMerge(boolean deletePartialAfterMerge)
If true, templates will be deleted once applied.
|
void |
setEndDelimiter(String endDelimiter)
Set the end delimiter.
|
void |
setInfiniteLoops(boolean infiniteLoops)
If true, templates will be able to call him self directly or indirectly.
|
void |
setParentScopeResolution(boolean parentScopeResolution)
Given:
|
void |
setPrettyPrint(boolean prettyPrint)
If true, unnecessary spaces and new lines will be removed from output.
|
void |
setStartDelimiter(String startDelimiter)
Set the start delimiter.
|
void |
setStringParams(boolean stringParams)
If true, missing helper parameters will be resolve to their names.
|
Handlebars |
startDelimiter(String startDelimiter)
Set the start delimiter.
|
boolean |
stringParams()
If true, missing helper parameters will be resolve to their names.
|
Handlebars |
stringParams(boolean stringParams)
If true, missing helper parameters will be resolve to their names.
|
static void |
warn(String message)
Log the given message as warn and format the message within the args.
|
static void |
warn(String message,
Object... args)
Log the given message as warn and format the message within the args.
|
Handlebars |
with(EscapingStrategy escapingStrategy)
Set a new
EscapingStrategy. |
Handlebars |
with(Formatter formatter)
Add a new variable formatter.
|
Handlebars |
with(HelperRegistry registry)
Set the helper registry.
|
Handlebars |
with(ParserFactory parserFactory)
Set a new
ParserFactory. |
Handlebars |
with(TemplateCache cache)
Set a new
TemplateCache. |
Handlebars |
with(TemplateLoader... loader)
Set one or more
TemplateLoader. |
public static final String DELIM_START
public static final String DELIM_END
public Handlebars(TemplateLoader loader)
Handlebars with no cache.loader - The template loader. Required.public Handlebars()
Handlebars with a ClassPathTemplateLoader and no
cache.public Template compile(String location) throws IOException
location - The resource's location. Required.IOException - If the resource cannot be loaded.public Template compile(String location, String startDelimiter, String endDelimiter) throws IOException
location - The resource's location. Required.startDelimiter - The start delimiter. Required.endDelimiter - The end delimiter. Required.IOException - If the resource cannot be loaded.public Template compileInline(String input) throws IOException
input - The handlebars input. Required.IOException - If the resource cannot be loaded.public Template compileInline(String input, String startDelimiter, String endDelimiter) throws IOException
input - The input text. Required.startDelimiter - The start delimiter. Required.endDelimiter - The end delimiter. Required.IOException - If the resource cannot be loaded.public Template compile(TemplateSource source) throws IOException
source - The template source. Required.IOException - If the resource cannot be loaded.public Template compile(TemplateSource source, String startDelimiter, String endDelimiter) throws IOException
source - The template source. Required.startDelimiter - The start delimiter. Required.endDelimiter - The end delimiter. Required.IOException - If the resource cannot be loaded.public <C> Helper<C> helper(String name)
helper in interface HelperRegistryC - The helper runtime type.name - The helper's name. Required.public <H> Handlebars registerHelper(String name, Helper<H> helper)
registerHelper in interface HelperRegistryH - The helper runtime type.name - The helper's name. Required.helper - The helper object. Required.public <H> Handlebars registerHelperMissing(Helper<H> helper)
registerHelperMissing in interface HelperRegistryH - The helper runtime type.helper - The helper object. Required.public Handlebars registerHelpers(Object helperSource)
Register all the helper methods for the given helper source.
A helper method looks like:
public static? CharSequence methodName(context?, parameter*, options?) {
}
Where:
registerHelpers in interface HelperRegistryhelperSource - The helper source. Required.public Handlebars registerHelpers(Class<?> helperSource)
Register all the helper methods for the given helper source.
A helper method looks like:
public static? CharSequence methodName(context?, parameter*, options?) {
}
Where:
Enums are supported too
registerHelpers in interface HelperRegistryhelperSource - The helper source. Enums are supported. Required.public Handlebars registerHelpers(URI location) throws Exception
Register helpers from a JavaScript source.
A JavaScript source file looks like:
Handlebars.registerHelper('hey', function (context) {
return 'Hi ' + context.name;
});
...
Handlebars.registerHelper('hey', function (context, options) {
return 'Hi ' + context.name + options.hash['x'];
});
...
Handlebars.registerHelper('hey', function (context, p1, p2, options) {
return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
});
...
To keep your helpers reusable between server and client avoid DOM manipulation.registerHelpers in interface HelperRegistrylocation - A classpath location. Required.Exception - If the JavaScript helpers can't be registered.public Handlebars registerHelpers(File input) throws Exception
Register helpers from a JavaScript source.
A JavaScript source file looks like:
Handlebars.registerHelper('hey', function (context) {
return 'Hi ' + context.name;
});
...
Handlebars.registerHelper('hey', function (context, options) {
return 'Hi ' + context.name + options.hash['x'];
});
...
Handlebars.registerHelper('hey', function (context, p1, p2, options) {
return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
});
...
To keep your helpers reusable between server and client avoid DOM manipulation.registerHelpers in interface HelperRegistryinput - A JavaScript file name. Required.Exception - If the JavaScript helpers can't be registered.public Handlebars registerHelpers(String filename, Reader source) throws Exception
Register helpers from a JavaScript source.
A JavaScript source file looks like:
Handlebars.registerHelper('hey', function (context) {
return 'Hi ' + context.name;
});
...
Handlebars.registerHelper('hey', function (context, options) {
return 'Hi ' + context.name + options.hash['x'];
});
...
Handlebars.registerHelper('hey', function (context, p1, p2, options) {
return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
});
...
To keep your helpers reusable between server and client avoid DOM manipulation.registerHelpers in interface HelperRegistryfilename - The file name (just for debugging purpose). Required.source - The JavaScript source. Required.Exception - If the JavaScript helpers can't be registered.public Handlebars registerHelpers(String filename, InputStream source) throws Exception
Register helpers from a JavaScript source.
A JavaScript source file looks like:
Handlebars.registerHelper('hey', function (context) {
return 'Hi ' + context.name;
});
...
Handlebars.registerHelper('hey', function (context, options) {
return 'Hi ' + context.name + options.hash['x'];
});
...
Handlebars.registerHelper('hey', function (context, p1, p2, options) {
return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
});
...
To keep your helpers reusable between server and client avoid DOM manipulation.registerHelpers in interface HelperRegistryfilename - The file name (just for debugging purpose). Required.source - The JavaScript source. Required.Exception - If the JavaScript helpers can't be registered.public Handlebars registerHelpers(String filename, String source) throws Exception
Register helpers from a JavaScript source.
A JavaScript source file looks like:
Handlebars.registerHelper('hey', function (context) {
return 'Hi ' + context.name;
});
...
Handlebars.registerHelper('hey', function (context, options) {
return 'Hi ' + context.name + options.hash['x'];
});
...
Handlebars.registerHelper('hey', function (context, p1, p2, options) {
return 'Hi ' + context.name + p1 + p2 + options.hash['x'];
});
...
To keep your helpers reusable between server and client avoid DOM manipulation.registerHelpers in interface HelperRegistryfilename - The file name (just for debugging purpose). Required.source - The JavaScript source. Required.Exception - If the JavaScript helpers can't be registered.public Set<Map.Entry<String,Helper<?>>> helpers()
HelperRegistryhelpers in interface HelperRegistrypublic TemplateLoader getLoader()
public TemplateCache getCache()
public EscapingStrategy getEscapingStrategy()
public boolean stringParams()
public boolean prettyPrint()
public void setPrettyPrint(boolean prettyPrint)
prettyPrint - If true, unnecessary spaces and new lines will be removed from output.
Default is: false.public Handlebars prettyPrint(boolean prettyPrint)
prettyPrint - If true, unnecessary spaces and new lines will be removed from output.
Default is: false.public void setStringParams(boolean stringParams)
stringParams - If true, missing helper parameters will be resolve to
their names.public Handlebars stringParams(boolean stringParams)
stringParams - If true, missing helper parameters will be resolve to
their names.public boolean infiniteLoops()
public void setInfiniteLoops(boolean infiniteLoops)
infiniteLoops - If true, templates will be able to call him self directly or
indirectly.public Handlebars infiniteLoops(boolean infiniteLoops)
infiniteLoops - If true, templates will be able to call him self directly or
indirectly.public boolean deletePartialAfterMerge()
{{#block}} helper. Default is: false.
At any time you can override the default setup with:
{{#block "footer" delete-after-merge=true}}
{{#block}} helper.public Handlebars deletePartialAfterMerge(boolean deletePartialAfterMerge)
{{#block}} helper. Default is: false.
At any time you can override the default setup with:
{{#block "footer" delete-after-merge=true}}
deletePartialAfterMerge - True for clearing up templates once they got applied. Used by
{{#block}} helper.public void setDeletePartialAfterMerge(boolean deletePartialAfterMerge)
{{#block}} helper. Default is: false.
At any time you can override the default setup with:
{{#block "footer" delete-after-merge=true}}
deletePartialAfterMerge - True for clearing up templates once they got applied. Used by
{{#block}} helper.public void setEndDelimiter(String endDelimiter)
endDelimiter - The end delimiter. Required.public Handlebars endDelimiter(String endDelimiter)
endDelimiter - The end delimiter. Required.public void setStartDelimiter(String startDelimiter)
startDelimiter - The start delimiter. Required.public Handlebars startDelimiter(String startDelimiter)
startDelimiter - The start delimiter. Required.public Handlebars with(TemplateLoader... loader)
TemplateLoader. In the case of two or more TemplateLoader, a
CompositeTemplateLoader will be created. Default is: ClassPathTemplateLoader.loader - The template loader. Required.CompositeTemplateLoaderpublic Handlebars with(ParserFactory parserFactory)
ParserFactory.parserFactory - A parser factory. Required.public Handlebars with(TemplateCache cache)
TemplateCache.cache - The template cache. Required.public Handlebars with(HelperRegistry registry)
registry - The helper registry. Required.public Handlebars with(EscapingStrategy escapingStrategy)
EscapingStrategy.escapingStrategy - The escaping strategy. Required.public Formatter.Chain getFormatter()
public Handlebars with(Formatter formatter)
Handlebars hbs = new Handlebars();
hbs.with(new Formatter() {
public Object format(Object value, Chain next) {
if (value instanceof Date) {
return ((Date) value).getTime();
}
return next.format(value);
}
});
formatter - A formatter.public Handlebars handlebarsJsFile(String location)
Using handlebars.js 4.x:
Handlebars handlebars = new Handlebars()
.handlebarsJsFile("handlebars-v4.0.4.js");
Using handlebars.js 1.x:
Handlebars handlebars = new Handlebars()
.handlebarsJsFile("handlebars-v1.3.0.js");
Default handlebars.js is handlebars-v4.0.4.js.location - A classpath location of the handlebar.js file.public String handlebarsJsFile()
handlebars-v4.0.4.jspublic boolean parentScopeResolution()
public void setParentScopeResolution(boolean parentScopeResolution)
{
"value": "Brett",
"child": {
"bestQB" : "Favre"
}
}
Handlebars.java will output: Hello Favre Brett while handlebars.js:
Hello Favre.
Why? Handlebars.java is a 100% Mustache implementation while handlebars.js isn't.
This option forces Handlebars.java mimics handlebars.js behavior:
Handlebars hbs = new Handlebars() .parentScopeResolution(true);Outputs:
Hello Favre.parentScopeResolution - False, if we want to restrict lookup to current scope (like in
handlebars.js). Default is truepublic Handlebars parentScopeResolution(boolean parentScopeResolution)
{
"value": "Brett",
"child": {
"bestQB" : "Favre"
}
}
Handlebars.java will output: Hello Favre Brett while handlebars.js:
Hello Favre.
Why? Handlebars.java is a 100% Mustache implementation while handlebars.js isn't.
This option forces Handlebars.java mimics handlebars.js behavior:
Handlebars hbs = new Handlebars() .parentScopeResolution(true);Outputs:
Hello Favre.parentScopeResolution - False, if we want to restrict lookup to current scope (like in
handlebars.js). Default is truepublic ParserFactory getParserFactory()
public static void log(String message, Object... args)
message - The log's message.args - The optional args.String.format(String, Object...)public static void log(String message)
message - The log's message.String.format(String, Object...)public static void warn(String message, Object... args)
message - The log's message.args - The optional args.String.format(String, Object...)public static void warn(String message)
message - The log's message.String.format(String, Object...)public static void debug(String message, Object... args)
message - The log's message.args - The optional args.String.format(String, Object...)public static void debug(String message)
message - The log's message.String.format(String, Object...)public static void error(String message, Object... args)
message - The log's message.args - The optional args.String.format(String, Object...)public static void error(String message)
message - The log's message.String.format(String, Object...)public Decorator decorator(String name)
HelperRegistrydecorator in interface HelperRegistryname - A decorator's name.null.public Handlebars registerDecorator(String name, Decorator decorator)
HelperRegistryHelperRegistry.decorator(String).registerDecorator in interface HelperRegistryname - A decorator's name. Required.decorator - A decorator. Required.Copyright © 2016. All rights reserved.