HelpersBuilder (trimou-core 1.6.1.Final API)

java.lang.Object
- org.trimou.handlebars.HelpersBuilder

```
public final class HelpersBuilder
extends java.lang.Object
```
A simple builder for helpers map. It's useful when registering built-in/basic helpers with sensible default names (each, if, etc.) - no need to explicitly declare a helper name.
```
 HelpersBuilder.empty().addSet().addIsEven().add("myHelperName", new MyHelper())
         .build();
 
```
Author:

Martin Kouba

See Also:
MustacheEngineBuilder.registerHelpers(Map)

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`EACH`
`static java.lang.String`	`EMBED`
`static java.lang.String`	`IF`
`static java.lang.String`	`INCLUDE`
`static java.lang.String`	`IS`
`static java.lang.String`	`IS_EQUAL`
`static java.lang.String`	`IS_EVEN`
`static java.lang.String`	`IS_NOT_EQUAL`
`static java.lang.String`	`IS_NOT_NULL`
`static java.lang.String`	`IS_NULL`
`static java.lang.String`	`IS_ODD`
`static java.lang.String`	`SET`
`static java.lang.String`	`UNLESS`
`static java.lang.String`	`WITH`

Method Summary

Methods
Modifier and Type	Method and Description
`HelpersBuilder`	`add(java.lang.String name, Helper helper)`
`HelpersBuilder`	`addBuiltin()`
`HelpersBuilder`	`addEach()` Add an instance of `EachHelper` with the "each" name.
`HelpersBuilder`	`addEmbed()` Add an instance of `EmbedHelper` with the "embed" name.
`HelpersBuilder`	`addExtra()`
`HelpersBuilder`	`addIf()` Add an instance of `IfHelper` with the "if" name.
`HelpersBuilder`	`addInclude()` Add an instance of `IncludeHelper` with the "include" name.
`HelpersBuilder`	`addIs()` Add an instance of `IsHelper` with the "is" name.
`HelpersBuilder`	`addIsEqual()` Add an instance of `EqualsHelper` with the "isEq" name.
`HelpersBuilder`	`addIsEven()` Add an instance of `NumberIsEvenHelper` with the "isEven" name.
`HelpersBuilder`	`addIsNotEqual()` Add an instance of `EqualsHelper` which tests inequality with the "isNotEq" name.
`HelpersBuilder`	`addIsNotNull()` Add an instance of `NullCheckHelper` which tests "not null" with the "isNotNull" name.
`HelpersBuilder`	`addIsNull()` Add an instance of `NullCheckHelper` with the "isNull" name.
`HelpersBuilder`	`addIsOdd()` Add an instance of `NumberIsOddHelper` with the "isOdd" name.
`HelpersBuilder`	`addSet()` Add an instance of `SetHelper` with the "set" name.
`HelpersBuilder`	`addUnless()` Add an instance of `UnlessHelper` with the "unless" name.
`HelpersBuilder`	`addWith()` Add an instance of `WithHelper` with the "with" name.
`static HelpersBuilder`	`all()`
`java.util.Map<java.lang.String,Helper>`	`build()`
`static HelpersBuilder`	`builtin()` Built-in helpers are registered automatically if `EngineConfigurationKey.HANDLEBARS_SUPPORT_ENABLED` set to `true`.
`static HelpersBuilder`	`empty()`
`static HelpersBuilder`	`extra()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EACH
```
public static final java.lang.String EACH
```
    See Also:
    Constant Field Values
  - IF
```
public static final java.lang.String IF
```
    See Also:
    Constant Field Values
  - UNLESS
```
public static final java.lang.String UNLESS
```
    See Also:
    Constant Field Values
  - WITH
```
public static final java.lang.String WITH
```
    See Also:
    Constant Field Values
  - IS
```
public static final java.lang.String IS
```
    See Also:
    Constant Field Values
  - IS_EVEN
```
public static final java.lang.String IS_EVEN
```
    See Also:
    Constant Field Values
  - IS_ODD
```
public static final java.lang.String IS_ODD
```
    See Also:
    Constant Field Values
  - SET
```
public static final java.lang.String SET
```
    See Also:
    Constant Field Values
  - INCLUDE
```
public static final java.lang.String INCLUDE
```
    See Also:
    Constant Field Values
  - EMBED
```
public static final java.lang.String EMBED
```
    See Also:
    Constant Field Values
  - IS_EQUAL
```
public static final java.lang.String IS_EQUAL
```
    See Also:
    Constant Field Values
  - IS_NOT_EQUAL
```
public static final java.lang.String IS_NOT_EQUAL
```
    See Also:
    Constant Field Values
  - IS_NULL
```
public static final java.lang.String IS_NULL
```
    See Also:
    Constant Field Values
  - IS_NOT_NULL
```
public static final java.lang.String IS_NOT_NULL
```
    See Also:
    Constant Field Values
- Method Detail
  - add
```
public HelpersBuilder add(java.lang.String name,
                 Helper helper)
