Module io.jstach.jstachio

Package io.jstach.jstachio

Interface TemplateConfig

public interface TemplateConfig

A Container for optional template collaborators for ease of wiring generated Templates.

Author:

agentgt

API Note

the default methods return null to indicate to the template constructor to use the static default collaborator and is the reason why TemplateInfo does not extend this interface.

Method Summary

Modifier and Type	Method	Description
static TemplateConfig	empty()	A config with no provided collaborators.
default @Nullable Function<String,String>	escaper()	The escaper to be used on the template.
default @Nullable Function<@Nullable Object,String>	formatter()	The base formatter to be used on the template.

Method Details

empty

static TemplateConfig empty()

A config with no provided collaborators.

Returns:

empty config

escaper

default @Nullable Function<String,String> escaper()

The escaper to be used on the template. See Escaper.of(Function).

Returns:

the escaper or null

See Also:

• Escaper

API Note

While the return signature is Function the function is often an Escaper but does not have to be.

formatter

default @Nullable Function<@Nullable Object,String> formatter()

The base formatter to be used on the template. See Formatter.of(Function).

Returns:

the formatter or null

See Also:

• Formatter

API Note

While the return signature is Function the function is often a Formatter but does not have to be.