net.e6tech.elements.common.util

Class TextSubstitution

java.lang.Object

net.e6tech.elements.common.util.TextSubstitution

public class TextSubstitution
extends java.lang.Object

Created by futeh.

This class is used for substitute variables in text. It supports nested expressions like

"${${a}.${b}:+ ${${a}.${b}}} ${x.name}"

However, in general, one should not go crazy with it.

An example of it usage:

     String text = "${${a}.${b}:+ ${${a}.${b}}} ${x.name}";
     TextSubstitution sub = new TextSubstitution(text);
     Map<String, Object> map = new HashMap<>();
     map.put("x", new X());
     map.put("a", "x");
     map.put("b", "name");
     String output = sub.build(map);

  ${var:default} expands to default if var not defined, to var if var is defined.
  ${var::default} same as above.  The extra ':' is to escape special characters like +, - and =
  ${var:+default} expands to "" if var is not defined, to default if var is defined.
  ${var:-default} expands to default if var not defined, to "" if var is defined.
  ${var:=predicate?match:not-match} expands to match if value of var equals to predicate, else not-match
     example: "${key := A ?B:C}";  the spaces after the '?' are important.
  ${var:^script} executes the script with value of var and returns a string from the execution.
  

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextSubstitution.DefaultScriptable
static interface	TextSubstitution.Scriptable

Constructor Summary

Constructors

Constructor and Description
TextSubstitution(java.io.Reader reader)
TextSubstitution(java.lang.String template)

Method Summary

Modifier and Type	Method and Description
java.lang.String	build(java.lang.Object binding)
java.lang.String	build(java.lang.Object binding, java.util.Map<java.lang.String,java.lang.Object> auxillary)
static java.lang.String	capitalize(java.lang.String name)
static TextSubstitution.DefaultScriptable	defaultScriptable()
java.lang.String	getTemplate()
TextSubstitution	withScriptable(TextSubstitution.Scriptable script)

Methods inherited from class java.lang.Object

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

Constructor Detail

TextSubstitution

public TextSubstitution(java.lang.String template)

TextSubstitution

public TextSubstitution(java.io.Reader reader)
                 throws java.io.IOException

Throws:

java.io.IOException

Method Detail

defaultScriptable

public static TextSubstitution.DefaultScriptable defaultScriptable()

getTemplate

public java.lang.String getTemplate()

withScriptable

public TextSubstitution withScriptable(TextSubstitution.Scriptable script)

build

public java.lang.String build(java.lang.Object binding)

build

public java.lang.String build(java.lang.Object binding,
                              java.util.Map<java.lang.String,java.lang.Object> auxillary)

capitalize

public static java.lang.String capitalize(java.lang.String name)