```
    Parameters:
    name -
    helper -
    
    Returns:
    self
  - addEach
```
public HelpersBuilder addEach()
```
    Add an instance of EachHelper with the "each" name.
    
    Returns:
    self
  - addIf
```
public HelpersBuilder addIf()
```
    Add an instance of IfHelper with the "if" name.
    
    Returns:
    self
  - addUnless
```
public HelpersBuilder addUnless()
```
    Add an instance of UnlessHelper with the "unless" name.
    
    Returns:
    self
  - addWith
```
public HelpersBuilder addWith()
```
    Add an instance of WithHelper with the "with" name.
    
    Returns:
    self
  - addIs
```
public HelpersBuilder addIs()
```
    Add an instance of IsHelper with the "is" name.
    
    Returns:
    self
  - addIsEven
```
public HelpersBuilder addIsEven()
```
    Add an instance of NumberIsEvenHelper with the "isEven" name.
    
    Returns:
    self
  - addIsOdd
```
public HelpersBuilder addIsOdd()
```
    Add an instance of NumberIsOddHelper with the "isOdd" name.
    
    Returns:
    self
  - addSet
```
public HelpersBuilder addSet()
```
    Add an instance of SetHelper with the "set" name.
    
    Returns:
    self
  - addInclude
```
public HelpersBuilder addInclude()
```
    Add an instance of IncludeHelper with the "include" name.
    
    Returns:
    self
  - addEmbed
```
public HelpersBuilder addEmbed()
```
    Add an instance of EmbedHelper with the "embed" name.
    
    Returns:
    self
  - addIsEqual
```
public HelpersBuilder addIsEqual()
```
    Add an instance of EqualsHelper with the "isEq" name.
    
    Returns:
    self
  - addIsNotEqual
```
public HelpersBuilder addIsNotEqual()
```
    Add an instance of EqualsHelper which tests inequality with the "isNotEq" name.
    
    Returns:
    self
  - addIsNull
```
public HelpersBuilder addIsNull()
```
    Add an instance of NullCheckHelper with the "isNull" name.
    
    Returns:
    self
  - addIsNotNull
```
public HelpersBuilder addIsNotNull()
```
    Add an instance of NullCheckHelper which tests "not null" with the "isNotNull" name.
    
    Returns:
    self
  - addBuiltin
```
public HelpersBuilder addBuiltin()
```
    Returns:
    self
  - addExtra
```
public HelpersBuilder addExtra()
```
    Returns:
    self
  - build
```
public java.util.Map<java.lang.String,Helper> build()
```
    Returns:
    the built map
  - empty
```
public static HelpersBuilder empty()
```
    Returns:
    a new empty builder
  - builtin
```
public static HelpersBuilder builtin()
```
    Built-in helpers are registered automatically if EngineConfigurationKey.HANDLEBARS_SUPPORT_ENABLED set to true.
    
    Returns:
    a new builder, all built-in helpers are added automatically
    See Also:
    addBuiltin()
  - extra
```
public static HelpersBuilder extra()
```
    Returns:
    a new builder, extra helpers are added automatically
    See Also:
    addExtra()
  - all
```
public static HelpersBuilder all()
```
    Returns:
    a new builder, all available helpers are addded automatically

Class HelpersBuilder

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EACH

IF

UNLESS

WITH

IS

IS_EVEN

IS_ODD

SET

INCLUDE

EMBED

IS_EQUAL

IS_NOT_EQUAL

IS_NULL

IS_NOT_NULL

Method Detail

add

addEach

addIf

addUnless

addWith

addIs

addIsEven

addIsOdd

addSet

addInclude

addEmbed

addIsEqual

addIsNotEqual

addIsNull

addIsNotNull

addBuiltin

addExtra

build

empty

builtin

extra

all