de.caff.templ

Class SimpleSubstitution

java.lang.Object

de.caff.templ.SimpleSubstitution

All Implemented Interfaces:

Template

public class SimpleSubstitution
extends java.lang.Object
implements Template

A simple substitution of a template marker with its resolved text.

Since:

April 03, 2026

Author:

Rammi

Field Summary

Fields inherited from interface de.caff.templ.Template

EMPTY

Constructor Summary

Constructors

Constructor and Description
SimpleSubstitution(java.lang.String tag) Constructor.

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.
java.lang.String	getTag() Get the key of this substitution.
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

SimpleSubstitution

public SimpleSubstitution(@NotNull
                          java.lang.String tag)

Constructor.

Parameters:

tag - substitution tag

Method Detail

getTag

@NotNull
public java.lang.String getTag()

Get the key of this substitution.

Returns:

substitution key

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