org.trimou.handlebars

Class SetHelper

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.handlebars.AbstractHelper

org.trimou.handlebars.BasicHelper

org.trimou.handlebars.BasicSectionHelper

org.trimou.handlebars.SetHelper

All Implemented Interfaces:

ConfigurationAware, Helper

public class SetHelper
extends BasicSectionHelper

Works similarly as WithHelper except the current HelperDefinition.getHash() map is pushed on the context stack.

 {{#set foo="hello"}}
   {{foo}}
 {{/set}}
 

 {{#set foo="Hello" myName=person.name}}
   {{foo}} {{myName}}!
 {{/set}}
 

Author:

Martin Kouba

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
SetHelper()

Method Summary

Modifier and Type	Method and Description
void	execute(Options options) Execute the helper.
protected Set<String>	getSupportedHashKeys()
protected int	numberOfRequiredHashEntries()
protected int	numberOfRequiredParameters()

Methods inherited from class org.trimou.handlebars.BasicSectionHelper

allowedTagTypes

Methods inherited from class org.trimou.handlebars.BasicHelper

getRequiredHashKeys, validate

Methods inherited from class org.trimou.handlebars.AbstractHelper

append, convertAndAppend, convertValue, init, isSection, isUnescapeVariable, isVariable

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

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

SetHelper

public SetHelper()

Method Detail

execute

public void execute(Options options)

Description copied from interface: Helper

Execute the helper.

numberOfRequiredParameters

protected int numberOfRequiredParameters()

Overrides:

numberOfRequiredParameters in class BasicHelper

numberOfRequiredHashEntries

protected int numberOfRequiredHashEntries()

Overrides:

numberOfRequiredHashEntries in class BasicHelper

getSupportedHashKeys

protected Set<String> getSupportedHashKeys()

Overrides:

getSupportedHashKeys in class BasicHelper

Returns:

a set of supported hash keys or singleton of value * to allow any hash keys