Package io.wcm.devops.conga.generator.plugins.handlebars.helper

Class EachIfHelper

java.lang.Object

io.wcm.devops.conga.generator.plugins.handlebars.helper.EachIfHelper

All Implemented Interfaces:

HelperPlugin<Object>, Plugin

public final class EachIfHelper
extends Object

Handlebars helper that extends the each helper by iterating only on list items that have a specified property set. "Deep map access" with dot notation is supported as property names as well.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME	Plugin/Helper name

Constructor Summary

Constructors

Constructor	Description
EachIfHelper()	Constructor

Method Summary

Modifier and Type	Method	Description
final Object	apply(Object context, com.github.jknack.handlebars.Options options, HelperContext pluginContext)	Apply the helper to the context.
String	getName()

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

Plugin/Helper name

See Also:

• Constant Field Values

Constructor Details

EachIfHelper

public EachIfHelper()

Constructor

Method Details

getName

public String getName()

Returns:

Plugin name to be referenced in definition file

apply

public final Object apply(Object context,
 com.github.jknack.handlebars.Options options,
 HelperContext pluginContext)
                   throws IOException

Description copied from interface: HelperPlugin

Apply the helper to the context.

Specified by:

apply in interface HelperPlugin<Object>

Parameters:

context - The context object.

options - The options object.

pluginContext - Plugin context

Returns:

A string result.

Throws:

IOException - If a template cannot be loaded.