com.github.jknack.handlebars

Class Jackson2Helper

java.lang.Object

com.github.jknack.handlebars.Jackson2Helper

All Implemented Interfaces:

Helper<Object>

public class Jackson2Helper
extends Object
implements Helper<Object>

A Jackson 2.x helper.

Basic usage:

  Handlebars hbs = new Handlebars();

  hbs.registerHelper("json", Jackson2Helper.INSTANCE);

  ...

  {{json model}}
 

If model is null an empty string is returned.

You can change this using the default option:

  {{json model default="{}"}}
 

Using a view class:

  {{json model view="foo.MyView"}}
 

Using alias for views:

  {{json model view="myView"}}
 

Escape HTML chars:

  {{json model escapeHtml=true}}
 

Pretty printer:

  {{json model pretty=true}}
 

Since:

0.4.0

Author:

edgar.espina

Field Summary

Fields

Modifier and Type	Field and Description
static Helper<Object>	INSTANCE A singleton version of Jackson2Helper.

Constructor Summary

Constructors

Constructor and Description
Jackson2Helper(com.fasterxml.jackson.databind.ObjectMapper objectMapper) Creates a new Jackson2Helper.

Method Summary

Methods

Modifier and Type	Method and Description
CharSequence	apply(Object context, Options options)
Jackson2Helper	viewAlias(String alias, Class<?> viewClass) Add an alias for the given view class.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final Helper<Object> INSTANCE

A singleton version of Jackson2Helper.

Constructor Detail

Jackson2Helper

public Jackson2Helper(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Creates a new Jackson2Helper.

Parameters:

objectMapper - The object's mapper. Required.

Method Detail

apply

public CharSequence apply(Object context,
                 Options options)
                   throws IOException

Specified by:

apply in interface Helper<Object>

Throws:

IOException

viewAlias

public Jackson2Helper viewAlias(String alias,
                       Class<?> viewClass)

Add an alias for the given view class.

Parameters:

alias - The view alias. Required.

viewClass - The view class. Required.

Returns:

This helper.