org.trimou.handlebars

Class SwitchHelper

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.handlebars.AbstractHelper

org.trimou.handlebars.BasicHelper

org.trimou.handlebars.BasicSectionHelper

org.trimou.handlebars.SwitchHelper

All Implemented Interfaces:

ConfigurationAware, Helper

public class SwitchHelper
extends BasicSectionHelper

This helper works similarly as the Java switch statement.

This helper should only contain case and default sections. Other types of segments are always rendered. Note that the default section always terminates the flow!

Since we push the flow object on the context stack, it's possible to refer the value in the switch expression with Nested.up() method. See also examples.

By default, the following template will render "Hello world!":

 {{#switch "hello"}}
   {{#case "foo" break="true"}}
      Hello foo!
   {{/case}}
   {{#case "hello" break="true"}}
      Hello world!
   {{/case}}
   {{#default}}
      No case for {{this.up}}.
   {{/default}}
 {{/switch}}
 

By default, the following template will render "Hello world! No case for hello.":

 {{#switch "hello"}}
   {{#case "foo"}}
      Hello foo!
   {{/case}}
   {{#case "hello"}}
      Hello world!
   {{/case}}
   {{#default}}
      No case for {{this.up}}.
   {{/default}}
 {{/switch}}
 

Author:

Martin Kouba

See Also:

HelpersBuilder.addSwitch()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwitchHelper.CaseHelper The first param is the matching value.
static class	SwitchHelper.DefaultHelper

Field Summary

Fields inherited from class org.trimou.handlebars.BasicSectionHelper

SECTION_TYPES

Fields inherited from class org.trimou.handlebars.BasicHelper

HELPER_TAG_TYPES

Fields inherited from class org.trimou.engine.config.AbstractConfigurationAware

configuration

Constructor Summary

Constructors

Constructor and Description
SwitchHelper()

Method Summary

Modifier and Type	Method and Description
void	execute(Options options) Execute the helper.
protected int	numberOfRequiredParameters()
void	validate(HelperDefinition definition) Helper should validate the tag definition (e.g. number of parameters) during compilation and fail fast if necessary.

Methods inherited from class org.trimou.handlebars.BasicSectionHelper

allowedTagTypes

Methods inherited from class org.trimou.handlebars.BasicHelper

numberOfRequiredHashEntries

Methods inherited from class org.trimou.handlebars.AbstractHelper

append, getHashValue, init, isSection, isUnescapeVariable, isVariable

Methods inherited from class org.trimou.engine.config.AbstractConfigurationAware

getConfigurationKeys, checkNotInitialized, init

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.trimou.engine.config.ConfigurationAware

getConfigurationKeys, init

Constructor Detail

SwitchHelper

public SwitchHelper()

Method Detail

numberOfRequiredParameters

protected int numberOfRequiredParameters()

Overrides:

numberOfRequiredParameters in class BasicHelper

execute

public void execute(Options options)

Description copied from interface: Helper

Execute the helper.

validate

public void validate(HelperDefinition definition)

Description copied from interface: Helper

Helper should validate the tag definition (e.g. number of parameters) during compilation and fail fast if necessary. A MustacheException with code MustacheProblem.COMPILE_HELPER_VALIDATION_FAILURE should be thrown in case of validation failure occurs.

Specified by:

validate in interface Helper

Overrides:

validate in class BasicHelper