de.caff.templ

Interface Template

All Known Implementing Classes:

MultiSubstitution, SimpleSubstitution, TemplateCollection, Text

public interface Template

Basic template implementation.

Since:

April 03, 2026

Author:

Rammi

Field Summary

Fields

Modifier and Type	Field and Description
static Template	EMPTY A template which appends nothing.

Method Summary

Modifier and Type	Method and Description
void	appendTo(java.lang.StringBuilder collector, ValueProvider valueProvider) Append the resolved template to the given collector.
void	check(ValueProvider valueProvider, FStack<TagReference> insertionStack, java.util.function.Consumer<FStack<TagReference>> resolvedTagHandler, java.util.function.Consumer<FStack<TagReference>> unresolvedTagHandler) Run a check with the given value provider.
default java.util.List<java.lang.String>	collectUnresolvedTags(ValueProvider valueProvider)
default java.lang.String	resolve(ValueProvider valueProvider) Resolve this template.

Field Detail

EMPTY

@NotNull
static final Template EMPTY

A template which appends nothing.

Method Detail

appendTo

void appendTo(@NotNull
              java.lang.StringBuilder collector,
              @NotNull
              ValueProvider valueProvider)

Append the resolved template to the given collector.

Parameters:

collector - collector where the content of this template is appended

valueProvider - value provider for resolving template markers

Throws:

UnresolvableTagError - if a template marker couldn't be resolved

check

void check(@NotNull
           ValueProvider valueProvider,
           @NotNull
           FStack<TagReference> insertionStack,
           @NotNull
           java.util.function.Consumer<FStack<TagReference>> resolvedTagHandler,
           @NotNull
           java.util.function.Consumer<FStack<TagReference>> unresolvedTagHandler)

Run a check with the given value provider.

Instead of throwing after the first problem this method is expected to check as much as possible.

Parameters:

valueProvider - value provider checked against this template

insertionStack - stack of multiple insertions before the level of this check is reached

resolvedTagHandler - collector for successfully resolved template tags

unresolvedTagHandler - collector for unresolvable template tags, if multiple tags fail to be resolved tags in lower levels cannot be checked

collectUnresolvedTags

@NotNull
default java.util.List<java.lang.String> collectUnresolvedTags(@NotNull
                                                                        ValueProvider valueProvider)

resolve

@NotNull
default java.lang.String resolve(@NotNull
                                          ValueProvider valueProvider)

Resolve this template.

Parameters:

valueProvider - value provider for resolving template markers

Returns:

resolved template

Throws:

UnresolvableTagError - if a template marker couldn't be resolved