de.caff.templ

Class SimpleTemplateParser

java.lang.Object

de.caff.templ.SimpleTemplateParser

public class SimpleTemplateParser
extends java.lang.Object

Simple template parser which converts text into a template.

It understands a few simple substitutions:

• Normal text will be substituted by itself, with the exception of '{{' which will be substituted by a single '{'.
• {tag} will be substituted by the resolved value of tag.
• {[tag<deco>}<template>{]tag} will be substituted by a multiple insertion of the inner part. Repeating the tag in the closing marker is optional but recommended, as it allows to detect incorrect nesting. The decoration <deco> contains three optional parts:
  • A prefix (marked with '^') which will be inserted at the beginning if at least one multiple insertion is performed. It has the format ^<m><template><m>. <m> is a character used to enclose the template. It can be freely chosen, with the only limitation that it must not appear in the template text itself.
  • A separator (marked with '|') which will be inserted between multiple insertions. It has the format |<m><template><m>. <m> is a character used to enclose the template. It can be freely chosen, with the only limitation that it must not appear in the template text itself.
  • A suffix (marked with '$') which will be inserted at the end if at least one multiple insertion was performed. It has the format $<m><template><m>. <m> is a character used to enclose the template. It can be freely chosen, with the only limitation that it must not appear in the template text itself.
• {@mark} will be substituted by anything the given partial template provider returns. It is most useful for inserting templates created from other files, or for inserting the same template more than once, if the given SubTemplateProvider returns the same template for the same mark (easily done with SubTemplateProvider.withCache()).

Since:

April 03, 2026

Author:

Rammi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SimpleTemplateParser.CharStepper

Field Summary

Fields

Modifier and Type	Field and Description
static IntPredicate1	DEFAULT_ALLOWED_KEYS The default allowed characters for names.

Constructor Summary

Constructors

Constructor and Description
SimpleTemplateParser(SubTemplateProvider subTemplateProvider)
SimpleTemplateParser(SubTemplateProvider subTemplateProvider, java.util.function.IntPredicate allowedKeys)

Method Summary

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) Test code.
static Template	parse(java.io.File file, SubTemplateProvider subTemplateProvider)
Template	parse(java.io.Reader reader)
static Template	parse(java.io.Reader reader, SubTemplateProvider subTemplateProvider)
Template	parse(SimpleTemplateParser.CharStepper stepper)
Template	parse(java.lang.String text)
static Template	parse(java.lang.String text, SubTemplateProvider subTemplateProvider)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ALLOWED_KEYS

public static final IntPredicate1 DEFAULT_ALLOWED_KEYS

The default allowed characters for names.

• All alphabetic characters.
• All digits.
• The hyphen ('-'.
• The underscore ('_'.

Constructor Detail

SimpleTemplateParser

public SimpleTemplateParser(@NotNull
                            SubTemplateProvider subTemplateProvider)

SimpleTemplateParser

public SimpleTemplateParser(@NotNull
                            SubTemplateProvider subTemplateProvider,
                            @NotNull
                            java.util.function.IntPredicate allowedKeys)

Method Detail

parse

@NotNull
public Template parse(@NotNull
                               java.io.Reader reader)
                        throws java.io.IOException

Throws:

java.io.IOException

parse

@NotNull
public Template parse(@NotNull
                               java.lang.String text)
                        throws java.io.IOException

Throws:

java.io.IOException

parse

@NotNull
public Template parse(@NotNull
                               SimpleTemplateParser.CharStepper stepper)
                        throws java.io.IOException

Throws:

java.io.IOException

parse

@NotNull
public static Template parse(@NotNull
                                      java.io.Reader reader,
                                      @NotNull
                                      SubTemplateProvider subTemplateProvider)
                               throws java.io.IOException

Throws:

java.io.IOException

parse

@NotNull
public static Template parse(@NotNull
                                      java.lang.String text,
                                      @NotNull
                                      SubTemplateProvider subTemplateProvider)
                               throws java.io.IOException

Throws:

java.io.IOException

parse

@NotNull
public static Template parse(@NotNull
                                      java.io.File file,
                                      @NotNull
                                      SubTemplateProvider subTemplateProvider)
                               throws java.io.IOException

Throws:

java.io.IOException

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException

Test code.

Throws:

java.io.IOException