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

Class DisallowPropertyHelper

java.lang.Object

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

All Implemented Interfaces:

HelperPlugin<Object>, Plugin

public final class DisallowPropertyHelper
extends Object
implements HelperPlugin<Object>

Handlebars helper that ensures a given property is not set/present. If it is, an exception is thrown with the property name. Optionally, a second parameter can be provided with a custom error message.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
DisallowPropertyHelper()

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

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

Plugin/Helper name

See Also:

Constant Field Values

Constructor Detail

DisallowPropertyHelper

public DisallowPropertyHelper()

Method Detail

getName

public String getName()

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.