org.trimou.handlebars

Class RepeatHelper

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.handlebars.AbstractHelper

org.trimou.handlebars.BasicHelper

org.trimou.handlebars.BasicSectionHelper

org.trimou.handlebars.RepeatHelper

All Implemented Interfaces:

ConfigurationAware, Helper

public class RepeatHelper
extends BasicSectionHelper

Allows to repeat the section multiple times:

 {{#repeat times=3}}
   Hello three times!
 {{/repeat}}
 

Or until the while expression evaluates to a "falsy" value:

 {{#with items.iterator}}
   {{#repeat while=hasNext}}
    {{next}}
   {{/repeat}}
 {{/with}}
 

An interesting use case might be using ListIterator to iterate over the list in reverse order:

 {{#invoke items.size on=items m="listIterator"}}
   {{#repeat while=hasPrevious}}
      {{previous}}
   {{/repeat}}
 {{/invoke}}
 

Since:

2.0

Author:

Martin Kouba

See Also:

Checker.isFalsy(Object)

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

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

getRequiredHashKeys

Methods inherited from class org.trimou.handlebars.AbstractHelper

append, 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

RepeatHelper

public RepeatHelper()

Method Detail

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

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