org.trimou.handlebars

Class NullCheckHelper

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.handlebars.AbstractHelper

org.trimou.handlebars.BasicHelper

org.trimou.handlebars.BasicSectionHelper

org.trimou.handlebars.NullCheckHelper

All Implemented Interfaces:

ConfigurationAware, Helper

public class NullCheckHelper
extends BasicSectionHelper

Renders a block if the param is/isn't null.

 {{#isNull item.price}}
   It's null!
 {{/isNull}}
 

Multiple params may be evaluated. The default evaluation logic is conjunction:

 {{#isNull item.active item.valid}}
   All are null.
 {{/isNull}}
 

The evaluation logic may be specified:

 {{#isNull item.active item.valid logic="or"}}
   At least one is null.
 {{/isNull}}
 

Author:

Martin Kouba

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	MatchingSectionHelper.EvaluationLogic

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
NullCheckHelper() Test null.
NullCheckHelper(boolean testNotNull)

Method Summary

Modifier and Type	Method and Description
void	execute(Options options) Execute the helper.
protected MatchingSectionHelper.EvaluationLogic	getDefaultLogic()
protected Set<String>	getSupportedHashKeys()
protected boolean	hasEmptyParamsSupport()
protected boolean	isMatching(Object value)
protected boolean	isMatching(Object value, Options options)
protected int	numberOfRequiredParameters()

Methods inherited from class org.trimou.handlebars.BasicSectionHelper

allowedTagTypes

Methods inherited from class org.trimou.handlebars.BasicHelper

getRequiredHashKeys, numberOfRequiredHashEntries, 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

NullCheckHelper

public NullCheckHelper()

Test null.

NullCheckHelper

public NullCheckHelper(boolean testNotNull)

Parameters:

testNotNull -

Method Detail

isMatching

protected boolean isMatching(Object value)

execute

public void execute(Options options)

Description copied from interface: Helper

Execute the helper.

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

getDefaultLogic

protected MatchingSectionHelper.EvaluationLogic getDefaultLogic()

isMatching

protected boolean isMatching(Object value,
                             Options options)

hasEmptyParamsSupport

protected boolean hasEmptyParamsSupport()

numberOfRequiredParameters

protected int numberOfRequiredParameters()

Overrides:

numberOfRequiredParameters in class BasicHelper