de.caff.templ

Class MultiSubstitution

java.lang.Object

de.caff.templ.MultiSubstitution

All Implemented Interfaces:

Template

public class MultiSubstitution
extends java.lang.Object
implements Template

Multiple template substitution of a template.

This will call the same sub-template multiple times, with a different inner value provider, but with the same parent provider. Thus, all known tags from the incoming provider are still resolvable.

Since:

April 03, 2026

Author:

Rammi

Field Summary

Fields inherited from interface de.caff.templ.Template

EMPTY

Constructor Summary

Constructors

Constructor and Description
MultiSubstitution(java.lang.String tag, Template subTemplate, Dict<MultiDecoration,Template> deco)
MultiSubstitution(java.lang.String tag, Template subTemplate, java.lang.Iterable<Tuple2<MultiDecoration,Template>> deco)
MultiSubstitution(java.lang.String tag, Template subTemplate, java.util.Map<MultiDecoration,Template> deco)
MultiSubstitution(java.lang.String tag, Template subTemplate, Template separatorTemplate)
MultiSubstitution(java.lang.String tag, Template subTemplate, Template prefixTemplate, Template separatorTemplate, Template suffixTemplate) Constructor.
MultiSubstitution(java.lang.String tag, Template subTemplate, Tuple2<MultiDecoration,Template>... deco)

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.
Template	getPrefixTemplate() Get the prefix template.
Template	getSeparatorTemplate() Get the separator template.
Template	getSubTemplate() Get the multiple inserted sub-template.
Template	getSuffixTemplate() Get the suffix template.
java.lang.String	getTag() Get the tag for the multiple value provider.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.caff.templ.Template

collectUnresolvedTags, resolve

Constructor Detail

MultiSubstitution

public MultiSubstitution(@NotNull
                         java.lang.String tag,
                         @NotNull
                         Template subTemplate,
                         @NotNull
                         Template prefixTemplate,
                         @NotNull
                         Template separatorTemplate,
                         @NotNull
                         Template suffixTemplate)

Constructor.

Parameters:

tag - tag key for the multiple value iterable

subTemplate - sub-template called multiple times

MultiSubstitution

public MultiSubstitution(@NotNull
                         java.lang.String tag,
                         @NotNull
                         Template subTemplate,
                         @NotNull
                         java.lang.Iterable<Tuple2<MultiDecoration,Template>> deco)

MultiSubstitution

@SafeVarargs
public MultiSubstitution(@NotNull
                                      java.lang.String tag,
                                      @NotNull
                                      Template subTemplate,
                                      @NotNull
                                      Tuple2<MultiDecoration,Template>... deco)

MultiSubstitution

public MultiSubstitution(@NotNull
                         java.lang.String tag,
                         @NotNull
                         Template subTemplate,
                         @NotNull
                         Template separatorTemplate)

MultiSubstitution

public MultiSubstitution(@NotNull
                         java.lang.String tag,
                         @NotNull
                         Template subTemplate,
                         @NotNull
                         Dict<MultiDecoration,Template> deco)

MultiSubstitution

public MultiSubstitution(@NotNull
                         java.lang.String tag,
                         @NotNull
                         Template subTemplate,
                         @NotNull
                         java.util.Map<MultiDecoration,Template> deco)

Method Detail

getTag

@NotNull
public java.lang.String getTag()

Get the tag for the multiple value provider.

Returns:

multiple value substitution tag

getSubTemplate

@NotNull
public Template getSubTemplate()

Get the multiple inserted sub-template.

Returns:

sub-template

getPrefixTemplate

@NotNull
public Template getPrefixTemplate()

Get the prefix template.

The prefix template is inserted before the repeated multiple insertion if there is at least one insertion.

Returns:

the prefix template

getSeparatorTemplate

@NotNull
public Template getSeparatorTemplate()

Get the separator template.

The separator template is inserted between repeated multiple insertions if there are at least two insertions.

Returns:

the separator template

getSuffixTemplate

@NotNull
public Template getSuffixTemplate()

Get the suffix template.

The suffix template is inserted after the repeated multiple insertion if there is at least one insertion.

Returns:

the suffix template

appendTo

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

Description copied from interface: Template

Append the resolved template to the given collector.

Specified by:

appendTo in interface Template

Parameters:

collector - collector where the content of this template is appended

valueProvider - value provider for resolving template markers

check

public 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)

Description copied from interface: Template

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.

Specified by:

check in interface Template

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object