Package org.apache.juneau.commons.template

Class TemplateResolver.Builder

java.lang.Object

org.apache.juneau.commons.template.TemplateResolver.Builder

Enclosing class:

TemplateResolver

public static final class TemplateResolver.Builder
extends Object

Builder for TemplateResolver.

Method Summary

Modifier and Type	Method	Description
TemplateResolver.Builder	allowFunctions(String... patterns)	Adds function-name globs to the default allowlist (SafeFunctions.patterns()).
TemplateResolver.Builder	allowOnlyFunctions(String... patterns)	Replaces the default function allowlist (SafeFunctions.patterns()) with exactly these globs.
TemplateResolver	build()	Builds the resolver.
TemplateResolver.Builder	destination(Destination value)	Sets the default value encoder and structure renderer from a destination preset.
TemplateResolver.Builder	functions(VarFunction... values)	Registers additional functions.
TemplateResolver.Builder	maxCollectionSize(int value)	Sets the maximum number of elements one expression may iterate, and the maximum per container when formatting.
TemplateResolver.Builder	strict(boolean value)	Enables strict mode: an unknown or denied function, or an expression error, throws instead of being emitted as written.
TemplateResolver.Builder	structureRenderer(StructureRenderer value)	Sets how lists, blocks and tables are rendered.
TemplateResolver.Builder	vars(Var... values)	Registers additional vars.

Methods inherited from class java.lang.Object

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

Method Details

vars

public TemplateResolver.Builder vars(Var... values)

Registers additional vars. None are registered by default except the internal scope var.

Parameters:

values - The vars. Must not be null. A var named P replaces the scope var, which rebinds the ${name} shortcut.

Returns:

This object.

functions

public TemplateResolver.Builder functions(VarFunction... values)

Registers additional functions.

Parameters:

values - The functions. Must not be null. They are also subject to the allowlist.

Returns:

This object.

allowFunctions

public TemplateResolver.Builder allowFunctions(String... patterns)

Adds function-name globs to the default allowlist (SafeFunctions.patterns()).

Repeated calls are additive. A bare * is rejected because it would switch default-deny off; use allowOnlyFunctions(String...) to replace the defaults.

Parameters:

patterns - The patterns. Must not be null, and must not be *.

Returns:

This object.

Throws:

IllegalArgumentException - If a pattern is *.

allowOnlyFunctions

public TemplateResolver.Builder allowOnlyFunctions(String... patterns)

Replaces the default function allowlist (SafeFunctions.patterns()) with exactly these globs.

Include $op.* to keep the operators. Patterns from allowFunctions(String...) are still added. A bare * is rejected.

Parameters:

patterns - The patterns. Must not be null, and must not be *.

Returns:

This object.

Throws:

IllegalArgumentException - If a pattern is *.

strict

public TemplateResolver.Builder strict(boolean value)

Enables strict mode: an unknown or denied function, or an expression error, throws instead of being emitted as written.

Parameters:

value - Whether to enable strict mode.

Returns:

This object.

maxCollectionSize

public TemplateResolver.Builder maxCollectionSize(int value)

Sets the maximum number of elements one expression may iterate, and the maximum per container when formatting.

Parameters:

value - The limit. Must be positive.

Returns:

This object.

structureRenderer

public TemplateResolver.Builder structureRenderer(StructureRenderer value)

Sets how lists, blocks and tables are rendered. Overrides the renderer of destination(Destination).

Without a renderer Structure.toString() is used, and its items are not encoded.

Parameters:

value - The renderer. null clears it.

Returns:

This object.

destination

public TemplateResolver.Builder destination(Destination value)

Sets the default value encoder and structure renderer from a destination preset.

Parameters:

value - The destination. null clears it.

Returns:

This object.

build

public TemplateResolver build()

Builds the resolver.

Returns:

A new resolver.