HelpersBuilder (trimou-core 1.8.0.Final API)

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

```
public final class HelpersBuilder
extends 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), MustacheEngineBuilder.registerHelpers(Map, boolean)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ASYNC`
`static String`	`CASE`
`static String`	`DEFAULT`
`static String`	`EACH`
`static String`	`EMBED`
`static String`	`EVAL`
`static String`	`CHOOSE`
`static String`	`IF`
`static String`	`INCLUDE`
`static String`	`IS`
`static String`	`IS_EQUAL`
`static String`	`IS_EVEN`
`static String`	`IS_NOT_EQUAL`
`static String`	`IS_NOT_NULL`
`static String`	`IS_NULL`
`static String`	`IS_ODD`
`static String`	`JOIN`
`static String`	`NUMERIC_EXPRESSION`
`static String`	`OTHERWISE`
`static String`	`SET`
`static String`	`SWITCH`
`static String`	`UNLESS`
`static String`	`WHEN`
`static String`	`WITH`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HelpersBuilder`	`add(String name, Helper helper)`
`HelpersBuilder`	`addAsync()` Add an instance of `AsyncHelper`.
`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`	`addEmbed(EmbedHelper.SourceProcessor processor)` Add an instance of `EmbedHelper` with the "embed" name and the source processor.
`HelpersBuilder`	`addEval()` Add an instance of `EvalHelper`.
`HelpersBuilder`	`addEval(EvalHelper.Notation notation)` Add an instance of `EvalHelper`.
`HelpersBuilder`	`addExtra()`
`HelpersBuilder`	`addChoose()` Add an instance of `ChooseHelper` with the "choose" name.
`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`	`addJoin()` Add an instance of `JoinHelper`.
`HelpersBuilder`	`addNumExpr()` Add an instance of `NumericExpressionHelper`.
`HelpersBuilder`	`addSet()` Add an instance of `SetHelper` with the "set" name.
`HelpersBuilder`	`addSwitch()` Add an instance of `SwitchHelper` with the "switch" name.
`HelpersBuilder`	`addSwitch(boolean caseDefaultIsBreak)` Add an instance of `SwitchHelper` with the "switch" 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()`
`Map<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 String EACH
```
    See Also:
    
    Constant Field Values
  - IF
```
public static final String IF
```
    See Also:
    
    Constant Field Values
  - UNLESS
```
public static final String UNLESS
```
    See Also:
    
    Constant Field Values
  - WITH
```
public static final String WITH
```
    See Also:
    
    Constant Field Values
  - IS
```
public static final String IS
```
    See Also:
    
    Constant Field Values
  - IS_EVEN
```
public static final String IS_EVEN
```
    See Also:
    
    Constant Field Values
  - IS_ODD
```
public static final String IS_ODD
```
    See Also:
    
    Constant Field Values
  - SET
```
public static final String SET
```
    See Also:
    
    Constant Field Values
  - INCLUDE
```
public static final String INCLUDE
```
    See Also:
    
    Constant Field Values
  - EMBED
```
public static final String EMBED
```
    See Also:
    
    Constant Field Values
  - IS_EQUAL
```
public static final String IS_EQUAL
```
    See Also:
    
    Constant Field Values
  - IS_NOT_EQUAL
```
public static final String IS_NOT_EQUAL
```
    See Also:
    
    Constant Field Values
  - IS_NULL
```
public static final String IS_NULL
```
    See Also:
    
    Constant Field Values
  - IS_NOT_NULL
```
public static final String IS_NOT_NULL
```
    See Also:
    
    Constant Field Values
  - CHOOSE
```
public static final String CHOOSE
```
    See Also:
    
    Constant Field Values
  - WHEN
```
public static final String WHEN
```
    See Also:
    
    Constant Field Values
  - OTHERWISE
```
public static final String OTHERWISE
```
    See Also:
    
    Constant Field Values
  - SWITCH
```
public static final String SWITCH
```
    See Also:
    
    Constant Field Values
  - CASE
```
public static final String CASE
```
    See Also:
    
    Constant Field Values
  - DEFAULT
```
public static final String DEFAULT
```
    See Also:
    
    Constant Field Values
  - JOIN
```
public static final String JOIN
```
    See Also:
    
    Constant Field Values
  - EVAL
```
public static final String EVAL
```
    See Also:
    
    Constant Field Values
  - NUMERIC_EXPRESSION
```
public static final String NUMERIC_EXPRESSION
```
    See Also:
    
    Constant Field Values
  - ASYNC
```
public static final String ASYNC
```
    See Also:
    
    Constant Field Values
- Method Detail
  - add
```
public HelpersBuilder add(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
  - addEmbed
```
public HelpersBuilder addEmbed(EmbedHelper.SourceProcessor processor)
```
    Add an instance of EmbedHelper with the "embed" name and the source processor.
    
    Parameters:
    
    processor -
    
    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
  - addChoose
```
public HelpersBuilder addChoose()
```
    Add an instance of ChooseHelper with the "choose" name. Also adds the dependent helpers.
    
    Returns:
    
    self
  - addSwitch
```
public HelpersBuilder addSwitch()
```
    Add an instance of SwitchHelper with the "switch" name. Also adds the dependent helpers.
    
    Returns:
    
    self
  - addSwitch
```
public HelpersBuilder addSwitch(boolean caseDefaultIsBreak)
```
    Add an instance of SwitchHelper with the "switch" name. Also adds the dependent helpers.
    
    Parameters:
    
    caseDefaultIsBreak - If true the matching case helper terminates the flow by default.
    
    Returns:
    
    self
  - addJoin
```
public HelpersBuilder addJoin()
```
    Add an instance of JoinHelper.
    
    Returns:
    
    self
  - addEval
```
public HelpersBuilder addEval()
```
    Add an instance of EvalHelper.
    
    Returns:
    
    self
  - addEval
```
public HelpersBuilder addEval(EvalHelper.Notation notation)
```
    Add an instance of EvalHelper.
    
    Parameters:
    
    notation -
    
    Returns:
    
    self
  - addNumExpr
```
public HelpersBuilder addNumExpr()
```
    Add an instance of NumericExpressionHelper.
    
    Returns:
    
    self
  - addAsync
```
public HelpersBuilder addAsync()
```
    Add an instance of AsyncHelper.
    
    Returns:
    
    self
  - addBuiltin
```
public HelpersBuilder addBuiltin()
```
    Returns:
    
    self
  - addExtra
```
public HelpersBuilder addExtra()
```
    Returns:
    
    self
  - build
```
public Map<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

CHOOSE

WHEN

OTHERWISE

SWITCH

CASE

DEFAULT

JOIN

EVAL

NUMERIC_EXPRESSION

ASYNC

Method Detail

add

addEach

addIf

addUnless

addWith

addIs

addIsEven

addIsOdd

addSet

addInclude

addEmbed

addEmbed

addIsEqual

addIsNotEqual

addIsNull

addIsNotNull

addChoose

addSwitch

addSwitch

addJoin

addEval

addEval

addNumExpr

addAsync

addBuiltin

addExtra

build

empty

builtin

extra

all