Package com.github.jknack.handlebars.helper

Class DefaultHelperRegistry

java.lang.Object

com.github.jknack.handlebars.helper.DefaultHelperRegistry

All Implemented Interfaces:

HelperRegistry

public class DefaultHelperRegistry
extends Object
implements HelperRegistry

Default implementation of HelperRegistry.

Since:

1.2.0

Field Summary

Fields inherited from interface com.github.jknack.handlebars.HelperRegistry

HELPER_MISSING

Constructor Summary

Constructors

Constructor	Description
DefaultHelperRegistry()

Method Summary

Modifier and Type	Method	Description
Decorator	decorator(String name)	Find a decorator by name.
<C> Helper<C>	helper(String name)	Find a helper by name.
Set<Map.Entry<String,Helper<?>>>	helpers()	List all the helpers from registry.
HelperRegistry	registerDecorator(String name, Decorator decorator)	Register a decorator and make it accessible via HelperRegistry.decorator(String).
<H> HelperRegistry	registerHelper(String name, Helper<H> helper)	Register a helper in the helper registry.
<H> HelperRegistry	registerHelperMissing(Helper<H> helper)	Register the special helper missing in the registry.
HelperRegistry	registerHelpers(File input)	Register helpers from a JavaScript source.
HelperRegistry	registerHelpers(Class<?> helperSource)	Register all the helper methods for the given helper source.
HelperRegistry	registerHelpers(Object helperSource)	Register all the helper methods for the given helper source.
HelperRegistry	registerHelpers(String filename, InputStream source)	Register helpers from a JavaScript source.
HelperRegistry	registerHelpers(String filename, Reader source)	Register helpers from a JavaScript source.
HelperRegistry	registerHelpers(String filename, String source)	Register helpers from a JavaScript source.
HelperRegistry	registerHelpers(URI location)	Register helpers from a JavaScript source.
DefaultHelperRegistry	setCharset(Charset charset)	Set the charset to use.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultHelperRegistry

public DefaultHelperRegistry()

Method Details

helper

public <C> Helper<C> helper(String name)

Description copied from interface: HelperRegistry

Find a helper by name.

Specified by:

helper in interface HelperRegistry

Type Parameters:

C - The helper runtime type.

Parameters:

name - The helper's name. Required.

Returns:

A helper or null if it's not found.

registerHelper

public <H> HelperRegistry registerHelper(String name,
 Helper<H> helper)

Description copied from interface: HelperRegistry

Register a helper in the helper registry.

Specified by:

registerHelper in interface HelperRegistry

Type Parameters:

H - The helper runtime type.

Parameters:

name - The helper's name. Required.

helper - The helper object. Required.

Returns:

This handlebars.

registerHelperMissing

public <H> HelperRegistry registerHelperMissing(Helper<H> helper)

Description copied from interface: HelperRegistry

Register the special helper missing in the registry.

Specified by:

registerHelperMissing in interface HelperRegistry

Type Parameters:

H - The helper runtime type.

Parameters:

helper - The helper object. Required.

Returns:

This handlebars.

registerHelpers

public HelperRegistry registerHelpers(Object helperSource)

Description copied from interface: HelperRegistry

Register all the helper methods for the given helper source.

A helper method looks like:

 public static? CharSequence methodName(context?, parameter*, options?) {
 }
 

Where:

• A method can/can't be static
• The method's name became the helper's name
• Context, parameters and options are all optional
• If context and options are present they must be the first and last method arguments.

Instance and static methods will be registered as helpers.

Specified by:

registerHelpers in interface HelperRegistry

Parameters:

helperSource - The helper source. Required.

Returns:

This handlebars object.

registerHelpers

public HelperRegistry registerHelpers(Class<?> helperSource)

Description copied from interface: HelperRegistry

Register all the helper methods for the given helper source.

A helper method looks like:

 public static? CharSequence methodName(context?, parameter*, options?) {
 }
 

Where:

• A method can/can't be static
• The method's name became the helper's name
• Context, parameters and options are all optional
• If context and options are present they must be the first and last method arguments.

Only static methods will be registered as helpers.

Enums are supported too

Specified by:

registerHelpers in interface HelperRegistry

Parameters:

helperSource - The helper source. Enums are supported. Required.

Returns:

This handlebars object.

registerHelpers

public HelperRegistry registerHelpers(URI location)
                               throws Exception

Description copied from interface: HelperRegistry

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.

Specified by:

registerHelpers in interface HelperRegistry

Parameters:

location - A classpath location. Required.

Returns:

This handlebars object.

Throws:

Exception - If the JavaScript helpers can't be registered.

registerHelpers

public HelperRegistry registerHelpers(File input)
                               throws Exception

Description copied from interface: HelperRegistry

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.

Specified by:

registerHelpers in interface HelperRegistry

Parameters:

input - A JavaScript file name. Required.

Returns:

This handlebars object.

Throws:

Exception - If the JavaScript helpers can't be registered.

registerHelpers

public HelperRegistry registerHelpers(String filename,
 Reader source)
                               throws Exception

Description copied from interface: HelperRegistry

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.

Specified by:

registerHelpers in interface HelperRegistry

Parameters:

filename - The file name (just for debugging purpose). Required.

source - The JavaScript source. Required.

Returns:

This handlebars object.

Throws:

Exception - If the JavaScript helpers can't be registered.

registerHelpers

public HelperRegistry registerHelpers(String filename,
 InputStream source)
                               throws Exception

Description copied from interface: HelperRegistry

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.

Specified by:

registerHelpers in interface HelperRegistry

Parameters:

filename - The file name (just for debugging purpose). Required.

source - The JavaScript source. Required.

Returns:

This handlebars object.

Throws:

Exception - If the JavaScript helpers can't be registered.

registerHelpers

public HelperRegistry registerHelpers(String filename,
 String source)
                               throws IOException

Description copied from interface: HelperRegistry

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.

Specified by:

registerHelpers in interface HelperRegistry

Parameters:

filename - The file name (just for debugging purpose). Required.

source - The JavaScript source. Required.

Returns:

This registry.

Throws:

IOException - If the JavaScript helpers can't be registered.

helpers

public Set<Map.Entry<String,Helper<?>>> helpers()

Description copied from interface: HelperRegistry

List all the helpers from registry.

Specified by:

helpers in interface HelperRegistry

Returns:

Available helpers in the registry.

decorator

public Decorator decorator(String name)

Description copied from interface: HelperRegistry

Find a decorator by name.

Specified by:

decorator in interface HelperRegistry

Parameters:

name - A decorator's name.

Returns:

A decorator or null.

registerDecorator

public HelperRegistry registerDecorator(String name,
 Decorator decorator)

Description copied from interface: HelperRegistry

Register a decorator and make it accessible via HelperRegistry.decorator(String).

Specified by:

registerDecorator in interface HelperRegistry

Parameters:

name - A decorator's name. Required.

decorator - A decorator. Required.

Returns:

This registry.

setCharset

public DefaultHelperRegistry setCharset(Charset charset)

Description copied from interface: HelperRegistry

Set the charset to use.

Specified by:

setCharset in interface HelperRegistry

Parameters:

charset - Charset.

Returns:

This registry.