de.caff.util

Class TextTemplateHandler<T>

java.lang.Object

de.caff.util.TextTemplateHandler<T>

Direct Known Subclasses:

TextTemplateHandler.WithoutContext

public class TextTemplateHandler<T>
extends java.lang.Object

Simple template handler allowing to expand special strings in texts.

This is thought for quite simple cases where only a few patterns are substituted as it goes over the whole text for each substitution pattern once.

Since:

August 12, 2019

Author:

Rammi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TextTemplateHandler.CtxExpander<T> Expander which uses a context.
static interface	TextTemplateHandler.Expander Context-less expander.
static class	TextTemplateHandler.WithoutContext Helper class.

Constructor Summary

Constructors

Constructor and Description
TextTemplateHandler()

Method Summary

Modifier and Type	Method and Description
java.lang.String	expand(java.lang.String text, T context) Expand a string with the given context.
static TextTemplateHandler.WithoutContext	fromMapping(java.lang.String prefix, java.lang.String suffix, java.util.Map<java.lang.String,java.lang.String> mapping) Factory method for a text template handler which just substitutes specially formed tags with constant texts.
static TextTemplateHandler.WithoutContext	fromMapping(java.lang.String prefix, java.lang.String suffix, java.lang.String... keyAndValuePairs) Factory method for a text template handler which just substitutes specially formed tags with constant texts.
static void	main(java.lang.String[] args) Test code.
void	register(java.util.regex.Pattern pattern, java.lang.String text) Register an expander for a regular expression pattern which just returns a simple constant text.
void	register(java.util.regex.Pattern pattern, TextTemplateHandler.CtxExpander<T> expander) Register an expander for a regular expression pattern.
void	register(java.lang.String sequence, java.lang.String text) Register an expander for a simple string pattern which just returns a simple constant text.
void	register(java.lang.String sequence, TextTemplateHandler.CtxExpander<T> expander) Register an expander for a simple string pattern.
static TextTemplateHandler.WithoutContext	withoutContext() Factory method for a text template handler which does not use a context.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextTemplateHandler

public TextTemplateHandler()

Method Detail

register

public void register(@NotNull
                     java.util.regex.Pattern pattern,
                     @NotNull
                     TextTemplateHandler.CtxExpander<T> expander)

Register an expander for a regular expression pattern.

Parameters:

pattern - pattern to look for

expander - expander to be called if pattern is found

register

public void register(@NotNull
                     java.lang.String sequence,
                     @NotNull
                     TextTemplateHandler.CtxExpander<T> expander)

Register an expander for a simple string pattern.

Parameters:

sequence - string sequence to look for

expander - expander to be called if sequence is found

register

public void register(@NotNull
                     java.util.regex.Pattern pattern,
                     @NotNull
                     java.lang.String text)

Register an expander for a regular expression pattern which just returns a simple constant text.

Parameters:

pattern - pattern to look for

text - text used for substituting the pattern

register

public void register(@NotNull
                     java.lang.String sequence,
                     @NotNull
                     java.lang.String text)

Register an expander for a simple string pattern which just returns a simple constant text.

Parameters:

sequence - string sequence to look for

text - text used for substituting the pattern

expand

@NotNull
public java.lang.String expand(@NotNull
                                        java.lang.String text,
                                        @NotNull
                                        T context)
                                 throws java.io.IOException

Expand a string with the given context.

Parameters:

text - text string

context - context to use for expansion

Returns:

expanded string

Throws:

java.io.IOException - on expansion errors

withoutContext

@NotNull
public static TextTemplateHandler.WithoutContext withoutContext()

Factory method for a text template handler which does not use a context.

Returns:

context-less handler

fromMapping

@NotNull
public static TextTemplateHandler.WithoutContext fromMapping(@NotNull
                                                                      java.lang.String prefix,
                                                                      @NotNull
                                                                      java.lang.String suffix,
                                                                      @NotNull
                                                                      java.util.Map<java.lang.String,java.lang.String> mapping)

Factory method for a text template handler which just substitutes specially formed tags with constant texts.

An example:

   
    Map<String, String> mapping = new HashMap<>();
    mapping.put("ONE", "1");
    mapping.put("TWO", "2");
    mapping.put("THREE", "3");
    WithoutContext wc = fromMapping("{{", "}}", mapping);

    String text = "{{ONE}}{{TWO}}{{THREE}}";
    String expect = "123";
    assert expect.equals(wc.expand(text));
   
 

Parameters:

prefix - tag prefix marker

suffix - tag suffix marker

mapping - mapping of tag content

Returns:

simple text template handler

fromMapping

@NotNull
public static TextTemplateHandler.WithoutContext fromMapping(@NotNull
                                                                      java.lang.String prefix,
                                                                      @NotNull
                                                                      java.lang.String suffix,
                                                                      @NotNull
                                                                      java.lang.String... keyAndValuePairs)

Factory method for a text template handler which just substitutes specially formed tags with constant texts.

An example:

   
    WithoutContext wc = fromMapping("{{", "}}",
                                    "ONE", "1",
                                    "TWO", "2",
                                    "THREE", "3");

    String text = "{{ONE}}{{TWO}}{{THREE}}";
    String expect = "123";
    assert expect.equals(wc.expand(text));
   
 

Parameters:

prefix - tag prefix marker

suffix - tag suffix marker

keyAndValuePairs - an even number of paired keys (even index) and values (odd index)

Returns:

simple text template handler

main

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

Test code.

Parameters:

args - ignored

Throws:

java.io.IOException - on template errors