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

Class EnsurePropertiesHelper

java.lang.Object

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

All Implemented Interfaces:

HelperPlugin<Object>, Plugin

public final class EnsurePropertiesHelper
extends Object
implements HelperPlugin<Object>

Handlebars helper that checks if all given property names have a value set. If not, an exception is thrown containing the missing property names.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
EnsurePropertiesHelper()

Method Summary

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

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

EnsurePropertiesHelper

public EnsurePropertiesHelper()

Method Details

getName

public String getName()

Description copied from interface: Plugin

Gets plugin name.

Specified by:

getName in interface Plugin

Returns:

Plugin name to be referenced in definition file

apply

public 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.