Class FreemarkerEngine

java.lang.Object

org.jdbi.v3.freemarker.FreemarkerEngine

All Implemented Interfaces:

TemplateEngine, TemplateEngine.Parsing

public class FreemarkerEngine
extends Object
implements TemplateEngine.Parsing

Rewrites a Freemarker template, using the attributes on the StatementContext as template parameters.

Nested Class Summary

Nested classes/interfaces inherited from interface TemplateEngine

TemplateEngine.Parsing

Modifier and Type	Interface	Description
static interface	TemplateEngine.Parsing

Field Summary

Fields inherited from interface TemplateEngine

NOP

Modifier and Type	Field	Description
static final TemplateEngine	NOP	Convenience constant that returns the input template.

Constructor Summary

Constructors

Constructor	Description
FreemarkerEngine()	Deprecated, for removal: This API element is subject to removal in a future version. use instance() for a shared engine instead

Method Summary

Modifier and Type	Method	Description
static FreemarkerEngine	instance()
Optional<Function<StatementContext, String>>	parse(String sqlTemplate, ConfigRegistry config)	Parse a SQL template and return a parsed representation ready to apply to a statement.

Methods inherited from class Object

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

Methods inherited from interface TemplateEngine.Parsing

render

Modifier and Type	Method	Description
default String	render(String template, StatementContext ctx)	Renders an SQL statement from the given template, using the statement context as needed.

Constructor Details

FreemarkerEngine

@Deprecated(since="3.39.0",
            forRemoval=true)
public FreemarkerEngine()

Deprecated, for removal: This API element is subject to removal in a future version.

use instance() for a shared engine instead

Method Details

instance

public static FreemarkerEngine instance()

parse

public Optional<Function<StatementContext, String>> parse(String sqlTemplate,
 ConfigRegistry config)

Description copied from interface: TemplateEngine

Parse a SQL template and return a parsed representation ready to apply to a statement. This allows the parsed representation to be cached and reused.

Specified by:

parse in interface TemplateEngine

Specified by:

parse in interface TemplateEngine.Parsing

Parameters:

sqlTemplate - the sql template to parse

config - the Jdbi configuration at prepare time

Returns:

a parsed representation, if available