org.trimou.handlebars

Class LogHelper

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.handlebars.AbstractHelper

org.trimou.handlebars.BasicHelper

org.trimou.handlebars.BasicValueHelper

org.trimou.handlebars.LogHelper

All Implemented Interfaces:

ConfigurationAware, Helper

public class LogHelper
extends BasicValueHelper

A simple log helper. There is a special LogHelper.Builder for convenience.

First register the helper instance:

MustacheEngineBuilder.newBuilder().registerHelper("log", LogHelper.builder().setDefaultLevel(Level.DEBUG).build()).build();

Than use the helper in the template:

{{log "Hello"}}

The message need not be a string literal:

{{log foo.message}}

You may also override the default log level:

{{log "" level="DEBUG"}}

And also use message parameters:

{{log "Number of items found: {}" items.size}}

Note that the final output will depend on the specified LogHelper.LoggerAdapter and underlying logging framework configuration.

Author:

Martin Kouba

See Also:

LogHelper.Level, LogHelper.LoggerAdapter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogHelper.Builder
static class	LogHelper.Level Log level.
static interface	LogHelper.LoggerAdapter Log event adapter.
static class	LogHelper.Slf4jLoggerAdapter A default adapter implementation for SLF4J.

Field Summary

Fields inherited from class org.trimou.handlebars.BasicValueHelper

VALUE_TAG_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
LogHelper(LogHelper.LoggerAdapter adapter, LogHelper.Level defaultLevel, boolean appendTemplateInfo)

Method Summary

Modifier and Type	Method and Description
static LogHelper.Builder	builder()
void	execute(Options options) Execute the helper.
protected Set<String>	getSupportedHashKeys()

Methods inherited from class org.trimou.handlebars.BasicValueHelper

allowedTagTypes

Methods inherited from class org.trimou.handlebars.BasicHelper

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

LogHelper

public LogHelper(LogHelper.LoggerAdapter adapter,
                 LogHelper.Level defaultLevel,
                 boolean appendTemplateInfo)

Parameters:

adapter -

defaultLevel -

appendTemplateInfo - If true, a template name and helper line will be appended to each log message

Method Detail

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

builder

public static LogHelper.Builder builder()

Returns:

a new instance of builder